Глобальные определения
Angel
Задает угол диапазона.
Тип:
- «xlDownward» | «xlHorizontal» | «xlUpward» | «xlVertical»
// Specify that the range contents will be rotated upward:
oWorksheet.GetRange("A1").SetOrientation("xlUpward");
ApiForm
Типы всех поддерживаемых форм.
Тип:
- ApiTextForm | ApiComboBoxForm | ApiCheckBoxForm | ApiPictureForm | ApiComplexForm
// Copies a text form
var oCopyTextForm = oTextForm.Copy();
AxisPos
Положение оси на графике.
Тип:
- «top» | «bottom» | «right» | «left»
// Set the axis values to the top position of the chart:
oChart.SetAxieNumFormat("top", "0.00");
BlipFillType
Тип заливки, использующей изображение в качестве фона.
- «tile» — если изображение меньше заполненной формы, изображение будет расположено по всей поверхности созданной формы.
- «stretch» — если изображение меньше заполненной формы, изображение будет растянуто, чтобы соответствовать поверхности созданной формы.
Тип:
- «tile» | «stretch»
// Create a blip fill with an image which is tiled all over the created shape:
var oFill = Api.CreateBlipFill("https://example.com/myimage.png", "tile");
bookmarkRefTo
Доступные значения типа ссылки «закладки».
- «text» — весь текст закладки.
- «pageNum» -номер страницы, на которой находится закладка.
- «paraNum» — номер абзаца, в котором находится закладка.
- «noCtxParaNum» — сокращенный номер параграфа (только конкретный пункт, например, вместо «4.1.1» вы ссылаетесь только на «1»).
- «fullCtxParaNum» — полный номер абзаца, например, «4.1.1».
- «aboveBelow» — слова «выше» или «ниже» в зависимости от положения элемента.
Тип:
- «text» | «pageNum» | «paraNum» | «noCtxParaNum» | «fullCtxParaNum» | «aboveBelow»
// Add a cross-reference to the page containing a bookmark:
oParagraph.AddBookmarkCrossRef("pageNum", sBookmark);
BordersIndex
Определяет позицию границ ячейки.
Тип:
- «DiagonalDown» | «DiagonalUp» | «Bottom» | «Left» | «Right» | «Top» | «InsideHorizontal» | «InsideVertical»
// The cell will have a bottom black dotted border:
oWorksheet.GetRange("E2").SetBorders("Bottom", "Dotted", Api.CreateColorFromRGB(0, 0, 0));
BorderType
Тип границы.
Тип:
- «none» | «single»
// The paragraph will have a single 3 point wide green bottom border with a zero offset from the bottom paragraph edge:
oParaPr.SetBottomBorder("single", 24, 0, 0, 255, 0);
BulletType
Тип маркера, который будет добавлен к абзацу электронной таблицы или презентации.
Тип:
- «None» | «ArabicPeriod» | «ArabicParenR» | «RomanUcPeriod» | «RomanLcPeriod» | «AlphaLcParenR» | «AlphaLcPeriod» | «AlphaUcParenR» | «AlphaUcPeriod»
// The paragraph will be starting with the Arabic numeral which has parenthesis:
var oBullet = Api.CreateNumbering("ArabicParenR");
byte
Числовое значение от 0 до 255.
Тип:
- численный
// The resulting color is green, the bytes are measured in decimal numbers:
var oRGBColor = Api.CreateRGBColor(0, 255, 0);
// The resulting color is green, the bytes are measured in hexadecimal numbers:
var oRGBColor = Api.CreateRGBColor(0, 0xff, 0);
CaptionLabel
Доступные подписи.
Тип:
- «Equation» | «Figure» | «Table»
// Add a cross-reference to the page containing a table caption:
oParagraph.AddCaptionCrossRef("table", "pageNum", oCaptionParagraph);
captionRefTo
Доступные значения ссылочного типа «уравнение»/»рисунок»/»таблица».
- «entireCaption» — полный текст надписи.
- «labelNumber» -только метка и номер объекта, например, «Таблица 1.1».
- «captionText» -только текст надписи.
- «pageNum» — номер страницы, содержащей указанный объект.
- «aboveBelow» -слова «выше» или «ниже» в зависимости от положения элемента.
Тип:
- «entireCaption» | «labelNumber» | «captionText» | «pageNum» | «aboveBelow»
// Add a cross-reference to the page containing a table caption:
oParagraph.AddCaptionCrossRef("table", "pageNum", oCaptionParagraph);
ChartType
Этот тип указывает доступные типы диаграмм, которые можно использовать для создания новой диаграммы.
Тип:
- «bar» | «barStacked» | «barStackedPercent» | «bar3D» | «barStacked3D» | «barStackedPercent3D» | «barStackedPercent3DPerspective» | «horizontalBar» | «horizontalBarStacked» | «horizontalBarStackedPercent» | «horizontalBar3D» | «horizontalBarStacked3D» | «horizontalBarStackedPercent3D» | «lineNormal» | «lineStacked» | «lineStackedPercent» | «line3D» | «pie» | «pie3D» | «doughnut» | «scatter» | «stock» | «area» | «areaStacked» | «areaStackedPercent»
// ChartType used in text documents
// The resulting chart will have a 'bar3D' type:
var oChart = Api.CreateChart("bar3D", [[200, 240, 280],[250, 260, 280]], ["Projected Revenue", "Estimated Costs"], [2014, 2015, 2016], 4051300, 2347595, 24);
// ChartType used in spreadsheets
// The resulting chart will have a 'bar3D' type:
var oChart = oWorksheet.AddChart("'Sheet1'!$A$1:$D$3", true, "bar3D", 2, 100 * 36000, 70 * 36000, 0, 2 * 36000, 7, 3 * 36000);
CheckBoxFormPr
Свойства формы чекбокса (флажка)
Тип:
- FormPrBase | CheckBoxFormPrBase
// Create a checkbox form with the common and specific checkbox form properties:
var oCheckBoxFormPr = {"key": "Marital status", "tip": "Specify your marital status", "required": true, "placeholder": "Marital status", "radio": true};
var oCheckBoxForm = Api.CreateCheckBoxForm(oCheckBoxFormPr);
CheckBoxFormPrBase
Специфические свойства флажка.
Тип:
- Объект
Свойства:
Название | Тип | Описание |
radio | логический | Указывает, является ли текущий флажок переключателем. В этом случае ключевой параметр рассматривается как идентификатор для группы переключателей. |
// Create a checkbox form with the specific checkbox form properties:
var oCheckBoxFormPrBase = {"radio": true};
var oCheckBoxForm = Api.CreateCheckBoxForm(oCheckBoxFormPrBase);
ComboBoxFormPr
Свойства формы комбинированного списка.
Тип:
- FormPrBase | ComboBoxFormPrBase
// Create a combo box form with the common and specific combo box form properties:
var oComboBoxFormPr = {"key": "Personal information", "tip": "Choose your country", "required": true, "placeholder": "Country", "editable": false, "autoFit": false, "items": ["Latvia", "USA", "UK"]};
var oComboBoxForm = Api.CreateComboBoxForm(oComboBoxFormPr);
ComboBoxFormPrBase
Специфические свойства формы комбинированного списка.
Тип:
- Объект
Свойства:
Название | Тип | Описание |
editable | логический | Определяет, может ли комбинированный список быть редактирован. |
autoFit | логический | Указывает, должно ли содержимое формы со списком автоматически настраиваться, т.е. должен ли размер шрифта соответствовать размеру формы фиксированного размера. |
items | Массив.<(string|Array.)> | Элементы поля со списком. Этот массив состоит из строк или массивов из двух строк, где первая строка является отображаемым значением, а вторая — его значением. Если массив состоит из отдельных строк, то отображаемое значение и его значение совпадают. Пример: [«Первый», [«Второй», «2»], [«Третий», «3»], «Четвертый»]. |
// Create a combo box form with the specific combo box form properties:
var oComboBoxFormPrBase = {"editable": false, "autoFit": false, "items": ["Latvia", "USA", "UK"]};
var oComboBoxForm = Api.CreateComboBoxForm(oComboBoxFormPrBase);
Direction
Указывает направление конца в указанном диапазоне.
Тип:
- «xlUp» | «xlDown» | «xlToRight» | «xlToLeft»
// Return a Range object that represents the left end of the specified range:
oWorksheet.GetRange("C4:D5").End("xlToLeft").SetFillColor(Api.CreateColorFromRGB(255, 224, 204))
DocumentElement
Любой допустимый элемент, который можно добавить в структуру документа.
Тип:
- ApiParagraph | ApiTable | ApiBlockLvlSdt
// Add a document element called 'paragraph' to the document:
oDocument.AddElement(oParagraph);
EMU
Английская единица измерения. 1 мм = 36000 EMU, 1 дюйм = 914400 EMU.
Тип:
- численный
// Set the size of the drawing to be created as 100 mm (10 cm) in width and 100 mm (10 cm) in height:
oDrawing.SetSize(100 * 36000, 100 * 36000);
endnoteRefTo
Доступные значения типа ссылки «концевая сноска».
- «endnoteNum» — Номер концевой сноски.
- «pageNum» — номер страницы, на которой находится сноска.
- «aboveBelow» — слова «выше» или «ниже» в зависимости от положения элемента.
- «formEndnoteNum» -номер концевой сноски, отформатированной как концевая сноска. Нумерация фактических концевых сносок не изменяется.
Тип:
- «endnoteNum» | «pageNum» | «aboveBelow» | «formEndnoteNum»
// Add a cross-reference to the page containing an endnote:
oParagraph.AddEndnoteCrossRef("pageNum", oEndnoteParagraph);
footnoteRefTo
Доступные значения типа ссылки «сноска».
- «footnoteNum» — номер сноски.
- «pageNum» — номер страницы, на которой находится сноска.
- «aboveBelow» — слова «выше» или «ниже» в зависимости от положения элемента.
- «formFootnoteNum» — номер сноски, отформатированной как сноска. Нумерация фактических сносок не изменяется.
Тип:
- «footnoteNum» | «pageNum» | «aboveBelow» | «formFootnoteNum»
// Add a cross-reference to the page containing a footnote:
oParagraph.AddFootnoteCrossRef("pageNum", oFootnoteParagraph);
FormPrBase
Common form properties.
Тп:
- Объект
Свойства:
Название | Тип | Описание |
key | строковый | Ключ формы. |
tip | строковый | Текст подсказки формы. |
required | логический | Указывает, является ли форма обязательной или нет.. |
placeholder | строковый | Текст плейсхолдера формы. |
// Create a text form with the common form properties:
var oFormPrBase = {"key": "Personal information", "tip": "Enter your first name", "required": true, "placeholder": "First name"};
var oTextForm = Api.CreateTextForm(oFormPrBase);
FormType
Тип формы. Доступные типы форм.
Тип:
- «textForm» | «comboBoxForm» | «dropDownForm» | «checkBoxForm» | «radioButtonForm» | «pictureForm»
// Return a type of the current form:
var sFormType = oTextForm.GetFormType();
HdrFtrType
Типы верхнего и нижнего колонтитула, которые можно применять к разделам документа.
- «default» — верхний или нижний колонтитул, который можно применить к любой странице по умолчанию.
- «title» -верхний или нижний колонтитул, который применяется к титульному листу.
- «even» — верхний или нижний колонтитул, который можно применить к четным страницам, чтобы отличить их от нечетных (которые будут считаться значениями по умолчанию).
Тип:
- «default» | «title» | «even»
// Remove the header of the 'title' type from the final document section:
var oDocContent = oFinalSection.RemoveHeader("title");
headingRefTo
Доступные значения ссылочного типа «заголовок».
- «text» — весь текст заголовка.
- «pageNum» — номер страницы, на которой расположен заголовок.
- «headingNum» — порядковый номер заголовка.
- «noCtxHeadingNum» — сокращенный номер заголовка. Убедитесь, что курсор находится в разделе, на который вы ссылаетесь, например, вы находитесь в разделе 4 и хотите обратиться к заголовку 4.B, поэтому вместо «4.B» вы получите только «B».
«fullCtxHeadingNum» — полный номер заголовка, даже если точка курсора находится в том же разделе. - «aboveBelow» — слова «выше» или «ниже» в зависимости от положения элемента.
Тип:
- «text» | «pageNum» | «headingNum» | «noCtxHeadingNum» | «fullCtxHeadingNum» | «aboveBelow»
// Add a cross-reference to the page containing a heading:
oParagraph.AddHeadingCrossRef("pageNum", oHeadingParagraph);
highlightColor
Доступные цвета для подсветки.
Тип:
- «black» | «blue» | «cyan» | «green» | «magenta» | «red» | «yellow» | «white» | «darkBlue» | «darkCyan» | «darkGreen» | «darkMagenta» | «darkRed» | «darkYellow» | «darkGray» | «lightGray» | «none»
// Highlight a paragraph in green:
oParagraph.SetHighlight("green");
hps
Половина точки (2 полоуточка = 1 точка).
Тип:
- Численный
// Set the text font size to 22 half-points:
oTextPr.SetFontSize(22);
line240
240 сотых линии.
Тип:
- Численный
// The paragraph line spacing is set to 1 line:
oParaPr.SetSpacingLine(240, "auto");
LineStyle
Указывает стиль линии, используемый для формирования границы ячейки.
Тип:
- «None» | «Double» | «Hair» | «DashDotDot» | «DashDot» | «Dotted» | «Dashed» | «Thin» | «MediumDashDotDot» | «SlantDashDot» | «MediumDashDot» | «MediumDashed» | «Medium» | «Thick»
// The cell will have a bottom black dotted border:
oWorksheet.GetRange("E2").SetBorders("Bottom", "Dotted", Api.CreateColorFromRGB(0, 0, 0));
mm
1 миллиметр равен 1/10 сантиметра.
Тип:
- Численный
// Set the cell width measured in millimeters to the applied comb of characters:
oTextForm.SetCellWidth(7);
numberedRefTo
Доступные значения ссылочного типа «нумерованный».
- «pageNum» — номер страницы нумерованного элемента.
- «paraNum» — номер абзаца пронумерованного элемента.
- «noCtxParaNum» — сокращенный номер абзаца (только конкретный пункт нумерованного списка, например, вместо «4.1.1» вы ссылаетесь только на «1»).
- «fullCtxParaNum» — полный номер абзаца, например, «4.1.1»
- «text» — текстовое значение параграфа, например, если у вас есть «4.1.1. Положения и условия», вы ссылаетесь только на «Положения и условия».
- «aboveBelow» — слова «выше» или «ниже» в зависимости от положения элемента.
Тип:
- «pageNum» | «paraNum» | «noCtxParaNum» | «fullCtxParaNum» | «text» | «aboveBelow»
// Add a cross-reference to the page containing a numbered paragraph:
oParagraph.AddNumberedCrossRef("pageNum", oNumberedParagraph, true, true);
NumFormat
Стандартный числовой формат.
Тип:
- «General» | «0» | «0.00» | «#,##0» | «#,##0.00» | «0%» | «0.00%» | «0.00E+00» | «# ?/?» | «# ??/??» | «m/d/yyyy» | «d-mmm-yy» | «d-mmm» | «mmm-yy» | «h:mm AM/PM» | «h:mm:ss AM/PM» | «h:mm» | «h:mm:ss» | «m/d/yyyy h:mm» | «#,##0_);(#,##0)» | «#,##0_);[Red](#,##0)» | «#,##0.00_);(#,##0.00)» | «#,##0.00_);[Red](#,##0.00)» | «mm:ss» | «[h]:mm:ss» | «mm:ss.0» | «##0.0E+0» | «@»
// Set the "0.00" numeric format to the chart data point:
oChart.SetDataPointNumFormat("0.00", 0, 1, true);
PageOrientation
Тип ориетации страницы.
Тип:
- «xlLandscape» | «xlPortrait»
// Set the page orientation to portrait:
oWorksheet.SetPageOrientation("xlPortrait");
ParagraphContent
Типы элементов, которые можно добавить в структуру абзаца.
Тип:
- ApiUnsupported | ApiRun | ApiInlineLvlSdt | ApiHyperlink | ApiFormBase
// Add an element called 'text run' to the paragraph:
oParagraph.AddElement(oRun,0);
PatternType
Доступные предустановленные шаблоны, которые можно использовать для заливки.
Тип:
- «cross» | «dashDnDiag» | «dashHorz» | «dashUpDiag» | «dashVert» | «diagBrick» | «diagCross» | «divot» | «dkDnDiag» | «dkHorz» | «dkUpDiag» | «dkVert» | «dnDiag» | «dotDmnd» | «dotGrid» | «horz» | «horzBrick» | «lgCheck» | «lgConfetti» | «lgGrid» | «ltDnDiag» | «ltHorz» | «ltUpDiag» | «ltVert» | «narHorz» | «narVert» | «openDmnd» | «pct10» | «pct20» | «pct25» | «pct30» | «pct40» | «pct5» | «pct50» | «pct60» | «pct70» | «pct75» | «pct80» | «pct90» | «plaid» | «shingle» | «smCheck» | «smConfetti» | «smGrid» | «solidDmnd» | «sphere» | «trellis» | «upDiag» | «vert» | «wave» | «wdDnDiag» | «wdUpDiag» | «weave» | «zigZag»
// Create a fill with a 'dashDnDiag' pattern which has two colors - green and red:
var oFill = Api.CreatePatternFill("dashDnDiag", Api.CreateRGBColor(0, 225, 0), Api.CreateRGBColor(255, 0, 0))
percentage
Значение от 0 до 100.
Тип:
- численный
// Set the picture position measured in percent inside the current form:
oPictureForm.SetPicturePosition(70, 70);
PictureFormPr
Свойства формы изображения.
Тип:
- FormPrBase | PictureFormPrBase
// Create a picture form with the common and specific picture form properties:
var oPictureFormPr = {"key": "Personal information", "tip": "Upload your photo", "required": true, "placeholder": "Photo", "scaleFlag": "tooBig", "lockAspectRatio": true, "respectBorders": false, "shiftX": 50, "shiftY": 50};
var oPictureForm = Api.CreatePictureForm(oPictureFormPr);
PictureFormPrBase
Специфические свойства формы изображения.
Тип:
- Объект
Свойства:
Название | Тип | Описание |
scaleFlag | ScaleFlag | Условие масштабирования изображения в форме рисунка: «всегда», «никогда», «tooBig» или «tooSmall». |
lockAspectRatio | логический | Указывает, заблокировано или нет соотношение сторон формы изображения. |
respectBorders | логический | Определяет, соблюдается или нет ширина границ формы при масштабировании изображения. |
shiftX | процентный | Положение изображения по горизонтали внутри формы изображения, измеряемое в процентах:
|
shiftY | процентный | Положение изображения по вертикали внутри формы изображения, измеряемое в процентах:
|
// Create a picture form with the specific picture form properties:
var oPictureFormPrBase = {"scaleFlag": "tooBig", "lockAspectRatio": true, "respectBorders": false, "shiftX": 50, "shiftY": 50};
var oPictureForm = Api.CreatePictureForm(oPictureFormPrBase);
PositiveFixedAngle
60000 градусов (5400000 = 90 градусов).
Тип:
- численный
// The resulting gradient direction angle is 90 degrees:
var oFill = Api.CreateLinearGradientFill([oGs1, oGs2], 5400000);
PositivePercentage
Тысячная доля процента (100000 = 100%).
Тип:
- Численный
// The resulting gradient stop position is 100%:
var oGs2 = Api.CreateGradientStop(Api.CreateRGBColor(255, 164, 101), 100000);
PresetColor
Доступные названия предустановленных цветов.
Тип:
- «aliceBlue» | «antiqueWhite» | «aqua» | «aquamarine» | «azure» | «beige» | «bisque» | «black» | «blanchedAlmond» | «blue» | «blueViolet» | «brown» | «burlyWood» | «cadetBlue» | «chartreuse» | «chocolate» | «coral» | «cornflowerBlue» | «cornsilk» | «crimson» | «cyan» | «darkBlue» | «darkCyan» | «darkGoldenrod» | «darkGray» | «darkGreen» | «darkGrey» | «darkKhaki» | «darkMagenta» | «darkOliveGreen» | «darkOrange» | «darkOrchid» | «darkRed» | «darkSalmon» | «darkSeaGreen» | «darkSlateBlue» | «darkSlateGray» | «darkSlateGrey» | «darkTurquoise» | «darkViolet» | «deepPink» | «deepSkyBlue» | «dimGray» | «dimGrey» | «dkBlue» | «dkCyan» | «dkGoldenrod» | «dkGray» | «dkGreen» | «dkGrey» | «dkKhaki» | «dkMagenta» | «dkOliveGreen» | «dkOrange» | «dkOrchid» | «dkRed» | «dkSalmon» | «dkSeaGreen» | «dkSlateBlue» | «dkSlateGray» | «dkSlateGrey» | «dkTurquoise» | «dkViolet» | «dodgerBlue» | «firebrick» | «floralWhite» | «forestGreen» | «fuchsia» | «gainsboro» | «ghostWhite» | «gold» | «goldenrod» | «gray» | «green» | «greenYellow» | «grey» | «honeydew» | «hotPink» | «indianRed» | «indigo» | «ivory» | «khaki» | «lavender» | «lavenderBlush» | «lawnGreen» | «lemonChiffon» | «lightBlue» | «lightCoral» | «lightCyan» | «lightGoldenrodYellow» | «lightGray» | «lightGreen» | «lightGrey» | «lightPink» | «lightSalmon» | «lightSeaGreen» | «lightSkyBlue» | «lightSlateGray» | «lightSlateGrey» | «lightSteelBlue» | «lightYellow» | «lime» | «limeGreen» | «linen» | «ltBlue» | «ltCoral» | «ltCyan» | «ltGoldenrodYellow» | «ltGray» | «ltGreen» | «ltGrey» | «ltPink» | «ltSalmon» | «ltSeaGreen» | «ltSkyBlue» | «ltSlateGray» | «ltSlateGrey» | «ltSteelBlue» | «ltYellow» | «magenta» | «maroon» | «medAquamarine» | «medBlue» | «mediumAquamarine» | «mediumBlue» | «mediumOrchid» | «mediumPurple» | «mediumSeaGreen» | «mediumSlateBlue» | «mediumSpringGreen» | «mediumTurquoise» | «mediumVioletRed» | «medOrchid» | «medPurple» | «medSeaGreen» | «medSlateBlue» | «medSpringGreen» | «medTurquoise» | «medVioletRed» | «midnightBlue» | «mintCream» | «mistyRose» | «moccasin» | «navajoWhite» | «navy» | «oldLace» | «olive» | «oliveDrab» | «orange» | «orangeRed» | «orchid» | «paleGoldenrod» | «paleGreen» | «paleTurquoise» | «paleVioletRed» | «papayaWhip» | «peachPuff» | «peru» | «pink» | «plum» | «powderBlue» | «purple» | «red» | «rosyBrown» | «royalBlue» | «saddleBrown» | «salmon» | «sandyBrown» | «seaGreen» | «seaShell» | «sienna» | «silver» | «skyBlue» | «slateBlue» | «slateGray» | «slateGrey» | «snow» | «springGreen» | «steelBlue» | «tan» | «teal» | «thistle» | «tomato» | «turquoise» | «violet» | «wheat» | «white» | «whiteSmoke» | «yellow» | «yellowGreen»
// Create a scheme color using the 'lightYellow' color preset:
var oSchemeColor = Api.CreatePresetColor("lightYellow");
pt
Пункт.
Type:
- численный
// The paragraph will have a single 3 point wide green bottom border with a 1 point offset from the bottom paragraph edge:
oParaPr.SetBottomBorder("single", 24, 1, 0, 255, 0);
pt_8
Восьмых балла (24 восьмых балла = 3 балла).
Тип:
- численный
// The paragraph will have a single 6 point wide green bottom border with a zero offset from the bottom paragraph edge:
oParaPr.SetBottomBorder("single", 48, 0, 0, 255, 0);
RelFromH
Возможные значения для базы, на основе которых будет рассчитываться относительное горизонтальное расположение объекта.
Тип:
- «character» | «column» | «leftMargin» | «rightMargin» | «margin» | «page»
// The created drawing will be centered horizontally relative to the page width:
oDrawing.SetHorAlign("page", "center");
RelFromV
Возможные значения для базы, на основе которых будет рассчитываться относительное вертикальное расположение объекта.
Тип:
- «bottomMargin» | «topMargin» | «margin» | «page» | «line» | «paragraph»
// The created drawing will be centered vertically relative to the page height:
oDrawing.SetVerAlign("page", "center");
ScaleFlag
Условие для масштабирования изображения в форме изображения.
Тип:
- «always» | «never» | «tooBig» | «tooSmall»
// Set the scaling condition when the current picture form is scaled if it is too big:
oPictureForm.SetScaleFlag("tooBig");
SchemeColorId
Доступные идентификаторы цветовой схемы.
Тип:
- «accent1» | «accent2» | «accent3» | «accent4» | «accent5» | «accent6» | «bg1» | «bg2» | «dk1» | «dk2» | «lt1» | «lt2» | «tx1» | «tx2»
// Create a scheme color with the 'accent2' identifier:
var oSchemeColor = Api.CreateSchemeColor("accent2");
SdtLock
Тип блокировки элемента управления содержимым.
Тип:
- «unlocked» | «contentLocked» | «sdtContentLocked» | «sdtLocked»
// Set the "sdtContentLocked" lock to the current inline text content control which means that the content cannot be edited and the container cannot be deleted:
oInlineLvlSdt.SetLock("sdtContentLocked");
ShapeType
Этот тип определяет заданную геометрию формы, которая будет использоваться для фигуры.
Тип:
- «accentBorderCallout1» | «accentBorderCallout2» | «accentBorderCallout3» | «accentCallout1» | «accentCallout2» | «accentCallout3» | «actionButtonBackPrevious» | «actionButtonBeginning» | «actionButtonBlank» | «actionButtonDocument» | «actionButtonEnd» | «actionButtonForwardNext» | «actionButtonHelp» | «actionButtonHome» | «actionButtonInformation» | «actionButtonMovie» | «actionButtonReturn» | «actionButtonSound» | «arc» | «bentArrow» | «bentConnector2» | «bentConnector3» | «bentConnector4» | «bentConnector5» | «bentUpArrow» | «bevel» | «blockArc» | «borderCallout1» | «borderCallout2» | «borderCallout3» | «bracePair» | «bracketPair» | «callout1» | «callout2» | «callout3» | «can» | «chartPlus» | «chartStar» | «chartX» | «chevron» | «chord» | «circularArrow» | «cloud» | «cloudCallout» | «corner» | «cornerTabs» | «cube» | «curvedConnector2» | «curvedConnector3» | «curvedConnector4» | «curvedConnector5» | «curvedDownArrow» | «curvedLeftArrow» | «curvedRightArrow» | «curvedUpArrow» | «decagon» | «diagStripe» | «diamond» | «dodecagon» | «donut» | «doubleWave» | «downArrow» | «downArrowCallout» | «ellipse» | «ellipseRibbon» | «ellipseRibbon2» | «flowChartAlternateProcess» | «flowChartCollate» | «flowChartConnector» | «flowChartDecision» | «flowChartDelay» | «flowChartDisplay» | «flowChartDocument» | «flowChartExtract» | «flowChartInputOutput» | «flowChartInternalStorage» | «flowChartMagneticDisk» | «flowChartMagneticDrum» | «flowChartMagneticTape» | «flowChartManualInput» | «flowChartManualOperation» | «flowChartMerge» | «flowChartMultidocument» | «flowChartOfflineStorage» | «flowChartOffpageConnector» | «flowChartOnlineStorage» | «flowChartOr» | «flowChartPredefinedProcess» | «flowChartPreparation» | «flowChartProcess» | «flowChartPunchedCard» | «flowChartPunchedTape» | «flowChartSort» | «flowChartSummingJunction» | «flowChartTerminator» | «foldedCorner» | «frame» | «funnel» | «gear6» | «gear9» | «halfFrame» | «heart» | «heptagon» | «hexagon» | «homePlate» | «horizontalScroll» | «irregularSeal1» | «irregularSeal2» | «leftArrow» | «leftArrowCallout» | «leftBrace» | «leftBracket» | «leftCircularArrow» | «leftRightArrow» | «leftRightArrowCallout» | «leftRightCircularArrow» | «leftRightRibbon» | «leftRightUpArrow» | «leftUpArrow» | «lightningBolt» | «line» | «lineInv» | «mathDivide» | «mathEqual» | «mathMinus» | «mathMultiply» | «mathNotEqual» | «mathPlus» | «moon» | «nonIsoscelesTrapezoid» | «noSmoking» | «notchedRightArrow» | «octagon» | «parallelogram» | «pentagon» | «pie» | «pieWedge» | «plaque» | «plaqueTabs» | «plus» | «quadArrow» | «quadArrowCallout» | «rect» | «ribbon» | «ribbon2» | «rightArrow» | «rightArrowCallout» | «rightBrace» | «rightBracket» | «round1Rect» | «round2DiagRect» | «round2SameRect» | «roundRect» | «rtTriangle» | «smileyFace» | «snip1Rect» | «snip2DiagRect» | «snip2SameRect» | «snipRoundRect» | «squareTabs» | «star10» | «star12» | «star16» | «star24» | «star32» | «star4» | «star5» | «star6» | «star7» | «star8» | «straightConnector1» | «stripedRightArrow» | «sun» | «swooshArrow» | «teardrop» | «trapezoid» | «triangle» | «upArrowCallout» | «upDownArrow» | «upDownArrow» | «upDownArrowCallout» | «uturnArrow» | «verticalScroll» | «wave» | «wedgeEllipseCallout» | «wedgeRectCallout» | «wedgeRoundRectCallout»
// Create a shape using the 'diamond' preset:
var oDrawing = Api.CreateShape("diamond", 100 * 36000, 100 * 36000, oFill, oStroke);
ShdType
Тип оттенка, который может быть добавлен к элементу документа.
Тип:
- «nil» | «clear»
// Add a green shadow to the table:
oTablePr.SetShd("clear", 0, 255, 0, false);
SortHeader
Указывает, содержит ли первая строка диапазона сортировки сведения о заголовке.
Тип:
- «xlNo» | «xlYes»
// Specify that the first row contains header information:
oWorksheet.GetRange("A1:C5").SetSort("A1:A5", "xlAscending", "B1:B5", "xlDescending", "C1:C5", "xlAscending", "xlYes", "xlSortColumns")
SortOrder
Задает порядок сортировки.
Тип:
- «xlAscending» | «xlDescending»
// Specify that the sort order for the values specified in "A1:A5" is ascending:
oWorksheet.GetRange("A1:C5").SetSort("A1:A5", "xlAscending", "B1:B5", "xlDescending", "C1:C5", "xlAscending", "xlYes", "xlSortColumns");
SortOrientation
Указывает, должна ли сортировка выполняться по строке или по столбцу.
Тип:
- «xlSortColumns» | «xlSortRows»
// Specify that the sort should be by column:
oWorksheet.GetRange("A1:C5").SetSort("A1:A5", "xlAscending", "B1:B5", "xlDescending", "C1:C5", "xlAscending", "xlYes", "xlSortColumns");
StyleType
Тип стиля, используемый для элемента документа.
Тип:
- «абзац» | «таблица» | «запуск» | «нумерация»
// Assign the default document paragraph style to the 'oNormalStyle' variable:
var oNormalStyle = oDocument.GetDefaultStyle("paragraph");
TabJc
Типы пользовательской вкладки.
Тип:
- «очистить» | «влево» | «вправо» | «по центру»
// Set tab positions at 50, 75 and 150 points with the text aligned center, left and right at each tab stop accordingly:
oParaPr.SetTabs([1000, 1500, 3000], ["center", "left", "right"]);
TableStyleOverrideType
Этот простой тип указывает возможные значения для разделов таблицы, к которым будут применяться текущие свойства условного форматирования при использовании этого выбранного стиля таблицы.
- «topLeftCell» — указывает, что форматирование таблицы применяется к верхней левой ячейке.
- «topRightCell» -указывает, что форматирование таблицы применяется к верхней правой ячейке.
- «bottomLeftCell» — указывает, что форматирование таблицы применяется к нижней левой ячейке.
- «bottomRightCell» — указывает, что форматирование таблицы применяется к нижней правой ячейке.
- «firstRow» — указывает, что форматирование таблицы применяется к первой строке.
- «lastRow» — указывает, что форматирование таблицы применяется к последней строке.
- «firstColumn» — указывает, что форматирование таблицы применяется к первому столбцу. Любая последующая строка в заголовке таблицы ( ApiTableRowPr.SetTableHeader ) также будет использовать этот условный формат.
- «lastColumn» -указывает, что форматирование таблицы применяется к последнему столбцу.
- «bandedColumn» — указывает, что форматирование таблицы применяется к группам строк с нечетными номерами.
- «bandedColumnEven» — указывает, что форматирование таблицы применяется к четным группам строк.
- «bandedRow» — auto_awesome указывает, что форматирование таблицы применяется к группам столбцов с нечетными номерами.
- «bandedRowEven» — указывает, что форматирование таблицы применяется к четным группам столбцов.
- «wholeTable» — указывает, что условное форматирование применяется ко всей таблице.
Тип:
- «topLeftCell» | «topRightCell» | «bottomLeftCell» | «bottomRightCell» | «firstRow» | «lastRow» | «firstColumn» | «lastColumn» | «bandedColumn» | «bandedColumnEven» | «bandedRow» | «bandedRowEven» | «wholeTable»
// Apply the created style (set shadow) to the top left cell of the table:
oTableStyle.GetConditionalTableStyle("topLeftCell").GetTableCellPr().SetShd("clear", 255, 0, 0)
TableWidth
Возможные значения для единиц измерения свойства width определяются конкретной таблицей или свойством ширины ячейки таблицы.
- «auto» — устанавливает ширину таблицы или ячейки таблицы в значение auto width.
- «twips» — задает ширину таблицы или ячейки таблицы, измеряемую в двадцатых долях пункта.
- «nul» — устанавливает нулевое значение ширины таблицы или ячейки таблицы.
- «percent» -задает ширину таблицы или ячейки таблицы, измеряемую в процентах относительно родительского контейнера.
Тип:
- «auto» | «twips» | «nul» | «percent»
// Set the width of the table cell equal to 100 points (2000 twips):
oTableCell.SetWidth("twips", 2000);
TextFormPr
Свойства текстовой формы.
Тип:
- FormPrBase | TextFormPrBase
// Create a text form with the common and specific text form properties:
var oTextFormPr = {"key": "Personal information", "tip": "Enter your first name", "required": true, "placeholder": "First name", "comb": true, "maxCharacters": 10, "cellWidth": 3, "multiLine": false, "autoFit": false};
var oTextForm = Api.CreateTextForm(oTextFormPr);
TextFormPrBase
Специфические свойства текстовой формы.
Тип:
- Объект
Свойства:
Название | Тип | Описание |
comb | логический | Указывает, должна ли текстовая форма представлять собой комбинацию символов с одинаковой шириной ячейки. Максимальное количество символов должно быть установлено на положительное значение. |
maxCharacters | численный | Максимальное количество символов в текстовой форме. |
cellWidth | численный | Ширина ячейки для каждого символа измеряется в миллиметрах. Если этот параметр не указан или равен 0 или меньше, то ширина будет установлена автоматически. |
multiLine | логический | Указывает, является ли текущая текстовая форма фиксированного размера многострочной или нет. |
autoFit | логический | Указывает, должно ли содержимое текстовой формы автоматически настраиваться, т.е. соответствует ли размер шрифта размеру формы фиксированного размера. |
// Create a text form with the specific text form properties:
var oTextFormPrBase = {"comb": true, "maxCharacters": 10, "cellWidth": 3, "multiLine": false, "autoFit": false};
var oTextForm = Api.CreateTextForm(oTextFormPrBase);
TextTransform
Тип преобразования текста.
Тип:
- «textArchDown» | «textArchDownPour» | «textArchUp» | «textArchUpPour» | «textButton» | «textButtonPour» | «textCanDown» | «textCanUp» | «textCascadeDown» | «textCascadeUp» | «textChevron» | «textChevronInverted» | «textCircle» | «textCirclePour» | «textCurveDown» | «textCurveUp» | «textDeflate» | «textDeflateBottom» | «textDeflateInflate» | «textDeflateInflateDeflate» | «textDeflateTop» | «textDoubleWave1» | «textFadeDown» | «textFadeLeft» | «textFadeRight» | «textFadeUp» | «textInflate» | «textInflateBottom» | «textInflateTop» | «textPlain» | «textRingInside» | «textRingOutside» | «textSlantDown» | «textSlantUp» | «textStop» | «textTriangle» | «textTriangleInverted» | «textWave1» | «textWave2» | «textWave4» | «textNoShape»
// Create a Text Art object with the "textArchUp" text transform type:
var oTextArt = Api.CreateWordArt(oTextPr, "r7", "textArchUp", oFill, oStroke, 0, 150 * 36000, 50 * 36000)
TickLabelPosition
Возможные значения положения меток делений на графике (горизонтальное или вертикальное).
- «none» — не отображает выбранные галочки.
- «nextTo»- устанавливает положение выбранных галочек рядом с основной меткой.
- «low» — задает положение выбранных галочек в части графика с меньшими значениями.
- «high» — задает положение выбранных галочек в части графика с более высокими значениями.
Тип:
- «none» | «nextTo» | «low» | «high»
// Set the position of the vertical tick labels next to the main vertical label:
oChart.SetVertAxisTickLabelPosition("nextTo");
TickMark
Тип внешнего вида деления.
Тип:
- «cross» | «in» | «none» | «out»
// Specify the "cross" major tick mark type for the vertical axis:
oChart.SetVertAxisMajorTickMark("cross");
TocBuildFromPr
Свойства оглавления, которые определяют, следует ли создавать оглавление на основе уровней структуры или указанных стилей.
Тип:
- Object
Свойства:
Наименование | Тип | Описание |
OutlineLvls | number | Максимальное количество уровней в оглавлении. |
StylesLvls | Array. | Стили уровней (пример, [{Name: «Heading 1», Lvl: 2}, {Name: «Heading 2», Lvl: 3}]).If StylesLvls.length > 0, then the OutlineLvls |
Пример
// Добавьте в документ оглавление, созданное на основе 9 уровней структуры:var oTocBuildFromPr = {"OutlineLvls": 9};
var oTocPr = {"ShowPageNums": true, "RightAlgn": true, "LeaderType": "dot", "FormatAsLinks": true, "BuildFrom": oTocBuildFromPr, "TocStyle": "standard"};
oDocument.AddTableOfContents(oTocPr);
TocLeader
Возможные значения для оглавления:
- «dot» — «…….»
- «dash» — «——-«
- «underline» — «_______»
Типы:
- «dot» | «dash» | «underline» | «none»
Пример
// Добавьте в документ оглавление с точкой-лидером.:
var sTocLeader = "dot";
var oTocPr = {"ShowPageNums": true, "RightAlgn": true, "LeaderType": sTocLeader, "FormatAsLinks": true, "BuildFrom": {"OutlineLvls": 9}, "TocStyle": "standard"};
oDocument.AddTableOfContents(oTocPr);
TocPr
Свойства оглавления.
Тип:
- Object
Свойства:
Наименование | Тип | Описание |
ShowPageNums | boolean | Указывает, отображать ли номера страниц в оглавлении. |
RightAlgn | boolean | Указывает, выравнивать ли номера страниц по правому краю в оглавлении. |
LeaderType | TocLeader | Тип главного заголовка в оглавлении. |
FormatAsLinks | boolean | Указывает, форматировать ли оглавление как ссылки. |
BuildFrom | TocBuildFromPr | Указывает, следует ли создавать оглавление на основе уровней структуры или указанных стилей. |
TocStyle | TocStyle | Тип стиля оглавления. |
Пример
// Добавить в документ оглавление с указанными свойствами:
var oTocPr = {"ShowPageNums": true, "RightAlgn": true, "LeaderType": "dot", "FormatAsLinks": true, "BuildFrom": {"OutlineLvls": 9}, "TocStyle": "standard"};
oDocument.AddTableOfContents(oTocPr);
TocStyle
Возможные значения стиля оглавления.
Тип:
- «simple» | «online» | «standard» | «modern» | «classic»
Пример
// Добавляем в документ оглавление стандартного стиля:
var sTocStyle = "standard";
var oTocPr = {"ShowPageNums": true, "RightAlgn": true, "LeaderType": "dot", "FormatAsLinks": true, "BuildFrom": {"OutlineLvls": 9}, "TocStyle": sTocStyle};
oDocument.AddTableOfContents(oTocPr);
TocStyleLvl
Уровни стиля оглавления.
Тип:
- Object
Свойства:
Наименование | Тип | описание |
Name | string | Имя стиля (пример, «Heading 1»). |
Lvl | number | Уровень, который будет применен к указанному стилю в оглавлении. |
Пример
// Добавить в документ оглавление, созданное на основе указанных стилей:
var aTocStyleLvl = [{Name: "Heading 1", Lvl: 2}, {Name: "Heading 2", Lvl: 3}];
var oTocPr = {"ShowPageNums": true, "RightAlgn": true, "LeaderType": "dot", "FormatAsLinks": true, "BuildFrom": {"StylesLvls": aTocStyleLvl}, "TocStyle": "standard"};
oDocument.AddTableOfContents(oTocPr);
TofPr
Таблица свойств фигур.
Тип:
- Object
Свойства:
Наименование | Тип | Описание |
ShowPageNums | boolean | Указывает, отображать ли номера страниц в таблице рисунков. |
RightAlgn | boolean | Указывает, выравнивать ли номера страниц по правому краю в таблице рисунков. |
LeaderType | TocLeader | Тип лидера в таблице цифр. |
FormatAsLinks | boolean | Указывает, форматировать ли таблицу цифр как ссылки. |
BuildFrom | CaptionLabel | string | Указывает, следует ли создавать таблицу рисунков на основе указанной метки заголовка или используемого имени стиля абзаца (например,, «Heading 1»). |
LabelNumber | boolean | Указывает, включать ли метку и номер в таблицу рисунков. |
TofStyle | TofStyle | Таблица типов стилей фигур. |
Пример
// Добавьте в документ таблицу фигур с указанными свойствами:
var oTofPr = {"ShowPageNums": true, "RightAlgn": true, "LeaderType": "dot", "FormatAsLinks": true, "BuildFrom": "Figure", "LabelNumber": true, "TofStyle": "distinctive"};
oDocument.AddTableOfFigures(oTofPr);
TofStyle
Возможные значения стиля таблицы рисунков.
Тип:
- «simple» | «online» | «classic» | «distinctive» | «centered» | «formal»
Пример
// Добавить в документ таблицу рисунков фирменного стиля:
var sTofStyle = "distinctive";
var oTofPr = {"ShowPageNums": true, "RightAlgn": true, "LeaderType": "dot", "FormatAsLinks": true, "BuildFrom": "Figure", "LabelNumber": true, "TofStyle": sTofStyle};
oDocument.AddTableOfFigures(oTofPr);
twips
Двадцатые доли пункта (эквивалентно 1/1440 дюйма).
Тип:
- численный
// Set the distance between columns equal to 36 points:
oParagraph.SetEqualColumns(2, 720);
VerticalTextAlign
Доступное вертикальное выравнивание текста (используется для выравнивания текста в фигуре с размещением текста внутри нее).
Тип:
- «top» | «center» | «bottom»
// The inner text for the created shape will be added aligned vertically closer to the shape upper part:
oDrawing.SetVerticalTextAlign("top");