Задает угол диапазона.

Пример

// Specify that the range contents will be rotated upward:
oWorksheet.GetRange("A1").SetOrientation("xlUpward");
ApiForm

Типы всех поддерживаемых форм.

Пример

// Copies a text form
var oCopyTextForm = oTextForm.Copy();

AxisPos

Положение оси на графике.

Пример

// Set the axis values to the top position of the chart:
oChart.SetAxieNumFormat("top", "0.00");
BlipFillType

Тип заливки, использующей изображение в качестве фона.

• «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» — слова «выше» или «ниже» в зависимости от положения элемента.

Пример

// Add a cross-reference to the page containing a bookmark:
oParagraph.AddBookmarkCrossRef("pageNum", sBookmark);
BordersIndex

Определяет позицию границ ячейки.

Пример

// The cell will have a bottom black dotted border:
oWorksheet.GetRange("E2").SetBorders("Bottom", "Dotted", Api.CreateColorFromRGB(0, 0, 0));

BorderType

Тип границы.

Пример

// 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

Тип маркера, который будет добавлен к абзацу электронной таблицы или презентации.

Пример

// 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

Доступные подписи.

Пример

// Add a cross-reference to the page containing a table caption:
oParagraph.AddCaptionCrossRef("table", "pageNum", oCaptionParagraph);

captionRefTo

Доступные значения ссылочного типа «уравнение»/»рисунок»/»таблица».

• «entireCaption» — полный текст надписи.
• «labelNumber» -только метка и номер объекта, например, «Таблица 1.1».
• «captionText» -только текст надписи.
• «pageNum» — номер страницы, содержащей указанный объект.
• «aboveBelow» -слова «выше» или «ниже» в зависимости от положения элемента.

Пример

// Add a cross-reference to the page containing a table caption:
oParagraph.AddCaptionCrossRef("table", "pageNum", oCaptionParagraph); 

ChartType

Этот тип указывает доступные типы диаграмм, которые можно использовать для создания новой диаграммы.

Пример

// 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

Свойства формы чекбокса(флажка)

Пример

// 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

Специфические свойства флажка.

Пример

// Create a checkbox form with the specific checkbox form properties:
var oCheckBoxFormPrBase = {"radio": true};
var oCheckBoxForm = Api.CreateCheckBoxForm(oCheckBoxFormPrBase);

ComboBoxFormPr

Свойства формы комбинированного списка.

Пример

// 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

Специфические свойства формы комбинированного списка.

Пример

// 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

Указывает направление конца в указанном диапазоне.

Пример

// 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

Любой допустимый элемент, который можно добавить в структуру документа.

Пример

// 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» -номер концевой сноски, отформатированной как концевая сноска. Нумерация фактических концевых сносок не изменяется.

Пример

// Add a cross-reference to the page containing an endnote:
oParagraph.AddEndnoteCrossRef("pageNum", oEndnoteParagraph); 

footnoteRefTo

Доступные значения типа ссылки «сноска».

• «footnoteNum» — номер сноски.
• «pageNum» — номер страницы, на которой находится сноска.
• «aboveBelow» — слова «выше» или «ниже» в зависимости от положения элемента.
• «formFootnoteNum» — номер сноски, отформатированной как сноска. Нумерация фактических сносок не изменяется.

Пример

// Add a cross-reference to the page containing a footnote:
oParagraph.AddFootnoteCrossRef("pageNum", oFootnoteParagraph); 

FormPrBase

Common form properties.

Пример

// 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

Тип формы. Доступные типы форм.

Пример

// Return a type of the current form:
var sFormType = oTextForm.GetFormType();

HdrFtrType

Типы верхнего и нижнего колонтитула, которые можно применять к разделам документа.

• «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» — слова «выше» или «ниже» в зависимости от положения элемента.

Пример

// Add a cross-reference to the page containing a heading:
oParagraph.AddHeadingCrossRef("pageNum", oHeadingParagraph); 

highlightColor

Доступные цвета для подсветки.

Пример

// 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

Указывает стиль линии, используемый для формирования границы ячейки.

Пример

// 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» — слова «выше» или «ниже» в зависимости от положения элемента.

Пример

// Add a cross-reference to the page containing a numbered paragraph:
oParagraph.AddNumberedCrossRef("pageNum", oNumberedParagraph, true, true);

NumFormat

Стандартный числовой формат.

Пример

// Set the "0.00" numeric format to the chart data point:
oChart.SetDataPointNumFormat("0.00", 0, 1, true);

 PageOrientation

Тип ориетации страницы.

Пример

// Set the page orientation to portrait:
oWorksheet.SetPageOrientation("xlPortrait");

 ParagraphContent

Типы элементов, которые можно добавить в структуру абзаца.

Пример

// Add an element called 'text run' to the paragraph:
oParagraph.AddElement(oRun,0);

PatternType

Доступные предустановленные шаблоны, которые можно использовать для заливки.

Пример

// 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

Свойства формы изображения.

Пример

// 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

Специфические свойства формы изображения.

Пример

// 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

Доступные названия предустановленных цветов.

Пример

// Create a scheme color using the 'lightYellow' color preset:
var oSchemeColor = Api.CreatePresetColor("lightYellow");

pt

Пункт.

Пример

// 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

Возможные значения для базы, на основе которых будет рассчитываться относительное горизонтальное расположение объекта.

Тип:

Пример

// The created drawing will be centered horizontally relative to the page width:
oDrawing.SetHorAlign("page", "center");

RelFromV

Возможные значения для базы, на основе которых будет рассчитываться относительное вертикальное расположение объекта.

Пример

// The created drawing will be centered vertically relative to the page height:
oDrawing.SetVerAlign("page", "center");

ScaleFlag

Условие для масштабирования изображения в форме изображения.

Пример

// Set the scaling condition when the current picture form is scaled if it is too big:
oPictureForm.SetScaleFlag("tooBig");

 SchemeColorId

Доступные идентификаторы цветовой схемы.

Пример

// Create a scheme color with the 'accent2' identifier:
var oSchemeColor = Api.CreateSchemeColor("accent2");

SdtLock

Тип блокировки элемента управления содержимым.

Пример

// 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

Этот тип определяет заданную геометрию формы, которая будет использоваться для фигуры.

Пример

// Create a shape using the 'diamond' preset:
var oDrawing = Api.CreateShape("diamond", 100 * 36000, 100 * 36000, oFill, oStroke); 

ShdType

Тип оттенка, который может быть добавлен к элементу документа.

Пример

// Add a green shadow to the table:
oTablePr.SetShd("clear", 0, 255, 0, false);

SortHeader

Указывает, содержит ли первая строка диапазона сортировки сведения о заголовке.

Пример

// 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

Задает порядок сортировки.

Пример

// 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

Указывает, должна ли сортировка выполняться по строке или по столбцу.

Пример

// 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» — указывает, что условное форматирование применяется ко всей таблице.

Пример

// 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» -задает ширину таблицы или ячейки таблицы, измеряемую в процентах относительно родительского контейнера.

Тип:

Пример

// Set the width of the table cell equal to 100 points (2000 twips):
oTableCell.SetWidth("twips", 2000);

TextFormPr

Свойства текстовой формы.

Пример

// 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

Специфические свойства текстовой формы.

Пример

// 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

Тип преобразования текста.

Пример

// Create a Text Art object with the "textArchUp" text transform type:
var oTextArt = Api.CreateWordArt(oTextPr, "onlyoffice", "textArchUp", oFill, oStroke, 0, 150 * 36000, 50 * 36000) 

TickLabelPosition

Возможные значения положения меток делений на графике (горизонтальное или вертикальное).

• «none» — не отображает выбранные галочки.
• «nextTo»- устанавливает положение выбранных галочек рядом с основной меткой.
• «low» — задает положение выбранных галочек в части графика с меньшими значениями.
• «high» — задает положение выбранных галочек в части графика с более высокими значениями.

Пример

// Set the position of the vertical tick labels next to the main vertical label:
oChart.SetVertAxisTickLabelPosition("nextTo");

TickMark

Тип внешнего вида деления.

Пример

// Specify the "cross" major tick mark type for the vertical axis:
oChart.SetVertAxisMajorTickMark("cross"); 

twips

Двадцатые доли пункта (эквивалентно 1/1440 дюйма).

Пример

// Set the distance between columns equal to 36 points:
oParagraph.SetEqualColumns(2, 720);

VerticalTextAlign

Доступное вертикальное выравнивание текста (используется для выравнивания текста в фигуре с размещением текста внутри нее).

Пример

// The inner text for the created shape will be added aligned vertically closer to the shape upper part:
oDrawing.SetVerticalTextAlign("top");