Get Started
Documentation

List of all ONLYOFFICE Document Builder classes and methods

Integration API

CDocBuilder
Name Description
CloseFile Close the file to stop working with it. You can use a single ONLYOFFICE Document Builder instance to work with all your files, but you need to close the previous file before you can start working with the next one in this case.
CreateFile Create a new file. The type of the file which will be created needs to be set.
Dispose Unloading the ONLYOFFICE Document Builder from the application memory when it is no longer needed.
ExecuteCommand Execute the command which will be used to create the document file (text document, spreadsheet, PDF, etc.). See the Text document API and Spreadsheet API sections for more information which commands are available for various document types.
Initialize Initializing the ONLYOFFICE Document Builder as a library for the application to be able to work with it.
OpenFile Open the document file which will be edited and saved afterwards.
Run Run ONLYOFFICE Document Builder executable. If you do not want to write a C++ application, you can simply use the docbuilder.exe executable file and run it with the .docbuilder file as an argument, where all the code for the document file creation will be written. For C++ the path to the executable file from the sPath parameter must be used, the CDocBuilder object created and the Run method is called.
RunTextA Run the all the commands for the document creation using a single command. Compared to CDocBuilder.ExecuteCommand where only one command at a time is allowed, CDocBuilder.RunTextA makes it possible to enter all the commands for the document creation at once.
RunTextW Run the all the commands for the document creation using a single command. Compared to CDocBuilder.ExecuteCommand where only one command at a time is allowed, CDocBuilder.RunTextW makes it possible to enter all the commands for the document creation at once.
SaveFile Save the file after all the changes are made. The type of the file which will be saved needs to be set.
SetProperty The argument which can be trasferred to the program outside the CDocBuilder.ExecuteCommand method.
SetPropertyW The argument which can be trasferred to the program outside the CDocBuilder.ExecuteCommand method.
SetTmpFolder The path to the folder where the program will temporarily save files needed for the program correct work. After the successful document file creation all the files will be deleted from the folder. If no temporary folder is set, the system one will be used.

Text documents API

Api
Name Description
CreateBlipFill Create a blip fill which allows to fill the object using a selected image as the object background.
CreateChart Create a chart with the parameters specified.
CreateGradientStop Create a gradient stop used for different types of gradients.
CreateImage Create an image with the parameters specified.
CreateLinearGradientFill Create a linear gradient fill which allows to fill the object using a selected linear gradient as the object background.
CreateNoFill Create no fill and remove the fill from the element.
CreateParagraph Create a new paragraph.
CreatePatternFill Create a pattern fill which allows to fill the object using a selected pattern as the object background.
CreatePresetColor Create a color selecting it from one of the available color presets.
CreateRadialGradientFill Create a radial gradient fill which allows to fill the object using a selected radial gradient as the object background.
CreateRGBColor Create an RGB color setting the appropriate values for the red, green and blue color components.
CreateRun Create a new smaller text block to be inserted to the current paragraph or table.
CreateSchemeColor Create a complex color scheme selecting from one of the available schemes.
CreateShape Create a shape with the parameters specified.
CreateSolidFill Create a solid fill which allows to fill the object using a selected solid color as the object background.
CreateStroke Create a stroke adding shadows to the element.
CreateTable Create a new table with a specified number of rows and columns.
GetDocument Get the main document.
ApiChart
Name Description
GetClassType Get the type of this class.
SetHorAxisTitle Specify the horizontal axis chart title.
SetLegendPos Specify the chart legend position.
SetShowDataLabels Specifies which chart data labels are shown for the chart.
SetTitle Specify a chart title.
SetVerAxisTitle Specify the vertical axis chart title.
ApiDocument
Name Description
AddElement Add paragraph or table using its position in the document.
CreateNumbering Create an abstract multilevel numbering with a specified type.
CreateSection Create a new document section which ends at the specified paragraph. Allows to set local parameters for the current section - page size, footer, header, columns, etc.
CreateStyle Create a new style with the specified type and name. If there is a style with the same name it will be replaced with a new one.
GetClassType Get this class type.
GetCommentsReport Get a report about all the comments added to the document.
GetDefaultParaPr Get a set of default paragraph properties in the current document.
GetDefaultStyle Get the default style parameters for the specified document element.
GetDefaultTextPr Get a set of default properties for the text run in the current document.
GetElement Get the element by its position in the document.
GetElementsCount Get the number of elements in the current document.
GetFinalSection Get the document final section.
GetReviewReport Get a report about every change which was made to the document in the review mode.
GetStyle Get a style by the style name.
Push Push a paragraph or a table to actually add it to the document.
RemoveAllElements Remove all elements from the current document or from the current document element.
RemoveElement Remove element using the position specified.
SetEvenAndOddHdrFtr Specify whether sections in this document will have different headers and footers for even and odd pages (one header/footer for odd pages and another header/footer for even pages).
ApiDocumentContent
Name Description
AddElement Add paragraph or table using its position in the document.
GetClassType Get the type of the current class.
GetElement Get the element by its position in the document.
GetElementsCount Get the number of elements in the current document.
Push Push a paragraph or a table to actually add it to the document.
RemoveAllElements Remove all elements from the current document or from the current document element.
RemoveElement Remove element using the position specified.
ApiDrawing
Name Description
GetClassType Get the type of the class based on this base class.
SetDistances Specify the minimum distance which will be maintained between the edges of this drawing object and any subsequent text.
SetHorAlign Specify how the floating object will be horizontally aligned.
SetHorPosition Set an absolute measurement for the horizontal positioning of the floating object.
SetSize Set the size of the object (image, shape, chart) bounding box.
SetVerAlign Specify how the floating object will be vertically aligned.
SetVerPosition Set an absolute measurement for the vertical positioning of the floating object.
SetWrappingStyle Set the wrapping type of this object (image, shape, chart).
ApiFill
Name Description
GetClassType Get the type of this class.
ApiGradientStop
Name Description
GetClassType Get the type of this class.
ApiImage
Name Description
GetClassType Get the type of this class.
ApiNumbering
Name Description
GetClassType Get the type of this class.
GetLevel Get the specified level of the current numbering.
ApiNumberingLevel
Name Description
GetClassType Get the type of this class.
GetLevelIndex Get the level index.
GetNumbering Get the numbering definition.
GetParaPr The paragraph properties which are applied to any numbered paragraph that references the given numbering definition and numbering level.
GetTextPr Specify the text properties which will be applied to the text in the current numbering level itself, not to the text in the subsequent paragraph.
SetCustomType Set your own customized numbering type.
SetRestart Specify a one-based index which determines when a numbering level should restart to its starting value. A numbering level restarts when an instance of the specified numbering level, which will be higher (earlier than the this level) is used in the given document contents. By default this value is true.
SetStart Specify the starting value for the numbering used by the parent numbering level within a given numbering level definition. By default this value is 1.
SetSuff Specify the content which will be added between a given numbering level text and the text of every numbered paragraph which references that numbering level. By default this value is "tab".
SetTemplateType Set one of the existing predefined numbering templates.
ApiParagraph
Name Description
AddColumnBreak Add column break to the current position and start the next element from a new column.
AddDrawing Add an object (image, shape or chart) to the current paragraph.
AddElement Add an element to the current paragraph.
AddLineBreak Add line break to the current position and start the next element from a new line.
AddPageBreak Add page break and start the next element from the next page.
AddPageNumber Insert the number of the current document page into the paragraph.
AddPagesCount Insert the number of pages in the current document into the paragraph.
AddTabStop Add a tab stop to the current paragraph.
AddText Add some text to the element.
GetClassType Get the type of this class.
GetElement Get the element of the paragraph using the position specified.
GetElementsCount Get the number of elements in the current paragraph.
GetNumbering Get a numbering definition and numbering level for the numbered list.
GetParagraphMarkTextPr Get the text properties of the paragraph mark which is used to mark the paragraph end. The mark can also acquire common text properties like bold, italic, underline, etc.
GetParaPr Get paragraph properties.
RemoveAllElements Remove all elements from the current paragraph.
RemoveElement Remove the element using the position specified.
SetBetweenBorder Specify the border which will be displayed between each paragraph in a set of paragraphs which have the same set of paragraph border settings.
SetBottomBorder Specify the border which will be displayed below a set of paragraphs which have the same paragraph border settings.
SetContextualSpacing Specify that any space before or after this paragraph set using the spacing element ApiParaPr.SetSpacingBefore or ApiParaPr.SetSpacingAfter, should not be applied when the preceding and following paragraphs are of the same paragraph style, affecting the top and bottom spacing respectively.
SetIndFirstLine Set the paragraph first line indentation.
SetIndLeft Set the paragraph left side indentation.
SetIndRight Set the paragraph right side indentation.
SetJc Set paragraph contents justification.
SetKeepLines Specify that when rendering this document using a page view, all lines of this paragraph are maintained on a single page whenever possible.
SetKeepNext Specify that when rendering this document using a paginated view, the contents of this paragraph are at least partly rendered on the same page as the following paragraph whenever possible.
SetLeftBorder Specify the border which will be displayed at the left side of the page around the specified paragraph.
SetNumbering Specify that the current paragraph references a numbering definition instance in the current document.
SetNumPr Specify that the current paragraph references a numbering definition instance in the current document.
SetPageBreakBefore Specify that when rendering this document using a paginated view, the contents of this paragraph are rendered at the beginning of a new page in the document.
SetRightBorder Specify the border which will be displayed at the right side of the page around the specified paragraph.
SetShd Specify the shading applied to the contents of the paragraph.
SetSpacingAfter Set the spacing after the current paragraph. If the value of the isAfterAuto parameter is true, then any value of the nAfter is ignored. If isAfterAuto parameter is not specified, then it will be interpreted as false.
SetSpacingBefore Set the spacing before the current paragraph. If the value of the isBeforeAuto parameter is true, then any value of the nBefore is ignored. If isBeforeAuto parameter is not specified, then it will be interpreted as false.
SetSpacingLine Set the paragraph line spacing. If the value of the sLineRule parameter is either "atLeast" or "exact", then the value of nLine will be interpreted as twentieths of a point. If the value of the sLineRule parameter is "auto", then the value of the nLine parameter will be interpreted as 240ths of a line.
SetStyle Set paragraph style.
SetTabs Specify a sequence of custom tab stops which will be used for any tab characters in the current paragraph.
SetTopBorder Specify the border which will be displayed above a set of paragraphs which have the same set of paragraph border settings.
SetWidowControl Specify whether a single line of this paragraph will be prevented from being displayed on a separate page from the remaining content at display time by moving the line onto the following page.
ApiParaPr
Name Description
GetClassType Get the type of this class.
SetBetweenBorder Specify the border which will be displayed between each paragraph in a set of paragraphs which have the same set of paragraph border settings.
SetBottomBorder Specify the border which will be displayed below a set of paragraphs which have the same paragraph border settings.
SetContextualSpacing Specify that any space before or after this paragraph set using the spacing element ApiParaPr.SetSpacingBefore or ApiParaPr.SetSpacingAfter, should not be applied when the preceding and following paragraphs are of the same paragraph style, affecting the top and bottom spacing respectively.
SetIndFirstLine Set the paragraph first line indentation.
SetIndLeft Set the paragraph left side indentation.
SetIndRight Set the paragraph right side indentation.
SetJc Set paragraph contents justification.
SetKeepLines Specify that when rendering this document using a page view, all lines of this paragraph are maintained on a single page whenever possible.
SetKeepNext Specify that when rendering this document using a paginated view, the contents of this paragraph are at least partly rendered on the same page as the following paragraph whenever possible.
SetLeftBorder Specify the border which will be displayed at the left side of the page around the specified paragraph.
SetNumPr Specify that the current paragraph references a numbering definition instance in the current document.
SetPageBreakBefore Specify that when rendering this document using a paginated view, the contents of this paragraph are rendered at the beginning of a new page in the document.
SetRightBorder Specify the border which will be displayed at the right side of the page around the specified paragraph.
SetShd Specify the shading applied to the contents of the paragraph.
SetSpacingAfter Set the spacing after the current paragraph. If the value of the isAfterAuto parameter is true, then any value of the nAfter is ignored. If isAfterAuto parameter is not specified, then it will be interpreted as false.
SetSpacingBefore Set the spacing before the current paragraph. If the value of the isBeforeAuto parameter is true, then any value of the nBefore is ignored. If isBeforeAuto parameter is not specified, then it will be interpreted as false.
SetSpacingLine Set the paragraph line spacing. If the value of the sLineRule parameter is either "atLeast" or "exact", then the value of nLine will be interpreted as twentieths of a point. If the value of the sLineRule parameter is "auto", then the value of the nLine parameter will be interpreted as 240ths of a line.
SetStyle The paragraph style base method.
SetTabs Specify a sequence of custom tab stops which will be used for any tab characters in the current paragraph.
SetTopBorder Specify the border which will be displayed above a set of paragraphs which have the same set of paragraph border settings.
SetWidowControl Specify whether a single line of this paragraph will be prevented from being displayed on a separate page from the remaining content at display time by moving the line onto the following page.
ApiPresetColor
Name Description
GetClassType Get the type of this class.
ApiRGBColor
Name Description
GetClassType Get the type of this class.
ApiRun
Name Description
AddColumnBreak Add a column break to the current run position and start the next element from a new column.
AddDrawing Add an object (image, shape or chart) to the current text run.
AddLineBreak Add a line break to the current run position and start the next element from a new line.
AddPageBreak Add a page break and start the next element from a new page.
AddTabStop Add a tab stop to the current run.
AddText Add some text to this run.
ClearContent Remove all content from the current run.
GetClassType Get the type of this class.
GetTextPr Get the text properties of the current run.
SetBold Set the bold property to the text character.
SetCaps Specify that any lowercase characters in this text run are formatted for display only as their capital letter character equivalents.
SetColor Set the text color for the current text run in the RGB format.
SetDoubleStrikeout Specify that the contents of this run is displayed with two horizontal lines through each character displayed on the line.
SetFontFamily Set all 4 font slots with the specified font family.
SetFontSize Set the font size for the characters of the current text run.
SetHighlight Specify a highlighting color in the RGB format which is applied as a background for the contents of the current run.
SetItalic Set the italic property to the text character.
SetLanguage Specify the languages which will be used to check spelling and grammar (if requested) when processing the contents of this text run.
SetPosition Specify the amount by which text is raised or lowered for this run in relation to the default baseline of the surrounding non-positioned text.
SetShd Specify the shading applied to the contents of the current text run.
SetSmallCaps Specify that all small letter characters in this text run are formatted for display only as their capital letter character equivalents in a font size two points smaller than the actual font size specified for this text.
SetSpacing Set text spacing measured in twentieths of a point.
SetStrikeout Specify that the contents of this run are displayed with a single horizontal line through the center of the line.
SetStyle Specify the style of the text character display.
SetUnderline Specify that the contents of this run are displayed along with a line appearing directly below the character (less than all the spacing above and below the characters on the line).
SetVertAlign Specify the alignment which will be applied to the contents of this run in relation to the default appearance of the run text.
ApiSchemeColor
Name Description
GetClassType Get the type of this class.
ApiSection
Name Description
GetClassType Get the type of this class.
GetFooter Get the content for the specified footer type.
GetHeader Get the content for the specified header type.
RemoveFooter Remove the footer of the specified type from the current section. After removal the footer will be inherited from the previous section or, if this is the first section in the document, no footer of the specified type will be present.
RemoveHeader Remove the header of the specified type from the current section. After removal the header will be inherited from the previous section or, if this is the first section in the document, no header of the specified type will be present.
SetEqualColumns Specify that all text columns in the current section are of equal width.
SetFooterDistance Specify the distance from the bottom edge of the page to the bottom edge of the footer.
SetHeaderDistance Specify the distance from the top edge of the page to the top edge of the header.
SetNotEqualColumns Specify that all columns in the current section are of a different width. Number of columns is equal to the length of the aWidth array. The length of the aSpaces array MUST BE equal to (aWidth.length - 1).
SetPageMargins Specify the page margins for all pages in this section.
SetPageSize Specify the properties (size and orientation) for all pages in the current section.
SetTitlePage Specify whether the current section in this document have different header and footer for the section first page.
SetType Specify the type of the current section. The section type defines how the contents of the current section are placed relative to the previous section.
ApiShape
Name Description
GetClassType Get the type of this class.
GetDocContent Get the shape inner contents where a paragraph or text runs can be inserted.
SetVerticalTextAlign Set the vertical alignment for the shape content where a paragraph or text runs can be inserted.
ApiStroke
Name Description
GetClassType Get the type of this class.
ApiStyle
Name Description
GetClassType Get the type of this class.
GetConditionalTableStyle Get a set of formatting properties which will be conditionally applied to the parts of a table that match the requirement specified in the sType parameter.
GetName Get the name of the current style.
GetParaPr Get the paragraph properties of the current style.
GetTableCellPr Get the table cell properties for the current style.
GetTablePr Get the table properties of the current style.
GetTableRowPr Get the table row properties of the current style.
GetTextPr Get the text properties of the current style.
GetType Get the type of the current style.
SetBasedOn Specify the reference to the parent style which this style inherits from in the style hierarchy.
SetName Set the name of the current style.
ApiTable
Name Description
AddColumn Add a new column to the current table.
AddRow Add a new row to the current table.
GetClassType Get the type of this class.
GetRow Get the table row by its position in the table.
GetRowsCount Get the number of rows in the current table.
MergeCells Merge an array of cells. If the merge is done successfully it will return the resulting merged cell, otherwise the result will be "null".
RemoveColumn Remove the table column with a specified cell.
RemoveRow Remove the table row with a specified cell.
SetCellSpacing Specify the default table cell spacing (the spacing between adjacent cells and the edges of the table).
SetJc Specify the alignment of the current table with respect to the text margins in the current section.
SetShd Specify the shading which is applied to the extents of the current table.
SetStyle Set the style for the current table.
SetStyleColBandSize Specify the number of columns which will comprise each table column band for this table style.
SetStyleRowBandSize Specify the number of rows which will comprise each table row band for this table style.
SetTableBorderBottom Set the border which will be displayed at the bottom of the current table.
SetTableBorderInsideH Specify the border which will be displayed on all horizontal table cell borders which are not on an outmost edge of the parent table (all horizontal borders which are not the topmost or bottommost border).
SetTableBorderInsideV Specify the border which will be displayed on all vertical table cell borders which are not on an outmost edge of the parent table (all vertical borders which are not the leftmost or rightmost border).
SetTableBorderLeft Set the border which will be displayed on the left of the current table.
SetTableBorderRight Set the border which will be displayed on the right of the current table.
SetTableBorderTop Set the border which will be displayed at the top of the current table.
SetTableCellMarginBottom Specify the amount of space which will be left between the bottom extent of the cell contents and the border of all table cells within the parent table (or table row).
SetTableCellMarginLeft Specify the amount of space which will be present between the left extent of the cell contents and the left border of all table cells within the parent table (or table row).
SetTableCellMarginRight Specify the amount of space which will be present between the right extent of the cell contents and the right border of all table cells within the parent table (or table row).
SetTableCellMarginTop Specify the amount of space which will be present between the top extent of the cell contents and the top border of all table cells within the parent table (or table row).
SetTableInd Specify the indentation which will be added before the leading edge of the current table in the document (the left edge in a left-to-right table, and the right edge in a right-to-left table).
SetTableLayout Specify the algorithm which will be used to lay out the contents of this table within the document.
SetTableLook Specify the components of the conditional formatting of the referenced table style (if one exists) which will be applied to the set of table rows with the current table-level property exceptions. A table style can specify up to six different optional conditional formats, for example, different formatting for first column, which then can be applied or omitted from individual table rows in the parent table.
SetWidth Set the preferred width for this table.
ApiTableCell
Name Description
GetClassType Get the type of this class.
GetContent Get the cell content.
SetCellBorderBottom Set the border which will be displayed at the bottom of the current table cell.
SetCellBorderLeft Set the border which will be displayed to the left of the current table cell.
SetCellBorderRight Set the border which will be displayed to the right of the current table cell.
SetCellBorderTop Set the border which will be displayed at the top of the current table cell.
SetCellMarginBottom Specify the amount of space which will be left between the bottom extent of the cell contents and the border of a specific table cell within a table.
SetCellMarginLeft Specify the amount of space which will be left between the left extent of the cell contents and the border of a specific table cell within a table.
SetCellMarginRight Specify the amount of space which will be left between the right extent of the cell contents and the border of a specific table cell within a table.
SetCellMarginTop Specify the amount of space which will be left between the upper extent of the cell contents and the border of a specific table cell within a table.
SetNoWrap Specify how this table cell is laid out when the parent table is displayed in a document. This setting only affects the behavior of the cell when the SetTableLayout table layout for this table is set to use the "autofit" algorithm.
SetShd Specify the shading applied to the contents of the table cell.
SetTextDirection Specify the direction of the text flow for this table cell.
SetVerticalAlign Specify the vertical alignment for text contents within the current table cell.
SetWidth Set the preferred width for the current table cell.
ApiTableCellPr
Name Description
GetClassType Get the type of this class.
SetCellBorderBottom Set the border which will be displayed at the bottom of the current table cell.
SetCellBorderLeft Set the border which will be displayed to the left of the current table cell.
SetCellBorderRight Set the border which will be displayed to the right of the current table cell.
SetCellBorderTop Set the border which will be displayed at the top of the current table cell.
SetCellMarginBottom Specify the amount of space which will be left between the bottom extent of the cell contents and the border of a specific table cell within a table.
SetCellMarginLeft Specify the amount of space which will be left between the left extent of the cell contents and the border of a specific table cell within a table.
SetCellMarginRight Specify the amount of space which will be left between the right extent of the cell contents and the border of a specific table cell within a table.
SetCellMarginTop Specify the amount of space which will be left between the upper extent of the cell contents and the border of a specific table cell within a table.
SetNoWrap Specify how this table cell is laid out when the parent table is displayed in a document. This setting only affects the behavior of the cell when the SetTableLayout table layout for this table is set to use the "autofit" algorithm.
SetShd Specify the shading applied to the contents of the table cell.
SetTextDirection Specify the direction of the text flow for this table cell.
SetVerticalAlign Specify the vertical alignment for text contents within the current table cell.
SetWidth Set the preferred width for the current table cell.
ApiTablePr
Name Description
GetClassType Get the type of this class.
SetCellSpacing Specify the default table cell spacing (the spacing between adjacent cells and the edges of the table).
SetJc Specify the alignment of the current table with respect to the text margins in the current section.
SetShd Specify the shading which is applied to the extents of the current table.
SetStyleColBandSize Specify the number of columns which will comprise each table column band for this table style.
SetStyleRowBandSize Specify the number of rows which will comprise each table row band for this table style.
SetTableBorderBottom Set the border which will be displayed at the bottom of the current table.
SetTableBorderInsideH Specify the border which will be displayed on all horizontal table cell borders which are not on an outmost edge of the parent table (all horizontal borders which are not the topmost or bottommost border).
SetTableBorderInsideV Specify the border which will be displayed on all vertical table cell borders which are not on an outmost edge of the parent table (all vertical borders which are not the leftmost or rightmost border).
SetTableBorderLeft Set the border which will be displayed on the left of the current table.
SetTableBorderRight Set the border which will be displayed on the right of the current table.
SetTableBorderTop Set the border which will be displayed at the top of the current table.
SetTableCellMarginBottom Specify the amount of space which will be left between the bottom extent of the cell contents and the border of all table cells within the parent table (or table row).
SetTableCellMarginLeft Specify the amount of space which will be present between the left extent of the cell contents and the left border of all table cells within the parent table (or table row).
SetTableCellMarginRight Specify the amount of space which will be present between the right extent of the cell contents and the right border of all table cells within the parent table (or table row).
SetTableCellMarginTop Specify the amount of space which will be present between the top extent of the cell contents and the top border of all table cells within the parent table (or table row).
SetTableInd Specify the indentation which will be added before the leading edge of the current table in the document (the left edge in a left-to-right table, and the right edge in a right-to-left table).
SetTableLayout Specify the algorithm which will be used to lay out the contents of this table within the document.
SetWidth Set the preferred width for this table.
ApiTableRow
Name Description
GetCell Get the cell by its position.
GetCellsCount Get the number of cells in the current row.
GetClassType Get the type of this class.
SetHeight Set the height of the current table row within the current table.
SetTableHeader Specify that the current table row will be repeated at the top of each new page wherever this table is displayed. This gives this table row the behavior of a 'header' row on each of these pages. This element can be applied to any number of rows at the top of the table structure in order to generate multi-row table headers.
ApiTableRowPr
Name Description
GetClassType Get the type of this class.
SetHeight Set the height of the current table row within the current table.
SetTableHeader Specify that all the current table rows will be styled as its header row.
ApiTableStylePr
Name Description
GetClassType Get the type of this class.
GetParaPr Get the set of the paragraph properties which will be applied to all the paragraphs within a table which match the conditional formatting type.
GetTableCellPr Get the set of the table cell properties which will be applied to all the cells within a table which match the conditional formatting type.
GetTablePr Get the set of the table properties which will be applied to all the regions within a table which match the conditional formatting type.
GetTableRowPr Get the set of the table row properties which will be applied to all the rows within a table which match the conditional formatting type.
GetTextPr Get the set of the text run properties which will be applied to all the text runs within the table which match the conditional formatting type.
GetType Get the type of the current table conditional style.
ApiTextPr
Name Description
GetClassType Get the type of this class.
SetBold Set the bold property to the text character.
SetCaps Specify that any lowercase characters in this text run are formatted for display only as their capital letter character equivalents.
SetColor Set the text color for the current text run in the RGB format.
SetDoubleStrikeout Specify that the contents of this run is displayed with two horizontal lines through each character displayed on the line.
SetFontFamily Set all 4 font slots with the specified font family.
SetFontSize Set the font size for the characters of the current text run.
SetHighlight Specify a highlighting color in the RGB format which is applied as a background for the contents of the current run.
SetItalic Set the italic property to the text character.
SetLanguage Specify the languages which will be used to check spelling and grammar (if requested) when processing the contents of this text run.
SetPosition Specify the amount by which text is raised or lowered for this run in relation to the default baseline of the surrounding non-positioned text.
SetShd Specify the shading applied to the contents of the current text run.
SetSmallCaps Specify that all small letter characters in this text run are formatted for display only as their capital letter character equivalents in a font size two points smaller than the actual font size specified for this text.
SetSpacing Set text spacing measured in twentieths of a point.
SetStrikeout Specify that the contents of this run are displayed with a single horizontal line through the center of the line.
SetStyle The text style base method.
SetUnderline Specify that the contents of this run are displayed along with a line appearing directly below the character (less than all the spacing above and below the characters on the line).
SetVertAlign Specify the alignment which will be applied to the contents of this run in relation to the default appearance of the run text.
ApiUniColor
Name Description
GetClassType Get the type of this class.
ApiUnsupported
Name Description
GetClassType Get the type of this class.

Spreadsheet API

Api
Name Description
CreateBlipFill Create a blip fill which allows to fill the object using a selected image as the object background.
CreateBullet Create a bullet for a paragraph with the character or symbol specified with the sBullet parameter.
CreateColorByName Create a color selecting it from one of the available color presets.
CreateColorFromRGB Create an RGB color setting the appropriate values for the red, green and blue color components.
CreateGradientStop Create a gradient stop used for different types of gradients.
CreateLinearGradientFill Create a linear gradient fill which allows to fill the object using a selected linear gradient as the object background.
CreateNoFill Create no fill and remove the fill from the element.
CreateNumbering Create a bullet for a paragraph with the character or symbol specified with the sType parameter.
CreateParagraph Create a new paragraph.
CreatePatternFill Create a pattern fill which allows to fill the object using a selected pattern as the object background.
CreatePresetColor Create a color selecting it from one of the available color presets.
CreateRadialGradientFill Create a radial gradient fill which allows to fill the object using a selected radial gradient as the object background.
CreateRGBColor Create an RGB color setting the appropriate values for the red, green and blue color components.
CreateRun Create a new smaller text block to be inserted to the current paragraph or table.
CreateSchemeColor Create a complex color scheme selecting from one of the available schemes.
CreateSolidFill Create a solid fill which allows to fill the object using a selected solid color as the object background.
CreateStroke Create a stroke adding shadows to the element.
GetActiveSheet Get the object that represents the active sheet.
GetThemesColors Get the list of all available theme colors for the spreadsheet.
SetThemeColors Set the theme colors to the current spreadsheet.
ApiBullet
Name Description
GetClassType Get the type of this class.
ApiChart
Name Description
GetClassType Get the type of this class.
SetHorAxisOrientation Specifies the direction of the data displayed on the horizontal axis.
SetHorAxisTickLabelPosition Set the possible values for the position of the chart tick labels in relation to the main horizontal label or the values of the chart data.
SetHorAxisTitle Specify the horizontal axis chart title.
SetLegendPos Specify the chart legend position.
SetShowDataLabels Specifies which chart data labels are shown for the chart.
SetTitle Specify a chart title.
SetVerAxisOrientation Specifies the direction of the data displayed on the vertical axis.
SetVerAxisTitle Specify the vertical axis chart title.
SetVertAxisTickLabelPosition Set the possible values for the position of the chart tick labels in relation to the main vertical label or the values of the chart data.
ApiColor
Name Description
GetClassType Get the type of this class.
ApiDocumentContent
Name Description
AddElement Add paragraph or table using its position in the document.
GetClassType Get the type of the current class.
GetElement Get the element by its position in the document.
GetElementsCount Get the number of elements in the current document.
Push Push a paragraph or a table to actually add it to the document.
RemoveAllElements Remove all elements from the current document or from the current document element.
RemoveElement Remove element using the position specified.
ApiDrawing
Name Description
GetClassType Get the type of the class based on this base class.
SetPosition Change the position for the drawing object.
SetSize Set the size of the object (image, shape, chart) bounding box.
ApiFill
Name Description
GetClassType Get the type of this class.
ApiGradientStop
Name Description
GetClassType Get the type of this class.
ApiImage
Name Description
GetClassType Get the type of this class.
ApiParagraph
Name Description
AddElement Add an element to the current paragraph.
AddLineBreak Add line break to the current position and start the next element from a new line.
AddTabStop Add a tab stop to the current paragraph.
AddText Add some text to the element.
GetClassType Get the type of this class.
GetElement Get the element of the paragraph using the position specified.
GetElementsCount Get the number of elements in the current paragraph.
GetParaPr Get paragraph properties.
RemoveAllElements Remove all elements from the current paragraph.
RemoveElement Remove the element using the position specified.
SetBullet Set the bullet or numbering to the current paragraph.
SetIndFirstLine Set the paragraph first line indentation.
SetIndLeft Set the paragraph left side indentation.
SetIndRight Set the paragraph right side indentation.
SetJc Set paragraph contents justification.
SetSpacingAfter Set the spacing after the current paragraph. If the value of the isAfterAuto parameter is true, then any value of the nAfter is ignored. If isAfterAuto parameter is not specified, then it will be interpreted as false.
SetSpacingBefore Set the spacing before the current paragraph. If the value of the isBeforeAuto parameter is true, then any value of the nBefore is ignored. If isBeforeAuto parameter is not specified, then it will be interpreted as false.
SetSpacingLine Set the paragraph line spacing. If the value of the sLineRule parameter is either "atLeast" or "exact", then the value of nLine will be interpreted as twentieths of a point. If the value of the sLineRule parameter is "auto", then the value of the nLine parameter will be interpreted as 240ths of a line.
SetTabs Specify a sequence of custom tab stops which will be used for any tab characters in the current paragraph.
ApiParaPr
Name Description
GetClassType Get the type of this class.
SetBullet Set the bullet or numbering to the current paragraph.
SetIndFirstLine Set the paragraph first line indentation.
SetIndLeft Set the paragraph left side indentation.
SetIndRight Set the paragraph right side indentation.
SetJc Set paragraph contents justification.
SetSpacingAfter Set the spacing after the current paragraph. If the value of the isAfterAuto parameter is true, then any value of the nAfter is ignored. If isAfterAuto parameter is not specified, then it will be interpreted as false.
SetSpacingBefore Set the spacing before the current paragraph. If the value of the isBeforeAuto parameter is true, then any value of the nBefore is ignored. If isBeforeAuto parameter is not specified, then it will be interpreted as false.
SetSpacingLine Set the paragraph line spacing. If the value of the sLineRule parameter is either "atLeast" or "exact", then the value of nLine will be interpreted as twentieths of a point. If the value of the sLineRule parameter is "auto", then the value of the nLine parameter will be interpreted as 240ths of a line.
SetTabs Specify a sequence of custom tab stops which will be used for any tab characters in the current paragraph.
ApiPresetColor
Name Description
GetClassType Get the type of this class.
ApiRange
Name Description
GetCol Get the number of the column for the selected cell.
GetRow Get the number of the row for the selected cell.
Merge Merge the selected cell range into a single cell or a cell row.
SetAlignHorizontal Set the horizontal alignment of the text in the current cell range.
SetAlignVertical Set the vertical alignment of the text in the current cell range.
SetBold Set the bold property to the text characters in the current cell or cell range.
SetBorders Set the border to the cell/cell range with the parameters specified.
SetFillColor Set the background color for the current cell range with the previously created color object.
SetFontColor Set the text color for the current cell range in the RGB format.
SetFontName Set the specified font family as the font name for the current cell range.
SetFontSize Set the font size for the characters of the current cell range.
SetItalic Set the italic property to the text characters in the current cell or cell range.
SetNumberFormat Specifies whether the number in the cell should be treated like number, currency, date, time, etc. or just like text.
SetStrikeout Specify that the contents of the cell/cell range are displayed with a single horizontal line through the center of the line.
SetUnderline Specify that the contents of this cell/cell range are displayed along with a line appearing directly below the character.
SetValue Set the value for the current cell or a cell range.
SetWrap Specifies whether the words in the cell must be wrapped to fit the cell size or not.
UnMerge Split the selected merged cell range into single cells.
ApiRGBColor
Name Description
GetClassType Get the type of this class.
ApiRun
Name Description
AddLineBreak Add a line break to the current run position and start the next element from a new line.
AddTabStop Add a tab stop to the current run.
AddText Add some text to this run.
ClearContent Remove all content from the current run.
GetClassType Get the type of this class.
GetTextPr Get the text properties of the current run.
SetBold Set the bold property to the text character.
SetCaps Specify that any lowercase characters in this text run are formatted for display only as their capital letter character equivalents.
SetDoubleStrikeout Specify that the contents of this run is displayed with two horizontal lines through each character displayed on the line.
SetFill Set the text color for the current text run.
SetFontFamily Set all 4 font slots with the specified font family.
SetFontSize Set the font size for the characters of the current text run.
SetItalic Set the italic property to the text character.
SetSmallCaps Specify that all small letter characters in this text run are formatted for display only as their capital letter character equivalents in a font size two points smaller than the actual font size specified for this text.
SetSpacing Set text spacing measured in twentieths of a point.
SetStrikeout Specify that the contents of this run are displayed with a single horizontal line through the center of the line.
SetUnderline Specify that the contents of this run are displayed along with a line appearing directly below the character (less than all the spacing above and below the characters on the line).
SetVertAlign Specify the alignment which will be applied to the contents of this run in relation to the default appearance of the run text.
ApiSchemeColor
Name Description
GetClassType Get the type of this class.
ApiShape
Name Description
GetClassType Get the type of this class.
GetDocContent Get the shape inner contents where a paragraph or text runs can be inserted.
SetVerticalTextAlign Set the vertical alignment for the shape content where a paragraph or text runs can be inserted.
ApiStroke
Name Description
GetClassType Get the type of this class.
ApiTextPr
Name Description
GetClassType Get the type of this class.
SetBold Set the bold property to the text character.
SetCaps Specify that any lowercase characters in this text run are formatted for display only as their capital letter character equivalents.
SetDoubleStrikeout Specify that the contents of this run is displayed with two horizontal lines through each character displayed on the line.
SetFill Set the text color for the current text run.
SetFontFamily Set all 4 font slots with the specified font family.
SetFontSize Set the font size for the characters of the current text run.
SetItalic Set the italic property to the text character.
SetSmallCaps Specify that all small letter characters in this text run are formatted for display only as their capital letter character equivalents in a font size two points smaller than the actual font size specified for this text.
SetSpacing Set text spacing measured in twentieths of a point.
SetStrikeout Specify that the contents of this run are displayed with a single horizontal line through the center of the line.
SetUnderline Specify that the contents of this run are displayed along with a line appearing directly below the character (less than all the spacing above and below the characters on the line).
SetVertAlign Specify the alignment which will be applied to the contents of this run in relation to the default appearance of the run text.
ApiUniColor
Name Description
GetClassType Get the type of this class.
ApiWorksheet
Name Description
AddChart Create a chart of the set type from the selected data range of the current sheet.
AddImage Adds the image to the current sheet with the parameters specified.
AddShape Adds the shape to the current sheet with the parameters specified.
FormatAsTable Format the selected range of cells from the current sheet as a table (with the first row formatted as a header).
GetRange Returns an object that represents the selected range of the current sheet. Can be a single cell - A1, or cells from a single row - A1:E1, or cells from a single column - A1:A10, or cells from several rows and columns - A1:E10.
GetRangeByNumber Returns an object that represents the selected range of the current sheet using the row/column coordinates for the cell selection.
SetColumnWidth Set the width to the selected column of the current active sheet. The width is equal to the set number multiplied by 7 pixels - so if you set the width to 10 it will be equal to 70 pixels.
SetDisplayGridlines Specifies whether the current sheet gridlines must be displayed or not.
SetDisplayHeadings Specifies whether the current sheet row/column headers must be displayed or not.
SetName Set a name to the current active sheet.

Presentation API

Api
Name Description
CreateBlipFill Create a blip fill which allows to fill the object using a selected image as the object background.
CreateBullet Create a bullet for a paragraph with the character or symbol specified with the sBullet parameter.
CreateChart Create a chart with the parameters specified.
CreateGradientStop Create a gradient stop used for different types of gradients.
CreateImage Create an image with the parameters specified.
CreateLinearGradientFill Create a linear gradient fill which allows to fill the object using a selected linear gradient as the object background.
CreateNoFill Create no fill and remove the fill from the element.
CreateNumbering Create a bullet for a paragraph with the character or symbol specified with the sType parameter.
CreateParagraph Create a new paragraph.
CreatePatternFill Create a pattern fill which allows to fill the object using a selected pattern as the object background.
CreatePresetColor Create a color selecting it from one of the available color presets.
CreateRadialGradientFill Create a radial gradient fill which allows to fill the object using a selected radial gradient as the object background.
CreateRGBColor Create an RGB color setting the appropriate values for the red, green and blue color components.
CreateRun Create a new smaller text block to be inserted to the current paragraph or table.
CreateSchemeColor Create a complex color scheme selecting from one of the available schemes.
CreateShape Create a shape with the parameters specified.
CreateSlide Create a new slide.
CreateSolidFill Create a solid fill which allows to fill the object using a selected solid color as the object background.
CreateStroke Create a stroke adding shadows to the element.
GetPresentation Get the main presentation.
ApiBullet
Name Description
GetClassType Get the type of this class.
ApiChart
Name Description
GetClassType Get the type of this class.
SetHorAxisTitle Specify the horizontal axis chart title.
SetLegendPos Specify the chart legend position.
SetShowDataLabels Specifies which chart data labels are shown for the chart.
SetTitle Specify a chart title.
SetVerAxisTitle Specify the vertical axis chart title.
ApiDocumentContent
Name Description
AddElement Add paragraph or table using its position in the document.
GetClassType Get the type of the current class.
GetElement Get the element by its position in the document.
GetElementsCount Get the number of elements in the current document.
Push Push a paragraph or a table to actually add it to the document.
RemoveAllElements Remove all elements from the current document or from the current document element.
RemoveElement Remove element using the position specified.
ApiDrawing
Name Description
GetClassType Get the type of the class based on this base class.
SetPosition Set the position of the drawing on the slide.
SetSize Set the size of the object (image, shape, chart) bounding box.
ApiFill
Name Description
GetClassType Get the type of this class.
ApiGradientStop
Name Description
GetClassType Get the type of this class.
ApiImage
Name Description
GetClassType Get the type of this class.
ApiParagraph
Name Description
AddElement Add an element to the current paragraph.
AddLineBreak Add line break to the current position and start the next element from a new line.
AddTabStop Add a tab stop to the current paragraph.
AddText Add some text to the element.
GetClassType Get the type of this class.
GetElement Get the element of the paragraph using the position specified.
GetElementsCount Get the number of elements in the current paragraph.
GetParaPr Get paragraph properties.
RemoveAllElements Remove all elements from the current paragraph.
RemoveElement Remove the element using the position specified.
SetBullet Set the bullet or numbering to the current paragraph.
SetIndFirstLine Set the paragraph first line indentation.
SetIndLeft Set the paragraph left side indentation.
SetIndRight Set the paragraph right side indentation.
SetJc Set paragraph contents justification.
SetSpacingAfter Set the spacing after the current paragraph. If the value of the isAfterAuto parameter is true, then any value of the nAfter is ignored. If isAfterAuto parameter is not specified, then it will be interpreted as false.
SetSpacingBefore Set the spacing before the current paragraph. If the value of the isBeforeAuto parameter is true, then any value of the nBefore is ignored. If isBeforeAuto parameter is not specified, then it will be interpreted as false.
SetSpacingLine Set the paragraph line spacing. If the value of the sLineRule parameter is either "atLeast" or "exact", then the value of nLine will be interpreted as twentieths of a point. If the value of the sLineRule parameter is "auto", then the value of the nLine parameter will be interpreted as 240ths of a line.
SetTabs Specify a sequence of custom tab stops which will be used for any tab characters in the current paragraph.
ApiParaPr
Name Description
GetClassType Get the type of this class.
SetBullet Set the bullet or numbering to the current paragraph.
SetIndFirstLine Set the paragraph first line indentation.
SetIndLeft Set the paragraph left side indentation.
SetIndRight Set the paragraph right side indentation.
SetJc Set paragraph contents justification.
SetSpacingAfter Set the spacing after the current paragraph. If the value of the isAfterAuto parameter is true, then any value of the nAfter is ignored. If isAfterAuto parameter is not specified, then it will be interpreted as false.
SetSpacingBefore Set the spacing before the current paragraph. If the value of the isBeforeAuto parameter is true, then any value of the nBefore is ignored. If isBeforeAuto parameter is not specified, then it will be interpreted as false.
SetSpacingLine Set the paragraph line spacing. If the value of the sLineRule parameter is either "atLeast" or "exact", then the value of nLine will be interpreted as twentieths of a point. If the value of the sLineRule parameter is "auto", then the value of the nLine parameter will be interpreted as 240ths of a line.
SetTabs Specify a sequence of custom tab stops which will be used for any tab characters in the current paragraph.
ApiPresentation
Name Description
AddSlide Append a new slide to the end of the presentation.
GetClassType Get the type of this class.
GetCurSlideIndex Get the index for the current slide.
GetCurrentSlide Get the current slide.
GetSlideByIndex Get the slide by its position in the presentation.
SetSizes Set the size for the current presentation.
ApiPresetColor
Name Description
GetClassType Get the type of this class.
ApiRGBColor
Name Description
GetClassType Get the type of this class.
ApiRun
Name Description
AddLineBreak Add a line break to the current run position and start the next element from a new line.
AddTabStop Add a tab stop to the current run.
AddText Add some text to this run.
ClearContent Remove all content from the current run.
GetClassType Get the type of this class.
GetTextPr Get the text properties of the current run.
SetBold Set the bold property to the text character.
SetCaps Specify that any lowercase characters in this text run are formatted for display only as their capital letter character equivalents.
SetDoubleStrikeout Specify that the contents of this run is displayed with two horizontal lines through each character displayed on the line.
SetFill Set the text color for the current text run.
SetFontFamily Set all 4 font slots with the specified font family.
SetFontSize Set the font size for the characters of the current text run.
SetItalic Set the italic property to the text character.
SetSmallCaps Specify that all small letter characters in this text run are formatted for display only as their capital letter character equivalents in a font size two points smaller than the actual font size specified for this text.
SetSpacing Set text spacing measured in twentieths of a point.
SetStrikeout Specify that the contents of this run are displayed with a single horizontal line through the center of the line.
SetUnderline Specify that the contents of this run are displayed along with a line appearing directly below the character (less than all the spacing above and below the characters on the line).
SetVertAlign Specify the alignment which will be applied to the contents of this run in relation to the default appearance of the run text.
ApiSchemeColor
Name Description
GetClassType Get the type of this class.
ApiShape
Name Description
GetClassType Get the type of this class.
GetDocContent Get the shape inner contents where a paragraph or text runs can be inserted.
SetVerticalTextAlign Set the vertical alignment for the shape content where a paragraph or text runs can be inserted.
ApiSlide
Name Description
AddObject Add an object (image, shape or chart) to the current presentation slide.
GetClassType Get the type of this class.
GetHeight Get the slide height in English measure units.
GetWidth Get the slide width in English measure units.
RemoveAllObjects Remove all the objects from the current slide.
SetBackground Set the background to the current presentation slide.
ApiStroke
Name Description
GetClassType Get the type of this class.
ApiTextPr
Name Description
GetClassType Get the type of this class.
SetBold Set the bold property to the text character.
SetCaps Specify that any lowercase characters in this text run are formatted for display only as their capital letter character equivalents.
SetDoubleStrikeout Specify that the contents of this run is displayed with two horizontal lines through each character displayed on the line.
SetFill Set the text color for the current text run.
SetFontFamily Set all 4 font slots with the specified font family.
SetFontSize Set the font size for the characters of the current text run.
SetItalic Set the italic property to the text character.
SetSmallCaps Specify that all small letter characters in this text run are formatted for display only as their capital letter character equivalents in a font size two points smaller than the actual font size specified for this text.
SetSpacing Set text spacing measured in twentieths of a point.
SetStrikeout Specify that the contents of this run are displayed with a single horizontal line through the center of the line.
SetUnderline Specify that the contents of this run are displayed along with a line appearing directly below the character (less than all the spacing above and below the characters on the line).
SetVertAlign Specify the alignment which will be applied to the contents of this run in relation to the default appearance of the run text.
ApiUniColor
Name Description
GetClassType Get the type of this class.
Global