Global type definitions

Angle

Specifies the range angle.

Example

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

ApiForm

Types of all supported forms.

Example

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

AxisPos

Axis position in the chart.

Example

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

BlipFillType

The type of a fill which uses an image as a background.

• "tile" - if the image is smaller than the shape which is filled, the image will be tiled all over the created shape surface.
• "stretch" - if the image is smaller than the shape which is filled, the image will be stretched to fit the created shape surface.

Example

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

Available values of the "bookmark" reference type:

• "text" - the entire bookmark text;
• "pageNum" - the bookmark page number;
• "paraNum" - the bookmark paragraph number;
• "noCtxParaNum" - the abbreviated paragraph number (the specific item only, e.g. instead of "4.1.1" you refer to "1" only);
• "fullCtxParaNum - the full paragraph number, e.g. "4.1.1";
• "aboveBelow" - the words "above" or "below" depending on the item position.

Example

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

BordersIndex

Specifies the cell border position.

Example

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

BorderType

A border type.

Example

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

A bullet type which will be added to the paragraph in spreadsheet or presentation.

Example

// The paragraph will be starting with the Arabic numeral which has parenthesis:
var oBullet = Api.CreateNumbering("ArabicParenR");

byte

A numeric value from 0 to 255.

Example

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

Possible values for the caption label.

Example

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

CaptionNumberingFormat

Possible values for the caption numbering format.

• "ALPHABETIC" - upper letter.
• "alphabetic" - lower letter.
• "Roman" - upper Roman.
• "roman" - lower Roman.
• "Arabic" - arabic.

captionRefTo

Available values of the "equation"/"figure"/"table" reference type:

• "entireCaption"- the entire caption text;
• "labelNumber" - the label and object number only, e.g. "Table 1.1";
• "captionText" - the caption text only;
• "pageNum" - the page number containing the referenced object;
• "aboveBelow" - the words "above" or "below" depending on the item position.

Example

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

CaptionSep

Possible values for the caption separator.

• "hyphen" - the "-" punctuation mark.
• "period" - the "." punctuation mark.
• "colon" - the ":" punctuation mark.
• "longDash" - the "—" punctuation mark.
• "dash" - the "-" punctuation mark.

ChartType

This type specifies the available chart types which can be used to create a new chart.

Example

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

Checkbox form properties.

Example

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

Specific checkbox properties.

Example

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

ComboBoxFormPr

Combo box form properties.

Example

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

Specific combo box properties.

Example

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

Specifies the direction of end in the specified range.

Example

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

Any valid element which can be added to the document structure.

Example

// Add a document element called 'paragraph' to the document:
oDocument.AddElement(oParagraph);

EMU

English measure unit. 1 mm = 36000 EMUs, 1 inch = 914400 EMUs.

Example

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

Available values of the "endnote" reference type:

• "endnoteNum" - the endnote number;
• "pageNum" - the endnote page number;
• "aboveBelow" - the words "above" or "below" depending on the item position;
• "formEndnoteNum" - the form number formatted as an endnote. The numbering of the actual endnotes is not affected.

Example

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

footnoteRefTo

Available values of the "footnote" reference type:

• "footnoteNum" - the footnote number;
• "pageNum" - the page number of the footnote;
• "aboveBelow" - the words "above" or "below" depending on the position of the item;
• "formFootnoteNum" - the form number formatted as a footnote. The numbering of the actual footnotes is not affected.

Example

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

FormPrBase

Common form properties.

Example

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

Form type. The available form types.

Example

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

HdrFtrType

Header and footer types which can be applied to the document sections.

• "default" - a header or footer which can be applied to any default page.
• "title" - a header or footer which is applied to the title page.
• "even" - a header or footer which can be applied to even pages to distinguish them from the odd ones (which will be considered default).

Example

// Remove the header of the 'title' type from the final document section:
var oDocContent = oFinalSection.RemoveHeader("title");

headingRefTo

Available values of the "heading" reference type:

• "text" - the entire heading text;
• "pageNum" - the heading page number;
• "headingNum" - the heading sequence number;
• "noCtxHeadingNum" - the abbreviated heading number. Make sure the cursor pointer is in the section you are referencing to, e.g. you are in section 4 and you wish to refer to heading 4.B, so instead of "4.B" you receive "B" only;
• "fullCtxHeadingNum" - the full heading number even if the cursor pointer is in the same section;
• "aboveBelow" - the words "above" or "below" depending on the item position.

Example

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

highlightColor

Available highlight colors.

Example

// Highlight a paragraph in green:
oParagraph.SetHighlight("green");

hps

Half-points (2 half-points = 1 point).

Example

// Set the text font size to 22 half-points:
oTextPr.SetFontSize(22);

line240

240ths of a line.

Example

// The paragraph line spacing is set to 1 line:
oParaPr.SetSpacingLine(240, "auto");

LineStyle

Specifies the line style used to form the cell border.

Example

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

mm

1 millimetre equals 1/10th of a centimetre.

Example

// Set the cell width measured in millimeters to the applied comb of characters:
oTextForm.SetCellWidth(7);

numberedRefTo

Available values of the "numbered" reference type:

• "pageNum" - the numbered item page number;
• "paraNum" - the numbered item paragraph number;
• "noCtxParaNum" - the abbreviated paragraph number (the specific item only, e.g. instead of "4.1.1" you refer to "1" only);
• "fullCtxParaNum" - the full paragraph number, e.g. "4.1.1";
• "text" - the paragraph text value, e.g. if you have "4.1.1. Terms and Conditions", you refer to "Terms and Conditions" only;
• "aboveBelow" - the words "above" or "below" depending on the item position.

Example

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

NumFormat

Standard numeric format.

Example

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

PageOrientation

The page orientation type.

Example

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

ParagraphContent

The types of elements that can be added to the paragraph structure.

Example

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

PatternType

The available preset patterns which can be used for the fill.

Example

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

Value from 0 to 100.

Example

// Set the picture position measured in percent inside the current form:
oPictureForm.SetPicturePosition(70, 70);

PictureFormPr

Picture form properties.

Example

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

Specific picture form properties.

Example

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

60000th of a degree (5400000 = 90 degrees).

Example

// The resulting gradient direction angle is 90 degrees:
var oFill = Api.CreateLinearGradientFill([oGs1, oGs2], 5400000);

PositivePercentage

The 1000th of a percent (100000 = 100%).

Example

// The resulting gradient stop position is 100%:
var oGs2 = Api.CreateGradientStop(Api.CreateRGBColor(255, 164, 101), 100000);

PresetColor

The available preset color names.

Example

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

pt

A point.

Example

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

Eighths of a point (24 eighths of a point = 3 points).

Example

// 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 possible values for the base which the relative horizontal positioning of an object will be calculated from.

Example

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

RelFromV

The possible values for the base which the relative vertical positioning of an object will be calculated from.

Example

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

ScaleFlag

The condition to scale an image in the picture form.

Example

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

SchemeColorId

The available color scheme identifiers.

Example

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

SdtLock

The lock type of the content control.

Example

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

This type specifies the preset shape geometry that will be used for a shape.

Example

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

ShdType

A shade type which can be added to the document element.

Example

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

SortHeader

Specifies whether the first row of the sort range contains the header information.

Example

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

Specifies the sort order.

Example

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

Specifies if the sort should be by row or column.

Example

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

The style type used for the document element.

Example

// Assign the default document paragraph style to the 'oNormalStyle' variable:
var oNormalStyle = oDocument.GetDefaultStyle("paragraph");

TabJc

Types of custom tab.

Example

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

This simple type specifies possible values for the table sections to which the current conditional formatting properties will be applied when this selected table style is used.

• "topLeftCell" - specifies that the table formatting is applied to the top left cell.
• "topRightCell" - specifies that the table formatting is applied to the top right cell.
• "bottomLeftCell" - specifies that the table formatting is applied to the bottom left cell.
• "bottomRightCell" - specifies that the table formatting is applied to the bottom right cell.
• "firstRow" - specifies that the table formatting is applied to the first row.
• "lastRow" - specifies that the table formatting is applied to the last row.
• "firstColumn" - specifies that the table formatting is applied to the first column. Any subsequent row which is in table header (ApiTableRowPr#SetTableHeader) will also use this conditional format.
• "lastColumn" - specifies that the table formatting is applied to the last column.
• "bandedColumn" - specifies that the table formatting is applied to odd numbered groupings of rows.
• "bandedColumnEven" - specifies that the table formatting is applied to even numbered groupings of rows.
• "bandedRow" - specifies that the table formatting is applied to odd numbered groupings of columns.
• "bandedRowEven" - specifies that the table formatting is applied to even numbered groupings of columns.
• "wholeTable" - specifies that the conditional formatting is applied to the whole table.

Example

// Apply the created style (set shadow) to the top left cell of the table:
oTableStyle.GetConditionalTableStyle("topLeftCell").GetTableCellPr().SetShd("clear", 255, 0, 0);

TableWidth

The possible values for the units of the width property are defined by a specific table or table cell width property.

• "auto" - sets the table or table cell width to auto width.
• "twips" - sets the table or table cell width to be measured in twentieths of a point.
• "nul" - sets the table or table cell width to be of a zero value.
• "percent" - sets the table or table cell width to be measured in percent to the parent container.

Example

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

TextFormPr

Text form properties.

Example

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

Specific text form properties.

Example

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

Text transform type.

Example

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

Possible values for the position of chart tick labels (either horizontal or vertical).

• "none" - does not display the selected tick labels.
• "nextTo" - sets the position of the selected tick labels next to the main label.
• "low" - sets the position of the selected tick labels in the part of the chart with lower values.
• "high" - sets the position of the selected tick labels in the part of the chart with higher values.

Example

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

TickMark

The type of tick mark appearance.

Example

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

TocBuildFromPr

Table of contents properties which specify whether to generate the table of contents from the outline levels or the specified styles.

TocLeader

Possible values for the table of contents leader:

• "dot" - "......."
• "dash" - "-------"
• "underline" - "_______"

TocPr

Table of contents properties.

TocStyle

Possible values for the table of contents style.

TocStyleLvl

Table of contents style levels.

TofPr

Table of figures properties.

TofStyle

Possible values for the table of figures style.

twips

Twentieths of a point (equivalent to 1/1440th of an inch).

Example

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

VerticalTextAlign

The available text vertical alignment (used to align text in a shape with a placement for text inside it).

Example

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