Глобальные определенияУголЗадает угол диапазона. Тип:
Пример// 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
Тип заливки, использующей изображение в качестве фона.
Тип:
Пример// 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Доступные значения типа ссылки «закладки».
Тип:
Пример// 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Доступные значения ссылочного типа «уравнение»/»рисунок»/»таблица».
Тип:
Пример// 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Доступные значения типа ссылки «концевая сноска».
Тип:
Пример// Add a cross-reference to the page containing an endnote:
oParagraph.AddEndnoteCrossRef("pageNum", oEndnoteParagraph);
footnoteRefToДоступные значения типа ссылки «сноска».
Тип:
Пример// Add a cross-reference to the page containing a footnote:
oParagraph.AddFootnoteCrossRef("pageNum", oFootnoteParagraph);
FormPrBaseCommon 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Типы верхнего и нижнего колонтитула, которые можно применять к разделам документа.
Тип:
Пример// Remove the header of the 'title' type from the final document section:
var oDocContent = oFinalSection.RemoveHeader("title");
headingRefToДоступные значения ссылочного типа «заголовок».
Тип:
Пример// 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);
line240240 сотых линии. Тип:
Пример// 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));
mm1 миллиметр равен 1/10 сантиметра. Тип:
Пример// Set the cell width measured in millimeters to the applied comb of characters:
oTextForm.SetCellWidth(7);
numberedRefToДоступные значения ссылочного типа «нумерованный».
Тип:
Пример// 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);
PositiveFixedAngle60000 градусов (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Пункт. 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Возможные значения для базы, на основе которых будет рассчитываться относительное горизонтальное расположение объекта. Тип:
Пример// 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Этот простой тип указывает возможные значения для разделов таблицы, к которым будут применяться текущие свойства условного форматирования при использовании этого выбранного стиля таблицы.
Тип:
Пример// 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 определяются конкретной таблицей или свойством ширины ячейки таблицы.
Тип:
Пример// 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Возможные значения положения меток делений на графике (горизонтальное или вертикальное).
Тип:
Пример// 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");
|