Глобальные определения

Angel

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

Тип:
  • «xlDownward» | «xlHorizontal» | «xlUpward» | «xlVertical»
// Укажите, что содержимое диапазона будет повернуто вверх:
oWorksheet.GetRange("A1").SetOrientation("xlUpward"); 
ApiForm

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

Тип:
  • ApiTextForm | ApiComboBoxForm | ApiCheckBoxForm | ApiPictureForm | ApiComplexForm
// Копирует текстовую форму
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");

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

  • «text» — весь текст закладки.
  • «pageNum» -номер страницы, на которой находится закладка.
  • «paraNum» — номер абзаца, в котором находится закладка.
  • «noCtxParaNum» — сокращенный номер параграфа (только конкретный пункт, например, вместо «4.1.1» вы ссылаетесь только на «1»).
  • «fullCtxParaNum» — полный номер абзаца, например, «4.1.1».
  • «aboveBelow» — слова «выше» или «ниже» в зависимости от положения элемента.
Тип:
  • «text» | «pageNum» | «paraNum» | «noCtxParaNum» | «fullCtxParaNum» | «aboveBelow»
// Добавить перекрестную ссылку на страницу, содержащую закладку:
oParagraph.AddBookmarkCrossRef("pageNum", sBookmark);
BordersIndex

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

Тип:
  • «DiagonalDown» | «DiagonalUp» | «Bottom» | «Left» | «Right» | «Top» | «InsideHorizontal» | «InsideVertical»
// Ячейка будет иметь нижнюю черную пунктирную границу:
oWorksheet.GetRange("E2").SetBorders("Bottom", "Dotted", Api.CreateColorFromRGB(0, 0, 0));

Тип границы.

Тип:
  • «none» | «single»
// Абзац будет иметь одну зеленую нижнюю границу шириной 3 пункта с нулевым смещением от нижнего края абзаца:
oParaPr.SetBottomBorder("single", 24, 0, 0, 255, 0);

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

Тип:
  • «None» | «ArabicPeriod» | «ArabicParenR» | «RomanUcPeriod» | «RomanLcPeriod» | «AlphaLcParenR» | «AlphaLcPeriod» | «AlphaUcParenR» | «AlphaUcPeriod»
// Абзац будет начинаться с арабской цифры, заключенной в скобки:
var oBullet = Api.CreateNumbering("ArabicParenR");

Числовое значение от 0 до 255.

Тип:
  • численный
// Результирующий цвет — зеленый, байты измеряются в десятичных числах:
var oRGBColor = Api.CreateRGBColor(0, 255, 0);
// Результирующий цвет — зеленый, байты измеряются в шестнадцатеричных числах:
var oRGBColor = Api.CreateRGBColor(0, 0xff, 0);

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

Тип:
  • «Equation» | «Figure» | «Table»
// Добавьте перекрестную ссылку на страницу, содержащую заголовок таблицы:
oParagraph.AddCaptionCrossRef("table", "pageNum", oCaptionParagraph);

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

  • «entireCaption» — полный текст надписи.
  • «labelNumber» -только метка и номер объекта, например, «Таблица 1.1».
  • «captionText» -только текст надписи.
  • «pageNum» — номер страницы, содержащей указанный объект.
  • «aboveBelow» -слова «выше» или «ниже» в зависимости от положения элемента.
Тип:
  • «entireCaption» | «labelNumber» | «captionText» | «pageNum» | «aboveBelow»
// Добавьте перекрестную ссылку на страницу, содержащую заголовок таблицы:
oParagraph.AddCaptionCrossRef("table", "pageNum", oCaptionParagraph);

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

Тип:
  • «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 используется в текстовых документах
// Полученная диаграмма будет иметь тип «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);

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

Тип:
  • FormPrBase | CheckBoxFormPrBase
// Создайте форму флажка с общими и специфическими свойствами формы флажка:
var oCheckBoxFormPr = {"key": "Marital status", "tip": "Specify your marital status", "required": true, "placeholder": "Marital status", "radio": true};
var oCheckBoxForm = Api.CreateCheckBoxForm(oCheckBoxFormPr);

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

Тип:
  • Объект
Свойства:
НазваниеТипОписание
radioлогическийУказывает, является ли текущий флажок переключателем. В этом случае ключевой параметр рассматривается как идентификатор для группы переключателей.
// Создайте форму флажка с определенными свойствами формы флажка:
var oCheckBoxFormPrBase = {"radio": true};
var oCheckBoxForm = Api.CreateCheckBoxForm(oCheckBoxFormPrBase);

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

Тип:
  • 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);

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

Тип:
  • «xlUp» | «xlDown» | «xlToRight» | «xlToLeft»
// Возвращает объект Range, представляющий левый конец указанного диапазона:
oWorksheet.GetRange("C4:D5").End("xlToLeft").SetFillColor(Api.CreateColorFromRGB(255, 224, 204))

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

Тип:
  • ApiParagraph | ApiTable | ApiBlockLvlSdt
// Добавьте в документ элемент документа под названием «абзац»:
oDocument.AddElement(oParagraph);

EMU

Английская единица измерения. 1 мм = 36000 EMU, 1 дюйм = 914400 EMU.

Тип:
  • численный
// Установите размер создаваемого рисунка 100 мм (10 см) в ширину и 100 мм (10 см) в высоту:
oDrawing.SetSize(100 * 36000, 100 * 36000);

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

  • «endnoteNum» — Номер концевой сноски.
  • «pageNum» — номер страницы, на которой находится сноска.
  • «aboveBelow» — слова «выше» или «ниже» в зависимости от положения элемента.
  • «formEndnoteNum» -номер концевой сноски, отформатированной как концевая сноска. Нумерация фактических концевых сносок не изменяется.
Тип:
  • «endnoteNum» | «pageNum» | «aboveBelow» | «formEndnoteNum»
// Добавьте перекрестную ссылку на страницу, содержащую концевую сноску:
oParagraph.AddEndnoteCrossRef("pageNum", oEndnoteParagraph);

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

  • «footnoteNum» — номер сноски.
  • «pageNum» — номер страницы, на которой находится сноска.
  • «aboveBelow» — слова «выше» или «ниже» в зависимости от положения элемента.
  • «formFootnoteNum» — номер сноски, отформатированной как сноска. Нумерация фактических сносок не изменяется.
Тип:
  • «footnoteNum» | «pageNum» | «aboveBelow» | «formFootnoteNum»
// Добавьте перекрестную ссылку на страницу, содержащую сноску: 
oParagraph.AddFootnoteCrossRef("pageNum", oFootnoteParagraph);

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);

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

Тип:
  • «textForm» | «comboBoxForm» | «dropDownForm» | «checkBoxForm» | «radioButtonForm» | «pictureForm»
// Вернуть тип текущей формы: 
var sFormType = oTextForm.GetFormType();

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

  • «default» — верхний или нижний колонтитул, который можно применить к любой странице по умолчанию.
  • «title» -верхний или нижний колонтитул, который применяется к титульному листу.
  • «even» — верхний или нижний колонтитул, который можно применить к четным страницам, чтобы отличить их от нечетных (которые будут считаться значениями по умолчанию).
Тип:
  • «default» | «title» | «even»
// Удалить заголовок типа «title» из раздела итогового документа: 
var oDocContent = oFinalSection.RemoveHeader("title");

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

  • «text» — весь текст заголовка.
  • «pageNum» — номер страницы, на которой расположен заголовок.
  • «headingNum» — порядковый номер заголовка.
  • «noCtxHeadingNum» — сокращенный номер заголовка. Убедитесь, что курсор находится в разделе, на который вы ссылаетесь, например, вы находитесь в разделе 4 и хотите обратиться к заголовку 4.B, поэтому вместо «4.B» вы получите только «B».
    «fullCtxHeadingNum» — полный номер заголовка, даже если точка курсора находится в том же разделе.
  • «aboveBelow» — слова «выше» или «ниже» в зависимости от положения элемента.
Тип:
  • «text» | «pageNum» | «headingNum» | «noCtxHeadingNum» | «fullCtxHeadingNum» | «aboveBelow»
// Добавьте перекрестную ссылку на страницу, содержащую заголовок: 
oParagraph.AddHeadingCrossRef("pageNum", oHeadingParagraph);

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

Тип:
  • «black» | «blue» | «cyan» | «green» | «magenta» | «red» | «yellow» | «white» | «darkBlue» | «darkCyan» | «darkGreen» | «darkMagenta» | «darkRed» | «darkYellow» | «darkGray» | «lightGray» | «none»
// Выделить абзац зеленым цветом: 
oParagraph.SetHighlight("green");

Половина точки (2 полуточка = 1 точка).

Тип:
  • численный
// Установите размер шрифта текста 22 полупункта: 
oTextPr.SetFontSize(22);

240 сотых линии.

Тип:
  • численный
// Интервал между строками абзаца установлен на 1 строку: 
oParaPr.SetSpacingLine(240, "auto");

LineStyle

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

Тип:
  • «None» | «Double» | «Hair» | «DashDotDot» | «DashDot» | «Dotted» | «Dashed» | «Thin» | «MediumDashDotDot» | «SlantDashDot» | «MediumDashDot» | «MediumDashed» | «Medium» | «Thick»
// Ячейка будет иметь нижнюю черную пунктирную границу: 
oWorksheet.GetRange("E2").SetBorders("Bottom", "Dotted", Api.CreateColorFromRGB(0, 0, 0));

mm

1 миллиметр равен 1/10 сантиметра.

Тип:
  • численный
// Установите ширину ячейки, измеренную в миллиметрах, для примененной гребенки символов: 
oTextForm.SetCellWidth(7);

Доступные значения ссылочного типа «нумерованный».

  • «pageNum» — номер страницы нумерованного элемента.
  • «paraNum» — номер абзаца пронумерованного элемента.
  • «noCtxParaNum» — сокращенный номер абзаца (только конкретный пункт нумерованного списка, например, вместо «4.1.1» вы ссылаетесь только на «1»).
  • «fullCtxParaNum» — полный номер абзаца, например, «4.1.1»
  • «text» — текстовое значение параграфа, например, если у вас есть «4.1.1. Положения и условия», вы ссылаетесь только на «Положения и условия».
  • «aboveBelow» — слова «выше» или «ниже» в зависимости от положения элемента.
Тип:
  • «pageNum» | «paraNum» | «noCtxParaNum» | «fullCtxParaNum» | «text» | «aboveBelow»
// Добавьте перекрестную ссылку на страницу, содержащую пронумерованный абзац: 
oParagraph.AddNumberedCrossRef("pageNum", oNumberedParagraph, true, true);

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

Тип:
  • «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» | «@»
// Установите числовой формат «0,00» для точки данных диаграммы: 
oChart.SetDataPointNumFormat("0.00", 0, 1, true);

PageOrientation

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

Тип:
  • «xlLandscape» | «xlPortrait»
// Установите книжную ориентацию страницы: 
oWorksheet.SetPageOrientation("xlPortrait");

ParagraphContent

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

Тип:
  • ApiUnsupported | ApiRun | ApiInlineLvlSdt | ApiHyperlink | ApiFormBase
// Добавьте в абзац элемент под названием «текстовый поток»: 
oParagraph.AddElement(oRun,0);

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

Тип:
  • «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»
// Создайте заливку с узором «dashDnDiag», который имеет два цвета — зеленый и красный: 
var oFill = Api.CreatePatternFill("dashDnDiag", Api.CreateRGBColor(0, 225, 0), Api.CreateRGBColor(255, 0, 0))

Значение от 0 до 100.

Тип:
  • численный
// Установить положение изображения в процентах внутри текущей формы: 
oPictureForm.SetPicturePosition(70, 70);

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

Тип:
  • 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);

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

Тип:
  • Объект
Свойства:
НазваниеТипОписание
scaleFlagScaleFlagУсловие масштабирования изображения в форме рисунка: «всегда», «никогда», «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);

60000 градусов (5400000 = 90 градусов).

Тип:
  • численный
// Результирующий угол направления градиента составляет 90 градусов: 
var oFill = Api.CreateLinearGradientFill([oGs1, oGs2], 5400000);

Тысячная доля процента (100000 = 100%).

Тип:

  • Численный
// Результирующее положение остановки градиента составляет 100%: 
var oGs2 = Api.CreateGradientStop(Api.CreateRGBColor(255, 164, 101), 100000);

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

Тип:
  • «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»
// Создайте цветовую схему, используя цветовую предустановку «lightYellow»: 
var oSchemeColor = Api.CreatePresetColor("lightYellow");

Пункт.

Type:
  • численный
// Абзац будет иметь одну зеленую нижнюю границу шириной 3 пункта со смещением в 1 пункт от нижнего края абзаца: 
oParaPr.SetBottomBorder("single", 24, 1, 0, 255, 0);

Восьмых балла (24 восьмых балла = 3 балла).

Тип:
  • численный
// Абзац будет иметь одну зеленую нижнюю границу шириной 6 пунктов с нулевым смещением от нижнего края абзаца: 
oParaPr.SetBottomBorder("single", 48, 0, 0, 255, 0);

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

Тип:

  • «character» | «column» | «leftMargin» | «rightMargin» | «margin» | «page»
// Созданный рисунок будет отцентрирован по горизонтали относительно ширины страницы: 
oDrawing.SetHorAlign("page", "center");

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

Тип:
  • «bottomMargin» | «topMargin» | «margin» | «page» | «line» | «paragraph»
// Созданный рисунок будет отцентрирован по вертикали относительно высоты страницы: 
oDrawing.SetVerAlign("page", "center");

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

Тип:
  • «always» | «never» | «tooBig» | «tooSmall»
// Установите условие масштабирования, при котором текущая форма изображения масштабируется, если она слишком большая: 
oPictureForm.SetScaleFlag("tooBig");

SchemeColorId

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

Тип:
  • «accent1» | «accent2» | «accent3» | «accent4» | «accent5» | «accent6» | «bg1» | «bg2» | «dk1» | «dk2» | «lt1» | «lt2» | «tx1» | «tx2»
// Создайте цветовую схему с идентификатором «accent2»: 
var oSchemeColor = Api.CreateSchemeColor("accent2");

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

Тип:
  • «unlocked» | «contentLocked» | «sdtContentLocked» | «sdtLocked»
// Установите блокировку «sdtContentLocked» для текущего элемента управления содержимым встроенного текста, что означает, что содержимое нельзя редактировать, а контейнер нельзя удалить: 
oInlineLvlSdt.SetLock("sdtContentLocked");

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

Тип:
  • «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»
// Создайте фигуру, используя предустановку «diamond»: 
var oDrawing = Api.CreateShape("diamond", 100 * 36000, 100 * 36000, oFill, oStroke);

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

Тип:
  • «nil» | «clear»
// Добавьте зеленую тень к столу: 
oTablePr.SetShd("clear", 0, 255, 0, false);

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

Тип:
  • «xlNo» | «xlYes»
// Укажите, что первая строка содержит информацию заголовка: 
oWorksheet.GetRange("A1:C5").SetSort("A1:A5", "xlAscending", "B1:B5", "xlDescending", "C1:C5", "xlAscending", "xlYes", "xlSortColumns")

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

Тип:
  • «xlAscending» | «xlDescending»
// Укажите, что порядок сортировки значений, указанных в «A1:A5», — по возрастанию: 
oWorksheet.GetRange("A1:C5").SetSort("A1:A5", "xlAscending", "B1:B5", "xlDescending", "C1:C5", "xlAscending", "xlYes", "xlSortColumns");

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

Тип:
  • «xlSortColumns» | «xlSortRows»
// Укажите, что сортировка должна быть по столбцу: 
oWorksheet.GetRange("A1:C5").SetSort("A1:A5", "xlAscending", "B1:B5", "xlDescending", "C1:C5", "xlAscending", "xlYes", "xlSortColumns");

Тип стиля, используемый для элемента документа.

Тип:
  • «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"]);

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

  • «topLeftCell» — указывает, что форматирование таблицы применяется к верхней левой ячейке.
  • «topRightCell» -указывает, что форматирование таблицы применяется к верхней правой ячейке.
  • «bottomLeftCell» — указывает, что форматирование таблицы применяется к нижней левой ячейке.
  • «bottomRightCell» — указывает, что форматирование таблицы применяется к нижней правой ячейке.
  • «firstRow» — указывает, что форматирование таблицы применяется к первой строке.
  • «lastRow» — указывает, что форматирование таблицы применяется к последней строке.
  • «firstColumn» — указывает, что форматирование таблицы применяется к первому столбцу. Любая последующая строка в заголовке таблицы ( ApiTableRowPr.SetTableHeader ) также будет использовать этот условный формат.
  • «lastColumn» -указывает, что форматирование таблицы применяется к последнему столбцу.
  • «bandedColumn» — указывает, что форматирование таблицы применяется к группам строк с нечетными номерами.
  • «bandedColumnEven» — указывает, что форматирование таблицы применяется к четным группам строк.
  • «bandedRow» — указывает, что форматирование таблицы применяется к группам столбцов с нечетными номерами.
  • «bandedRowEven» — указывает, что форматирование таблицы применяется к четным группам столбцов.
  • «wholeTable» — указывает, что условное форматирование применяется ко всей таблице.
Тип:
  • «topLeftCell» | «topRightCell» | «bottomLeftCell» | «bottomRightCell» | «firstRow» | «lastRow» | «firstColumn» | «lastColumn» | «bandedColumn» | «bandedColumnEven» | «bandedRow» | «bandedRowEven» | «wholeTable»
// Применить созданный стиль (установить тень) к верхней левой ячейке таблицы: 
oTableStyle.GetConditionalTableStyle("topLeftCell").GetTableCellPr().SetShd("clear", 255, 0, 0)

Возможные значения для единиц измерения свойства width определяются конкретной таблицей или свойством ширины ячейки таблицы.

  • «auto» — устанавливает ширину таблицы или ячейки таблицы в значение auto width.
  • «twips» — задает ширину таблицы или ячейки таблицы, измеряемую в двадцатых долях пункта.
  • «nul» — устанавливает нулевое значение ширины таблицы или ячейки таблицы.
  • «percent» -задает ширину таблицы или ячейки таблицы, измеряемую в процентах относительно родительского контейнера.

Тип:

  • «auto» | «twips» | «nul» | «percent»
// Установите ширину ячейки таблицы равной 100 пунктам (2000 твипов): 
oTableCell.SetWidth("twips", 2000);

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

Тип:
  • FormPrBase | TextFormPrBase
// Создайте текстовую форму с общими и специфическими свойствами текстовой формы: 
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);

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

Тип:
  • Объект
Свойства:
НазваниеТипОписание
combлогическийУказывает, должна ли текстовая форма представлять собой комбинацию символов с одинаковой шириной ячейки. Максимальное количество символов должно быть установлено на положительное значение.
maxCharactersчисленныйМаксимальное количество символов в текстовой форме.
cellWidthчисленныйШирина ячейки для каждого символа измеряется в миллиметрах. Если этот параметр не указан или равен 0 или меньше, то ширина будет установлена автоматически.
multiLineлогическийУказывает, является ли текущая текстовая форма фиксированного размера многострочной или нет.
autoFitлогическийУказывает, должно ли содержимое текстовой формы автоматически настраиваться, т.е. соответствует ли размер шрифта размеру формы фиксированного размера.
// Создайте текстовую форму с определенными свойствами текстовой формы: 
var oTextFormPrBase = {"comb": true, "maxCharacters": 10, "cellWidth": 3, "multiLine": false, "autoFit": false}; var oTextForm = Api.CreateTextForm(oTextFormPrBase);

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

Тип:
  • «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»
// Создайте объект Text Art с типом преобразования текста «textArchUp»: 
var oTextArt = Api.CreateWordArt(oTextPr, "r7", "textArchUp", oFill, oStroke, 0, 150 * 36000, 50 * 36000)

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

  • «none» — не отображает выбранные галочки.
  • «nextTo»- устанавливает положение выбранных галочек рядом с основной меткой.
  • «low» — задает положение выбранных галочек в части графика с меньшими значениями.
  • «high» — задает положение выбранных галочек в части графика с более высокими значениями.
Тип:
  • «none» | «nextTo» | «low» | «high»
// Установите положение вертикальных меток рядом с основной вертикальной меткой: 
oChart.SetVertAxisTickLabelPosition("nextTo");

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

Тип:
  • «cross» | «in» | «none» | «out»
// Укажите тип основной отметки «крест» для вертикальной оси: 
oChart.SetVertAxisMajorTickMark("cross");

Свойства оглавления, которые определяют, следует ли создавать оглавление на основе уровней структуры или указанных стилей.

Тип:
  • Object
Свойства:
НаименованиеТипОписание
OutlineLvlsnumberМаксимальное количество уровней в оглавлении.
StylesLvlsArray.Стили уровней (пример, [{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);

Возможные значения для оглавления:

  • «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
Свойства:
НаименованиеТипОписание
ShowPageNumsbooleanУказывает, отображать ли номера страниц в оглавлении.
RightAlgnbooleanУказывает, выравнивать ли номера страниц по правому краю в оглавлении.
LeaderTypeTocLeaderТип главного заголовка в оглавлении.
FormatAsLinksbooleanУказывает, форматировать ли оглавление как ссылки.
BuildFromTocBuildFromPrУказывает, следует ли создавать оглавление на основе уровней структуры или указанных стилей.
TocStyleTocStyleТип стиля оглавления.
Пример
// Добавить в документ оглавление с указанными свойствами: 
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
Свойства:
НаименованиеТипописание
NamestringИмя стиля (пример, «Heading 1»).
LvlnumberУровень, который будет применен к указанному стилю в оглавлении.
Пример
// Добавить в документ оглавление, созданное на основе указанных стилей: 
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
Свойства:
НаименованиеТипОписание
ShowPageNumsbooleanУказывает, отображать ли номера страниц в таблице рисунков.
RightAlgnbooleanУказывает, выравнивать ли номера страниц по правому краю в таблице рисунков.
LeaderTypeTocLeaderТип лидера в таблице цифр.
FormatAsLinksbooleanУказывает, форматировать ли таблицу цифр как ссылки.
BuildFromCaptionLabel | stringУказывает, следует ли создавать таблицу рисунков на основе указанной метки заголовка или используемого имени стиля абзаца (например,, «Heading 1»).
LabelNumberbooleanУказывает, включать ли метку и номер в таблицу рисунков.
TofStyleTofStyleТаблица типов стилей фигур.
Пример
// Добавьте в документ таблицу фигур с указанными свойствами: 
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);

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

Тип:
  • численный
// Установите расстояние между столбцами равным 36 точкам: 
oParagraph.SetEqualColumns(2, 720);

 

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

Тип:
  • «top» | «center» | «bottom»
// Внутренний текст для созданной фигуры будет добавлен и выровнен по вертикали ближе к верхней части фигуры: 
oDrawing.SetVerticalTextAlign("top");

 

Была ли полезна статья?
Позвольте нам стать лучше