// Копирует текстовую форму
var oCopyTextForm = oTextForm.Copy();
AxisPos
Положение оси на графике.
Тип:
«top» | «bottom» | «right» | «left»
// Установите значения осей в верхнее положение диаграммы:
oChart.SetAxieNumFormat("top", "0.00");
BlipFillType
Тип заливки, использующей изображение в качестве фона.
«tile» — если изображение меньше заполненной формы, изображение будет расположено по всей поверхности созданной формы.
«stretch» — если изображение меньше заполненной формы, изображение будет растянуто, чтобы соответствовать поверхности созданной формы.
Тип:
«tile» | «stretch»
// Создайте заливку с изображением, которое будет размещено по всей созданной форме:
var oFill = Api.CreateBlipFill("https://example.com/myimage.png", "tile");
bookmarkRefTo
Доступные значения типа ссылки «закладки».
«text» — весь текст закладки.
«pageNum» -номер страницы, на которой находится закладка.
«paraNum» — номер абзаца, в котором находится закладка.
«noCtxParaNum» — сокращенный номер параграфа (только конкретный пункт, например, вместо «4.1.1» вы ссылаетесь только на «1»).
«fullCtxParaNum» — полный номер абзаца, например, «4.1.1».
«aboveBelow» — слова «выше» или «ниже» в зависимости от положения элемента.
// Ячейка будет иметь нижнюю черную пунктирную границу:
oWorksheet.GetRange("E2").SetBorders("Bottom", "Dotted", Api.CreateColorFromRGB(0, 0, 0));
BorderType
Тип границы.
Тип:
«none» | «single»
// Абзац будет иметь одну зеленую нижнюю границу шириной 3 пункта с нулевым смещением от нижнего края абзаца:
oParaPr.SetBottomBorder("single", 24, 0, 0, 255, 0);
BulletType
Тип маркера, который будет добавлен к абзацу электронной таблицы или презентации.
// ChartType используется в текстовых документах
// Полученная диаграмма будет иметь тип «bar3D»:
var oChart = Api.CreateChart("bar3D", [[200, 240, 280],[250, 260, 280]], ["Projected Revenue", "Estimated Costs"], [2014, 2015, 2016], 4051300, 2347595, 24);
// ChartType, используемый в электронных таблицах
// Полученная диаграмма будет иметь тип «bar3D»:
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
// Создайте форму флажка с общими и специфическими свойствами формы флажка:
var oCheckBoxFormPr = {"key": "Marital status", "tip": "Specify your marital status", "required": true, "placeholder": "Marital status", "radio": true};
var oCheckBoxForm = Api.CreateCheckBoxForm(oCheckBoxFormPr);
CheckBoxFormPrBase
Специфические свойства флажка.
Тип:
Объект
Свойства:
Название
Тип
Описание
radio
логический
Указывает, является ли текущий флажок переключателем. В этом случае ключевой параметр рассматривается как идентификатор для группы переключателей.
// Создайте форму флажка с определенными свойствами формы флажка:
var oCheckBoxFormPrBase = {"radio": true};
var oCheckBoxForm = Api.CreateCheckBoxForm(oCheckBoxFormPrBase);
ComboBoxFormPr
Свойства формы комбинированного списка.
Тип:
FormPrBase | ComboBoxFormPrBase
// Создайте форму со списком с общими и специфическими свойствами формы со списком:
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»], «Четвертый»].
// Создайте форму со списком с определенными свойствами формы со списком:
var oComboBoxFormPrBase = {"editable": false, "autoFit": false, "items": ["Latvia", "USA", "UK"]};
var oComboBoxForm = Api.CreateComboBoxForm(oComboBoxFormPrBase);
Direction
Указывает направление конца в указанном диапазоне.
Тип:
«xlUp» | «xlDown» | «xlToRight» | «xlToLeft»
// Возвращает объект Range, представляющий левый конец указанного диапазона:
oWorksheet.GetRange("C4:D5").End("xlToLeft").SetFillColor(Api.CreateColorFromRGB(255, 224, 204))
DocumentElement
Любой допустимый элемент, который можно добавить в структуру документа.
Тип:
ApiParagraph | ApiTable | ApiBlockLvlSdt
// Добавьте в документ элемент документа под названием «абзац»:
oDocument.AddElement(oParagraph);
EMU
Английская единица измерения. 1 мм = 36000 EMU, 1 дюйм = 914400 EMU.
Тип:
численный
// Установите размер создаваемого рисунка 100 мм (10 см) в ширину и 100 мм (10 см) в высоту:
oDrawing.SetSize(100 * 36000, 100 * 36000);
endnoteRefTo
Доступные значения типа ссылки «концевая сноска».
«endnoteNum» — Номер концевой сноски.
«pageNum» — номер страницы, на которой находится сноска.
«aboveBelow» — слова «выше» или «ниже» в зависимости от положения элемента.
«formEndnoteNum» -номер концевой сноски, отформатированной как концевая сноска. Нумерация фактических концевых сносок не изменяется.
// Добавьте перекрестную ссылку на страницу, содержащую сноску:
oParagraph.AddFootnoteCrossRef("pageNum", oFootnoteParagraph);
FormPrBase
Common form properties.
Тип:
Объект
Свойства:
Название
Тип
Описание
key
строковый
Ключ формы.
tip
строковый
Текст подсказки формы.
required
логический
Указывает, является ли форма обязательной или нет..
placeholder
строковый
Текст плейсхолдера формы.
// Создать текстовую форму с общими свойствами формы:
var oFormPrBase = {"key": "Personal information", "tip": "Enter your first name", "required": true, "placeholder": "First name"};
var oTextForm = Api.CreateTextForm(oFormPrBase);
// Вернуть тип текущей формы:
var sFormType = oTextForm.GetFormType();
HdrFtrType
Типы верхнего и нижнего колонтитула, которые можно применять к разделам документа.
«default» — верхний или нижний колонтитул, который можно применить к любой странице по умолчанию.
«title» -верхний или нижний колонтитул, который применяется к титульному листу.
«even» — верхний или нижний колонтитул, который можно применить к четным страницам, чтобы отличить их от нечетных (которые будут считаться значениями по умолчанию).
Тип:
«default» | «title» | «even»
// Удалить заголовок типа «title» из раздела итогового документа:
var oDocContent = oFinalSection.RemoveHeader("title");
headingRefTo
Доступные значения ссылочного типа «заголовок».
«text» — весь текст заголовка.
«pageNum» — номер страницы, на которой расположен заголовок.
«headingNum» — порядковый номер заголовка.
«noCtxHeadingNum» — сокращенный номер заголовка. Убедитесь, что курсор находится в разделе, на который вы ссылаетесь, например, вы находитесь в разделе 4 и хотите обратиться к заголовку 4.B, поэтому вместо «4.B» вы получите только «B». «fullCtxHeadingNum» — полный номер заголовка, даже если точка курсора находится в том же разделе.
«aboveBelow» — слова «выше» или «ниже» в зависимости от положения элемента.
// Создайте заливку с узором «dashDnDiag», который имеет два цвета — зеленый и красный:
var oFill = Api.CreatePatternFill("dashDnDiag", Api.CreateRGBColor(0, 225, 0), Api.CreateRGBColor(255, 0, 0))
percentage
Значение от 0 до 100.
Тип:
численный
// Установить положение изображения в процентах внутри текущей формы:
oPictureForm.SetPicturePosition(70, 70);
PictureFormPr
Свойства формы изображения.
Тип:
FormPrBase | PictureFormPrBase
// Создайте форму изображения с общими и специфическими свойствами формы изображения:
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
процентный
Положение изображения по горизонтали внутри формы изображения, измеряемое в процентах:
0 -картинка размещается слева;
50 — картинка размещается в центре;
100 — картинка размещается вправо;
shiftY
процентный
Положение изображения по вертикали внутри формы изображения, измеряемое в процентах:
0 — картинка размещается сверху;
50 — картинка размещается в центре;
100 — the picture is placed on the bottom.
// Создайте форму изображения с определенными свойствами формы изображения:
var oPictureFormPrBase = {"scaleFlag": "tooBig", "lockAspectRatio": true, "respectBorders": false, "shiftX": 50, "shiftY": 50};
var oPictureForm = Api.CreatePictureForm(oPictureFormPrBase);
PositiveFixedAngle
60000 градусов (5400000 = 90 градусов).
Тип:
численный
// Результирующий угол направления градиента составляет 90 градусов:
var oFill = Api.CreateLinearGradientFill([oGs1, oGs2], 5400000);
PositivePercentage
Тысячная доля процента (100000 = 100%). Тип:
Численный
// Результирующее положение остановки градиента составляет 100%:
var oGs2 = Api.CreateGradientStop(Api.CreateRGBColor(255, 164, 101), 100000);
// Создайте цветовую схему, используя цветовую предустановку «lightYellow»:
var oSchemeColor = Api.CreatePresetColor("lightYellow");
pt
Пункт.
Type:
численный
// Абзац будет иметь одну зеленую нижнюю границу шириной 3 пункта со смещением в 1 пункт от нижнего края абзаца:
oParaPr.SetBottomBorder("single", 24, 1, 0, 255, 0);
pt_8
Восьмых балла (24 восьмых балла = 3 балла).
Тип:
численный
// Абзац будет иметь одну зеленую нижнюю границу шириной 6 пунктов с нулевым смещением от нижнего края абзаца:
oParaPr.SetBottomBorder("single", 48, 0, 0, 255, 0);
RelFromH
Возможные значения для базы, на основе которых будет рассчитываться относительное горизонтальное расположение объекта. Тип:
// Созданный рисунок будет отцентрирован по вертикали относительно высоты страницы:
oDrawing.SetVerAlign("page", "center");
ScaleFlag
Условие для масштабирования изображения в форме изображения.
Тип:
«always» | «never» | «tooBig» | «tooSmall»
// Установите условие масштабирования, при котором текущая форма изображения масштабируется, если она слишком большая:
oPictureForm.SetScaleFlag("tooBig");
// Установите блокировку «sdtContentLocked» для текущего элемента управления содержимым встроенного текста, что означает, что содержимое нельзя редактировать, а контейнер нельзя удалить:
oInlineLvlSdt.SetLock("sdtContentLocked");
ShapeType
Этот тип определяет заданную геометрию формы, которая будет использоваться для фигуры.
Указывает, содержит ли первая строка диапазона сортировки сведения о заголовке.
Тип:
«xlNo» | «xlYes»
// Укажите, что первая строка содержит информацию заголовка:
oWorksheet.GetRange("A1:C5").SetSort("A1:A5", "xlAscending", "B1:B5", "xlDescending", "C1:C5", "xlAscending", "xlYes", "xlSortColumns")
SortOrder
Задает порядок сортировки.
Тип:
«xlAscending» | «xlDescending»
// Укажите, что порядок сортировки значений, указанных в «A1:A5», — по возрастанию:
oWorksheet.GetRange("A1:C5").SetSort("A1:A5", "xlAscending", "B1:B5", "xlDescending", "C1:C5", "xlAscending", "xlYes", "xlSortColumns");
SortOrientation
Указывает, должна ли сортировка выполняться по строке или по столбцу.
Тип:
«xlSortColumns» | «xlSortRows»
// Укажите, что сортировка должна быть по столбцу:
oWorksheet.GetRange("A1:C5").SetSort("A1:A5", "xlAscending", "B1:B5", "xlDescending", "C1:C5", "xlAscending", "xlYes", "xlSortColumns");
StyleType
Тип стиля, используемый для элемента документа.
Тип:
«paragraph» | «table» | «launch» | «numbering»
// Назначить стиль абзаца документа по умолчанию переменной 'oNormalStyle':
var oNormalStyle = oDocument.GetDefaultStyle("paragraph");
TabJc
Типы пользовательской вкладки.
Тип:
«clear» | «left» | «right» | «center»
// Установите позиции табуляции на 50, 75 и 150 пунктов с выравниванием текста по центру, левому и правому краю на каждой позиции табуляции соответственно:
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» — указывает, что условное форматирование применяется ко всей таблице.
// Применить созданный стиль (установить тень) к верхней левой ячейке таблицы:
oTableStyle.GetConditionalTableStyle("topLeftCell").GetTableCellPr().SetShd("clear", 255, 0, 0)
TableWidth
Возможные значения для единиц измерения свойства width определяются конкретной таблицей или свойством ширины ячейки таблицы.
«auto» — устанавливает ширину таблицы или ячейки таблицы в значение auto width.
«twips» — задает ширину таблицы или ячейки таблицы, измеряемую в двадцатых долях пункта.
«nul» — устанавливает нулевое значение ширины таблицы или ячейки таблицы.
«percent» -задает ширину таблицы или ячейки таблицы, измеряемую в процентах относительно родительского контейнера.
// Создайте текстовую форму с общими и специфическими свойствами текстовой формы:
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
логический
Указывает, должно ли содержимое текстовой формы автоматически настраиваться, т.е. соответствует ли размер шрифта размеру формы фиксированного размера.
// Создайте текстовую форму с определенными свойствами текстовой формы:
var oTextFormPrBase = {"comb": true, "maxCharacters": 10, "cellWidth": 3, "multiLine": false, "autoFit": false}; var oTextForm = Api.CreateTextForm(oTextFormPrBase);
// Создайте объект Text Art с типом преобразования текста «textArchUp»:
var oTextArt = Api.CreateWordArt(oTextPr, "r7", "textArchUp", oFill, oStroke, 0, 150 * 36000, 50 * 36000)
TickLabelPosition
Возможные значения положения меток делений на графике (горизонтальное или вертикальное).
«none» — не отображает выбранные галочки.
«nextTo»- устанавливает положение выбранных галочек рядом с основной меткой.
«low» — задает положение выбранных галочек в части графика с меньшими значениями.
«high» — задает положение выбранных галочек в части графика с более высокими значениями.
Тип:
«none» | «nextTo» | «low» | «high»
// Установите положение вертикальных меток рядом с основной вертикальной меткой:
oChart.SetVertAxisTickLabelPosition("nextTo");
TickMark
Тип внешнего вида деления.
Тип:
«cross» | «in» | «none» | «out»
// Укажите тип основной отметки «крест» для вертикальной оси:
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);