Get Started
Usage API
More information

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
AddComment

Add a comment to the desired element or array of Runs.

CreateBlipFill

Create a blip fill to apply to the object using a selected image as the object background.

CreateBlockLvlSdt

Create a new block level container.

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.

CreateHyperlink

Create a new hyperlink text block to be inserted to the current paragraph or table.

CreateImage

Create an image with the parameters specified.

CreateInlineLvlSdt

Create a new inline container.

CreateLinearGradientFill

Create a linear gradient fill to apply to 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 to apply 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 to apply to the object using a selected radial gradient as the object background.

CreateRange

Create an element range. If you do not specify the start and end positions, the range will be taken from the entire element.

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 to apply to 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.

GetMailMergeReceptionsCount

Get the mail merge receptions count.

GetMailMergeTemplateDocContent

Get the mail merge template document.

LoadMailMergeData

Load data for the mail merge.

MailMerge

Start the mail merge process.

ReplaceDocumentContent

Replace the main document content with another document content.

ReplaceTextSmart

Replaces each paragraph(or text in cell) in the select with the corresponding text from an array of strings.

Save

Save changes to the specified document.

ApiBlockLvlSdt
Name Description
AddElement

Add a paragraph or a table or a blocklvl content control to the document.

AddText

Add a text to the current content control.

Delete

Remove content control and content. If keepContent is true, the content is not deleted.

GetAlias

Get the alias attribute for this container.

GetAllContentControls

Get the collection of content control objects in the content control.

GetAllDrawingObjects

Get the collection of drawing objects in the document.

GetAllParagraphs

Get a collection of paragraph objects in a content control.

GetAllTablesOnPage

Get a collection of tables on a given absolute page. This method can be a little bit slow, because it runs the document calculation process to arrange tables on the specified page.

GetClassType

Get the type of this class.

GetContent

Get the content of this container.

GetLabel

Get the label attribute for this container.

GetLock

Get the lock type of this container.

GetParentContentControl

Get the content control that contains the current content control.

GetParentTable

Get the table that contains the content control.

GetParentTableCell

Get the table cell that contains the content control.

GetRange

Return a Range object that represents the part of the document contained in the specified content control.

GetTag

Get the tag attribute for this container.

Push

Push a paragraph or a table or BlockLvl content control to actually add it to the document.

RemoveAllElements

Clear the contents from a content control.

Search

Search for the scope of a content control object. The search results are a collection of ApiRange objects.

Select

Select a content control.

SetAlias

Set the alias attribute for this container.

SetLabel

Set the label attribute for this container.

SetLock

Set the lock to the current inline text content control. "contentLocked" - content cannot be edited. "sdtContentLocked" - content cannot be edited and BlockLvlSdt cannot be deleted. "sdtLocked" - BlockLvlSdt cannot be deleted.

SetTag

Set the tag attribute for this container.

SetTextPr

Apply text settings to content of content control.

ApiBullet
Name Description
GetClassType

Get the type of this class.

ApiChart
Name Description
GetClassType

Get the type of this class.

GetNextChart

Get the next inline chart.

GetPrevChart

Get the previous inline chart.

SetHorAxisLablesFontSize

Specify font size for labels of horizontal axis.

SetHorAxisMajorTickMark

Specify major tick mark for horizontal axis.

SetHorAxisMinorTickMark

Specify minor tick mark for horizontal axis.

SetHorAxisOrientation

Specify a horizontal axis orientation.

SetHorAxisTickLabelPosition

Spicify tick labels position for horizontal axis.

SetHorAxisTitle

Specify the chart horizontal axis title.

SetLegendFontSize

Specify a legend font size.

SetLegendPos

Specify the chart legend position.

SetMajorHorizontalGridlines

Specify major horizontal gridline's visual properties.

SetMajorVerticalGridlines

Specify major vertical gridline's visual properties.

SetMinorHorizontalGridlines

Specify minor vertical gridline's visual properties.

SetMinorVerticalGridlines

Specify minor vertical gridline's visual properties.

SetShowDataLabels

Specify which chart data labels are shown for the chart.

SetShowPointDataLabel

Spicify the show options for data labels

SetTitle

Specify the chart title.

SetVerAxisOrientation

Specify a vertical axis orientation.

SetVerAxisTitle

Specify the chart vertical axis title.

SetVertAxisLablesFontSize

Specify font size for labels of vertical axis.

SetVertAxisMajorTickMark

Specify major tick mark for vertical axis.

SetVertAxisMinorTickMark

Specify minor tick mark for vertical axis.

SetVertAxisTickLabelPosition

Spicify tick labels position for vertical axis.

ApiDocument
Name Description
AddComment

Add a comment to the document.

AddElement

Add a paragraph or a table or a blockLvl content control using its position in the document content.

CreateNewHistoryPoint

Create new history point.

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.

DeleteBookmark

Remove a bookmark from the document, if one exists.

GetAllCharts

Get the collection of chart objects in the document.

GetAllContentControls

Get the list of all the content controls in the document.

GetAllDrawingObjects

Get the collection of drawing objects in the document.

GetAllImages

Get the collection of image objects in the document.

GetAllShapes

Get the collection of shape objects in the document.

GetAllTablesOnPage

Get the collection of tables on a given absolute page. This method can be a little bit slow, because it runs the document calculation process to arrange tables on the specified page.

GetBookmarkRange

Get a bookmark's range.

GetClassType

Get the type of this class.

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.

GetRange

Return a Range object that represents the part of the document contained in the specified document.

GetRangeBySelect

Get a range object by the current selection.

GetReviewReport

Get a report about every change which was made to the document in the review mode.

GetSections

Get the collection of section objects in the document.

GetStyle

Get a style by the style name.

InsertContent

Insert an array of elements into the current position of the document.

InsertWatermark

Insert a watermark on each document page.

IsTrackRevisions

Check if change tracking mode is enabled or not.

Last

Get the last document element.

Push

Push a paragraph or a table to actually add it to the document.

RemoveAllElements

Remove all the elements from the current document or from the current document element. When all elements are removed, a new empty paragraph is automatically created. If you want to add content to this paragraph, use the ApiDocumentContent.GetElement method.

RemoveElement

Remove element using the position specified.

RemoveSelection

Remove current selection.

Search

Search for the scope of a document object. The search results are a collection of ApiRange objects.

SearchAndReplace

Find and replace text.

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

SetTrackRevisions

Set change tracking mode.

ApiDocumentContent
Name Description
AddElement

Add a paragraph or a table or a blockLvl content control using its position in the document content.

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.

GetRange

Return a Range object that represents the part of the document contained in the document content.

Push

Push a paragraph or a table to actually add it to the document.

RemoveAllElements

Remove all the elements from the current document or from the current document element. When all elements are removed, a new empty paragraph is automatically created. If you want to add content to this paragraph, use the ApiDocumentContent.GetElement method.

RemoveElement

Remove element using the position specified.

ApiDrawing
Name Description
AddBreak

Insert a break at the specified location in the main document.

Copy

Copy the graphic object.

Delete

Delete the graphic object.

Fill

Set the fill formatting properties for the specified graphic object.

GetClassType

Get the type of the class based on this base class.

GetNextDrawing

Get the next inline drawing object.

GetParentContentControl

Get the parent content control that contains the graphic object.

GetParentParagraph

Get the parent paragraph that contains the graphic object.

GetParentTable

Get the parent table that contains the graphic object.

GetParentTableCell

Get the parent table cell that contains the graphic object.

GetPrevDrawing

Get the previous inline drawing object.

InsertInContentControl

Wrap the graphic object with a rich text content control.

InsertParagraph

Insert a paragraph at the specified position.

ScaleHeight

Scale the height of the figure using the specified coefficient.

ScaleWidth

Scale the width of the graphic object using the specified coefficient.

Select

Select the graphic object.

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.

SetHorFlip

Horizontal reflection.

SetHorPosition

Set an absolute measurement for the horizontal positioning of the floating object.

SetOutLine

Set the outline properties for the specified graphic 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.

SetVertFlip

Vertical reflection.

SetWrappingStyle

Set the wrapping type of this object (image, shape, chart). One of the following wrapping style types can be set:

  • "inline" - the object is considered to be a part of the text, like a character, so when the text moves, the object moves as well. In this case the positioning options are inaccessible. If one of the following styles is selected, the object can be moved independently of the text and positioned on the page exactly:
  • "square" - the text wraps the rectangular box that bounds the object.
  • "tight" - the text wraps the actual object edges.
  • "through" - the text wraps around the object edges and fills in the open white space within the object.
  • "topAndBottom" - the text is only above and below the object.
  • "behind" - the text overlaps the object.
  • "inFront" - the object overlaps the text.
ApiFill
Name Description
GetClassType

Get the type of this class.

ApiGradientStop
Name Description
GetClassType

Get the type of this class.

ApiHyperlink
Name Description
GetClassType

Get the type of this class.

GetDisplayedText

Get the hyperlink display text.

GetElement

Get the hyperlink element using the position specified.

GetElementsCount

Get the number of elements in the current hyperlink.

GetLinkedText

Get the hyperlink address.

GetRange

Return a Range object that represents the document part contained in the specified hyperlink.

GetScreenTipText

Get the screen tip text of the hyperlink.

SetDefaultStyle

Set default hyperlink style.

SetDisplayedText

Set the hyperlink display text.

SetLink

Set the hyperlink address.

SetScreenTipText

Set the screen tip text of the hyperlink.

ApiImage
Name Description
GetClassType

Get the type of this class.

GetNextImage

Get the next inline image.

GetPrevImage

Get the previous inline image.

ApiInlineLvlSdt
Name Description
AddElement

Add an element to the inline text content control.

AddText

Add text to the current content control.

Copy

Create a copy of an inline content control. Ingonore comments, footnote references, complex fields.

Delete

Remove content control and content. If keepContent is true, the content is not deleted.

GetAlias

Get the alias attribute for this container.

GetClassType

Get the type of this class.

GetElement

Get the element of the current inline text content control using the position specified.

GetElementsCount

Get the number of elements in the current inline text content control. The text content control is created with one text run present in it by default, so even without any element added this method will return the value of '1'.

GetLabel

Get the label attribute for this container.

GetLock

Get the lock type of this container.

GetParentContentControl

Get the content control that contains the current content control.

GetParentTable

Get the table that contains the content control.

GetParentTableCell

Get the table cell that contains the content control.

GetRange

Return a Range object that represents the part of the document contained in the specified content control.

GetTag

Get the tag attribute for this container.

Push

Add an element to the end of inline text content control.

RemoveAllElements

Remove all the elements from the current inline text content control.

RemoveElement

Remove the element using the position specified from the current inline text content control.

SetAlias

Set the alias attribute for this container.

SetLabel

Add a string label to the current inline text content control.

SetLock

Set the lock to the current inline text content control. "contentLocked" - content cannot be edited. "sdtContentLocked" - content cannot be edited and BlockLvlSdt cannot be deleted. "sdtLocked" - BlockLvlSdt cannot be deleted.

SetTag

Add a string tag to the current inline text content control.

SetTextPr

Apply text settings to content of content control.

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. To change the text style for the paragraph, a style must be applied to it using the ApiRun.SetStyle method.

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.

AddComment

Add a comment to the paragraph.

AddDrawing

Add a drawing object (image, shape or chart) to the current paragraph.

AddElement

Add an element to the current paragraph.

AddHyperlink

Add a hyperlink to a paragraph.

AddInlineLvlSdt

Add an inline container.

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. This method works for the paragraphs in the document header/footer only.

AddPagesCount

Insert the number of pages in the current document into the paragraph. This method works for the paragraphs in the document header/footer only.

AddTabStop

Add a tab stop to the current paragraph.

AddText

Add some text to the element.

Copy

Create a paragraph copy. Ingnore comments, footnote references, complex fields.

Delete

Delete current paragraph.

GetAllCharts

Get the collection of chart objects in the paragraph.

GetAllContentControls

Get the collection of content control objects in the paragraph.

GetAllDrawingObjects

Get the collection of drawing objects in the paragraph.

GetAllImages

Get the collection of image objects in the paragraph.

GetAllShapes

Get the collection of shape objects in the paragraph.

GetClassType

Get the type of this class.

GetElement

Get the paragraph element using the position specified.

GetElementsCount

Get the number of elements in the current paragraph.

GetIndFirstLine

Get the paragraph first line indentation.

GetIndLeft

Get the paragraph left side indentation.

GetIndRight

Get the paragraph right side indentation.

GetJc

Get paragraph contents justification.

GetLastRunWithText

Get the last Run with text in the current paragraph.

GetNext

Get the next 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.

GetParentContentControl

Get the content control that contains the paragraph.

GetParentTable

Get the table that contains the paragraph.

GetParentTableCell

Get the table cell that contains the paragraph.

GetPrevious

Get the previous paragraph.

GetRange

Return a Range object that represents the part of the document contained in the specified paragraph.

GetShd

Get the shading applied to the contents of the paragraph.

GetSpacingAfter

Get the spacing after value of the current paragraph.

GetSpacingBefore

Get the spacing before value of the current paragraph.

GetSpacingLineRule

Get the paragraph line spacing rule.

GetSpacingLineValue

Get the paragraph line spacing value.

GetStyle

Get the paragraph style method.

GetText

Get paragraph text.

GetTextPr

Get paragraph text properties.

InsertInContentControl

Wrap the paragraph object with a rich text content control.

InsertParagraph

Insert a paragraph at the specified position.

Last

Get the last no empty element of the paragraph.

Push

Add an element to the current paragraph.

RemoveAllElements

Remove all the elements from the current paragraph. When all the elements are removed from the paragraph, a new empty run is automatically created. If you want to add content to this run, use the ApiParagraph.GetElement method.

RemoveElement

Remove the element using the position specified. If the element you remove is the last paragraph element (i.e. all the elements are removed from the paragraph), a new empty run is automatically created. If you want to add content to this run, use the ApiParagraph.GetElement method.

Search

Search for the scope of a paragraph object. The search results are a collection of ApiRange objects.

Select

Select a paragraph.

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.

SetBold

Set the bold property to the text character.

SetBottomBorder

Specify the border which will be displayed below a set of paragraphs which have the same paragraph border settings. The paragraphs of the same style going one by one are considered as a single block, so the border is added to the whole block rather than to every paragraph in this block.

SetBullet

Set the bullet or numbering to the current paragraph.

SetCaps

Specify that any lowercase characters in this paragraph are formatted for display only as their capital letter character equivalents.

SetColor

Set the text color for the current paragraph in the RGB format.

SetContextualSpacing

Specify that any space before or after this paragraph set using the ApiParaPr.SetSpacingBefore or ApiParaPr.SetSpacingAfter spacing element, should not be applied when the preceding and following paragraphs are of the same paragraph style, affecting the top and bottom spacing respectively.

SetDoubleStrikeout

Specify that the contents of this paragraph are 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 paragraph.

SetHighlight

Specify a highlighting color in the RGB format which is applied as a background for the contents of the current paragraph.

SetIndFirstLine

Set the paragraph first line indentation.

SetIndLeft

Set the paragraph left side indentation.

SetIndRight

Set the paragraph right side indentation.

SetItalic

Set the italic property to the text character.

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.

SetPosition

Specify the amount by which text is raised or lowered for this paragraph in relation to the default baseline of the surrounding non-positioned text.

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 current paragraph.

SetSmallCaps

Specify that all the small letter characters in this paragraph are formatted for display only as their capital letter character equivalents which are two points smaller than the actual font size specified for this text.

SetSpacing

Set text spacing measured in twentieths of a point.

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.

SetStrikeout

Specify that the contents of this paragraph are displayed with a single horizontal line through the center of the line.

SetStyle

The paragraph style base method. This method is not used by itself, as it only forms the basis for the ApiParagraph.SetStyle method which sets the selected or created style for the paragraph.

SetTabs

Specify a sequence of custom tab stops which will be used for any tab characters in the current paragraph. Warning: The lengths of aPos array and aVal array MUST BE equal to each other.

SetTextPr

Set paragraph text properties.

SetTopBorder

Specify the border which will be displayed above a set of paragraphs which have the same set of paragraph border settings. The paragraphs of the same style going one by one are considered as a single block, so the border is added to the whole block rather than to every paragraph in this block.

SetUnderline

Specify that the contents of this paragraph 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 paragraph in relation to the default appearance of the paragraph text:

  • "baseline" - the characters in the current paragraph will be aligned by the default text baseline.
  • "subscript" - the characters in the current paragraph will be aligned below the default text baseline.
  • "superscript" - the characters in the current paragraph will be aligned above the default text baseline.
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.

WrapInMailMergeField

Wrap paragraph content in a mail merge field.

ApiParaPr
Name Description
GetClassType

Get the type of this class.

GetIndFirstLine

Get the paragraph first line indentation.

GetIndLeft

Get the paragraph left side indentation.

GetIndRight

Get the paragraph right side indentation.

GetJc

Get paragraph contents justification.

GetShd

Get the shading applied to the contents of the paragraph.

GetSpacingAfter

Get the spacing after value of the current paragraph.

GetSpacingBefore

Get the spacing before value of the current paragraph.

GetSpacingLineRule

Get the paragraph line spacing rule.

GetSpacingLineValue

Get the paragraph line spacing value.

GetStyle

Get the paragraph style method.

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. The paragraphs of the same style going one by one are considered as a single block, so the border is added to the whole block rather than to every paragraph in this block.

SetBullet

Set the bullet or numbering to the current paragraph.

SetContextualSpacing

Specify that any space before or after this paragraph set using the ApiParaPr.SetSpacingBefore or ApiParaPr.SetSpacingAfter spacing element, 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. This method is not used by itself, as it only forms the basis for the ApiParagraph.SetStyle method which sets the selected or created style for the paragraph.

SetTabs

Specify a sequence of custom tab stops which will be used for any tab characters in the current paragraph. Warning: The lengths of aPos array and aVal array MUST BE equal to each other.

SetTopBorder

Specify the border which will be displayed above a set of paragraphs which have the same set of paragraph border settings. The paragraphs of the same style going one by one are considered as a single block, so the border is added to the whole block rather than to every paragraph in this block.

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.

ApiRange
Name Description
AddBookmark

Add the bookmark to the specified range.

AddHyperlink

Add a hyperlink to the specified range.

AddText

Add text to the specified position.

Delete

Delete all the contents from the current range.

ExpandTo

Return a new range that goes beyond the specified range in any direction and spans a different range. The current range has not changed. Throws an error if two ranges do not have a union.

GetAllParagraphs

Get a collection of paragraphs that represents all the paragraphs in the specified range.

GetClassType

Get the type of this class.

GetParagraph

Get a paragraph from all the paragraphs that are in the range.

GetText

Get text from the specified range.

IntersectWith

Return a new range as the intersection of this range with another range. The current range has not changed. Throws an error if two ranges do not overlap or are not adjacent.

Select

Set the selection to the specified range.

SetBold

Set the bold property to the text character.

SetCaps

Specify that any lowercase characters in this text Range are formatted for display only as their capital letter character equivalents.

SetColor

Set the text color for the current text Range in the RGB format.

SetDoubleStrikeout

Specify that the contents of this Range are 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 Range.

SetHighlight

Specify a highlighting color in the RGB format which is applied as a background for the contents of the current Range.

SetItalic

Set the italic property to the text character.

SetPosition

Specify the amount by which text is raised or lowered for this Range in relation to the default baseline of the surrounding non-positioned text.

SetShd

Specify the shading applied to the contents of the current text Range.

SetSmallCaps

Specify that all the small letter characters in this text Range are formatted for display only as their capital letter character equivalents which are 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 Range are displayed with a single horizontal line through the range center.

SetStyle

Set the style for the current Range.

SetTextPr

Set the text properties for the current Range.

SetUnderline

Specify that the contents of this Range 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 Range contents in relation to the default appearance of the Range text:

  • "baseline" - the characters in the current text Range will be aligned by the default text baseline.
  • "subscript" - the characters in the current text Range will be aligned below the default text baseline.
  • "superscript" - the characters in the current text Range will be aligned above the default text baseline.
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 a drawing object (image, shape or chart) to the current text run.

AddHyperlink

Add a hyperlink to a 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

Clear content from the current run.

Copy

Create a copy of the run.

Delete

Delete current run.

GetClassType

Get the type of this class.

GetParentContentControl

Get the content control that contains the run.

GetParentTable

Get the table that contains the run.

GetParentTableCell

Get the table cell that contains the run.

GetRange

Return a Range object that represents the part of the document contained in the specified run.

GetTextPr

Get the text properties of the current run.

RemoveAllElements

Remove all the elements from the current run.

Select

Select a 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 are 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.

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 the small letter characters in this text run are formatted for display only as their capital letter character equivalents which are 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

Set style for the current Run.

SetTextPr

Set the text properties for the current run.

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:

  • "baseline" - the characters in the current text run will be aligned by the default text baseline.
  • "subscript" - the characters in the current text run will be aligned below the default text baseline.
  • "superscript" - the characters in the current text run will be aligned above the default text baseline.
WrapInMailMergeField

Wrap run in a mail merge field.

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.

GetNext

Get the next section if exists.

GetPrevious

Get the preious section if exists.

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 the 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 the 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 the pages in this section.

SetPageSize

Specify the properties (size and orientation) for all the 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.
WordprocessingML supports five distinct types of section breaks:

  • Next page section breaks (the default if type is not specified), which begin the new section on the following page.
  • Odd page section breaks, which begin the new section on the next odd-numbered page.
  • Even page section breaks, which begin the new section on the next even-numbered page.
  • Continuous section breaks, which begin the new section on the following paragraph. This means that continuous section breaks might not specify certain page-level section properties, since they shall be inherited from the following section. These breaks, however, can specify other section properties, such as line numbering and footnote/endnote settings.
  • Column section breaks, which begin the new section on the next column on the page.
ApiShape
Name Description
GetClassType

Get the type of this class.

GetContent

Get the shape inner contents where a paragraph or text runs can be inserted.

GetDocContent

Get the shape inner contents where a paragraph or text runs can be inserted.

GetNextShape

Get the next inline shape.

GetPrevShape

Get the previous inline shape.

SetPaddings

Set text paddings

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 of 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.

AddColumns

Add the new columns to the current table.

AddElement

Add a paragraph or a table or a blockLvl content control using its position in the cell.

AddRow

Add a new row to the current table.

AddRows

Add the new rows to the current table.

Clear

Clear the content from the table.

Copy

Create a copy of a table.

Delete

Delete the table.

GetCell

Get the cell by its position.

GetClassType

Get the type of this class.

GetNext

Get the next table.

GetParentContentControl

Get a content control that contains the table.

GetParentTable

Get the table that contains this table.

GetParentTableCell

Get the table cell that contains the table.

GetPrevious

Get the previous table.

GetRange

Return a Range object that represents the part of the document contained in the specified table.

GetRow

Get the table row by its position in the table.

GetRowsCount

Get the number of rows in the current table.

GetTables

Get the tables that contain this table.

InsertInContentControl

Wrap the table object with a content control.

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". The number of cells in any row and the number of rows in the current table may be changed.

RemoveColumn

Remove a table column with a specified cell.

RemoveRow

Remove a table row with a specified cell.

Search

Search for the scope of a table object. The search results are a collection of ApiRange objects.

Select

Select a table.

SetCellSpacing

Specify the default table cell spacing (the spacing between adjacent cells and the edges of the table).

SetHAlign

Set horizontal alignment for a table.

SetJc

Specify the alignment of the current table with respect to the text margins in the current section.

SetPaddings

Set table paddings. If table is inline -> only left padding applies.

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 conditional formatting components 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.

The default setting is to apply the row and column band formatting, but not the first row, last row, first column, or last column formatting.

SetTextPr

Apply text settings to the entire contents of the table.

SetVAlign

Set vertical alignment for a table.

SetWidth

Set the preferred width for this table. Tables are created with the ApiTable.SetWidth method properties set by default, which always override the ApiTablePr.SetWidth method properties. That is why there is no use to try and apply ApiTablePr.SetWidth , we recommend that you use the ApiTablePr.SetWidth method instead.

SetWrappingStyle

Set table wrapping style.

Split

Split the cell into a given number of rows and columns.

ApiTableCell
Name Description
AddColumns

Add the new columns to the current table.

AddElement

Add a paragraph or a table or a blockLvl content control using its position in the cell.

AddRows

Add the new rows to the current table.

Clear

Clear the content from the cell.

GetClassType

Get the type of this class.

GetContent

Get the cell content.

GetIndex

Get the cell index.

GetNext

Get the next cell.

GetParentRow

Get the parent row of the cell.

GetParentTable

Get the parent table of the cell.

GetPrevious

Get the previous cell.

GetRowIndex

Get the index of the parent row.

RemoveColumn

Remove a column containing a cell.

RemoveRow

Remove a row containing a cell.

Search

Search for the scope of a cell object. The search results are a collection of ApiRange objects.

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.

SetCellPr

Set the cell properties.

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 ApiTablePr.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.

SetTextPr

Apply text settings to the entire contents of the cell.

SetVerticalAlign

Specify the vertical alignment for text contents within the current table cell.

SetWidth

Set the preferred width for the current table cell.

Split

Split the cell into a given number of rows and columns.

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 ApiTablePr.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. Tables are created with the ApiTable.SetWidth method properties set by default, which always override the ApiTablePr.SetWidth method properties. That is why there is no use to try and apply ApiTablePr.SetWidth , we recommend that you use the ApiTablePr.SetWidth method instead.

ApiTableRow
Name Description
AddRows

Add the new rows to the current table.

Clear

Clear the content from row.

GetCell

Get the cell by its position.

GetCellsCount

Get the number of cells in the current row.

GetClassType

Get the type of this class.

GetIndex

Get the row index.

GetNext

Get the next row.

GetParentTable

Get parent table of the row.

GetPrevious

Get the previous row.

MergeCells

Merge cells in the row.

Remove

Remove a table row.

Search

Search for the scope of a table row object. The search results are a collection of ApiRange objects.

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.

SetTextPr

Set text properties for the row.

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

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 are 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.

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 the small letter characters in the text run are formatted for display only as their capital letter character equivalents which are 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 the run are displayed with a single horizontal line through the center of the line.

SetStyle

The text style base method. This method is not used by itself, as it only forms the basis for the ApiRun.SetStyle method which sets the selected or created style for the text.

SetUnderline

Specify that the contents of the 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:

  • "baseline" - the characters in the current text run will be aligned by the default text baseline.
  • "subscript" - the characters in the current text run will be aligned below the default text baseline.
  • "superscript" - the characters in the current text run will be aligned above the default text baseline.
ApiUniColor
Name Description
GetClassType

Get the type of the class based on this base class.

ApiUnsupported
Name Description
GetClassType

Get the type of this class.

Spreadsheet API

Api
Name Description
AddDefName

Define a new name for a range of cells.

AddSheet

Create a new worksheet. The new worksheet becomes the active sheet.

CreateBlipFill

Create a blip fill to apply to 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 to apply to 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 to apply 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 to apply to 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 to apply to the object using a selected solid color as the object background.

CreateStroke

Create a stroke adding shadows to the element.

Format

Return a class formatted according to the instructions contained in a format expression.

GetActiveSheet

Get the object that represents the active sheet.

GetDefName

Return an ApiName.

GetLocale

Return current locale id.

GetMailMergeData

Get mail merge data.

GetRange

Return an ApiRange.

GetSelection

Return an object that represents the selection range.

GetSheet

Return an object that represents the sheet.

GetSheets

Returns a sheet collection that represents all the sheets in the active workbook.

GetThemesColors

Get the list of all the available theme colors for the spreadsheet.

Intersect

Return an ApiRange object that represents the rectangular intersection of two or more ranges. If one or more ranges from a different worksheet are specified, an error will be returned.

ReplaceTextSmart

Replaces each paragraph(or text in cell) in the select with the corresponding text from an array of strings.

Save

Save changes to the specified document.

SetLocale

Set locale for the document.

SetThemeColors

Set the theme colors to the current spreadsheet.

ApiBullet
Name Description
GetClassType

Get the type of this class.

ApiChart
Name Description
ApplyChartStyle

Apply set of visual settings to the chart.

GetClassType

Get the type of this class.

SetHorAxisLablesFontSize

Specify font size for the horizontal axis labels.

SetHorAxisMajorTickMark

Specify major tick mark for horizontal axis.

SetHorAxisMinorTickMark

Specify minor tick mark for horizontal axis.

SetHorAxisOrientation

Specify 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 chart data values.

SetHorAxisTitle

Specify the chart horizontal axis title.

SetLegendFontSize

Specify the legend font size.

SetLegendPos

Specify the chart legend position.

SetMajorHorizontalGridlines

Specify major horizontal gridline's visual properties.

SetMajorVerticalGridlines

Specify major vertical gridline's visual properties.

SetMinorHorizontalGridlines

Specify minor vertical gridline's visual properties.

SetMinorVerticalGridlines

Specify minor vertical gridline's visual properties.

SetShowDataLabels

Specify which chart data labels are shown for the chart.

SetShowPointDataLabel

Spicify the show options for data labels.

SetTitle

Specify the chart title.

SetVerAxisOrientation

Specify the direction of the data displayed on the vertical axis.

SetVerAxisTitle

Specify the chart vertical axis title.

SetVertAxisLablesFontSize

Specify font size for the vertical axis labels.

SetVertAxisMajorTickMark

Specify major tick mark for vertical axis.

SetVertAxisMinorTickMark

Specify minor tick mark for vertical axis.

SetVertAxisTickLabelPosition

Set the possible values for the position of the chart tick labels in relation to the main vertical label or the chart data values.

ApiColor
Name Description
GetClassType

Get the type of this class.

ApiComment
Name Description
Delete

Delete an ApiComment object.

GetClassType

Returns the type of comment class.

GetText

Return the comment text.

ApiDocument
Name Description
AddElement

Add a paragraph or a table or a blockLvl content control using its position in the document content.

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 the elements from the current document or from the current document element. When all elements are removed, a new empty paragraph is automatically created. If you want to add content to this paragraph, use the ApiDocumentContent.GetElement method.

RemoveElement

Remove element using the position specified.

ApiDocumentContent
Name Description
AddElement

Add a paragraph or a table or a blockLvl content control using its position in the document content.

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 the elements from the current document or from the current document element. When all elements are removed, a new empty paragraph is automatically created. If you want to add content to this paragraph, use the ApiDocumentContent.GetElement method.

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. Please note, that the horizontal nColOffset and vertical nRowOffset offsets are calculated within the limits of the specified nFromCol column and nFromRow row cell only. If this value exceeds the cell width or height, another vertical/horizontal position will be set.

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.

ApiHyperlink
Name Description
GetElement

Get the hyperlink element using the position specified.

GetElementsCount

Get the number of elements in the current hyperlink.

ApiImage
Name Description
GetClassType

Get the type of this class.

ApiName
Name Description
Delete

Delete the DefName object.

GetName

Return a String value representing the object name.

GetRefersTo

Return the formula that the name is defined to refer to.

GetRefersToRange

Return an ApiRange object by reference.

SetName

Set a String value representing the object name.

SetRefersTo

Set the formula that the name is defined to refer to.

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.

Copy

Create a paragraph copy. Ingnore comments, footnote references, complex fields.

Delete

Delete current paragraph.

GetClassType

Get the type of this class.

GetElement

Get the paragraph element using the position specified.

GetElementsCount

Get the number of elements in the current paragraph.

GetIndFirstLine

Get the paragraph first line indentation.

GetIndLeft

Get the paragraph left side indentation.

GetIndRight

Get the paragraph right side indentation.

GetJc

Get paragraph contents justification.

GetNext

Get the next paragraph.

GetParaPr

Get paragraph properties.

GetPrevious

Get the previous paragraph.

GetSpacingAfter

Get the spacing after value of the current paragraph.

GetSpacingBefore

Get the spacing before value of the current paragraph.

GetSpacingLineRule

Get the paragraph line spacing rule.

GetSpacingLineValue

Get the paragraph line spacing value.

RemoveAllElements

Remove all the elements from the current paragraph. When all the elements are removed from the paragraph, a new empty run is automatically created. If you want to add content to this run, use the ApiParagraph.GetElement method.

RemoveElement

Remove the element using the position specified. If the element you remove is the last paragraph element (i.e. all the elements are removed from the paragraph), a new empty run is automatically created. If you want to add content to this run, use the ApiParagraph.GetElement method.

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. Warning: The lengths of aPos array and aVal array MUST BE equal to each other.

ApiParaPr
Name Description
GetClassType

Get the type of this class.

GetIndFirstLine

Get the paragraph first line indentation.

GetIndLeft

Get the paragraph left side indentation.

GetIndRight

Get the paragraph right side indentation.

GetJc

Get paragraph contents justification.

GetSpacingAfter

Get the spacing after value of the current paragraph.

GetSpacingBefore

Get the spacing before value of the current paragraph.

GetSpacingLineRule

Get the paragraph line spacing rule.

GetSpacingLineValue

Get the paragraph line spacing value.

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. Warning: The lengths of aPos array and aVal array MUST BE equal to each other.

ApiPresetColor
Name Description
GetClassType

Get the type of this class.

ApiRange
Name Description
AddComment

Add a comment to the range.

Clear

Clear the entire object.

End

Returns a Range object that represents the end in the specified direction in the specified range.

ForEach

Execute a provided function once for each cell.

GetAddress

Get cell address.

GetCells

Returns a Range object that represents all the cells in the specified range or a specified cell.

GetClassType

Get the type of this class.

GetCol

Get the column number for the selected cell.

GetCols

Returns a Range object that represents all the cells on the columns range.

GetColumnWidth

Get columns width value.

GetComment

Return an ApiComment.

GetCount

Get rows or columns count.

GetDefName

Return an ApiName.

GetFillColor

Get the background color for the current cell range.

GetFormula

Get the formula of the first cell in range.

GetHidden

Get the value hiding property.

GetOrientation

Returns the range angle.

GetRow

Get the row number for the selected cell.

GetRowHeight

Get row height value.

GetRows

Return a Range object that represents the rows in the specified range. If the specified row is outside the Range object, a new Range will be returned that represents the cells between the columns of the original range in the specified row.

GetText

Get the text of the first cell in range.

GetValue

Get the value of the first cell in range.

GetValue2

Get the Value2 property (value without format) of the first cell in range.

GetWorksheet

Return a Worksheet object that represents the worksheet containing the specified range. Read-only.

GetWrapText

Return the information about the wrapping cell style.

Merge

Merge the selected cell range into a single cell or a cell row.

Select

Select the object.

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.

SetColumnWidth

Set the width of all the columns in the specified range. One unit of column width is equal to the width of one character in the Normal style. For proportional fonts, the width of the character 0 (zero) is used.

SetFillColor

Set the background color for the current cell range with the previously created color object. Set 'No Fill' when previously created color object is null.

SetFontColor

Set the text color for the current cell range with the previously created color object.

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.

SetHidden

Set the value hiding property.

SetItalic

Set the italic property to the text characters in the current cell or cell range.

SetNumberFormat

Specify whether the number in the cell should be treated like number, currency, date, time, etc. or just like text.

SetOffset

Set cell offset

SetOrientation

Sets an angle to the current cell range.

SetRowHeight

Set row height value.

SetStrikeout

Specify that the contents of the cell / cell range are displayed with a single horizontal line through the center of the contents.

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

Specify 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

Clear content from the current run.

Copy

Create a copy of the run.

Delete

Delete current run.

GetClassType

Get the type of this class.

GetTextPr

Get the text properties of the current run.

RemoveAllElements

Remove all the elements from 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 are 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.

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 the small letter characters in this text run are formatted for display only as their capital letter character equivalents which are 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

Set style for the current Run.

SetTextPr

Set the text properties for the current run.

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:

  • "baseline" - the characters in the current text run will be aligned by the default text baseline.
  • "subscript" - the characters in the current text run will be aligned below the default text baseline.
  • "superscript" - the characters in the current text run will be aligned above the default text baseline.
ApiSchemeColor
Name Description
GetClassType

Get the type of this class.

ApiShape
Name Description
GetClassType

Get the type of this class.

GetContent

Get the shape inner contents where a paragraph or text runs can be inserted.

GetDocContent

Get the shape inner contents where a paragraph or text runs can be inserted.

SetPaddings

Set text paddings

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.

ApiTable
Name Description
AddElement

Add a paragraph or a table or a blockLvl content control using its position in the cell.

Copy

Create a copy of a table.

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 are 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 the small letter characters in the text run are formatted for display only as their capital letter character equivalents which are 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 the run are displayed with a single horizontal line through the center of the line.

SetUnderline

Specify that the contents of the 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:

  • "baseline" - the characters in the current text run will be aligned by the default text baseline.
  • "subscript" - the characters in the current text run will be aligned below the default text baseline.
  • "superscript" - the characters in the current text run will be aligned above the default text baseline.
ApiUniColor
Name Description
GetClassType

Get the type of the class based on this base class.

ApiWorksheet
Name Description
AddChart

Create a chart of the set type from the selected data range of the current sheet. Please note, that the horizontal nColOffset and vertical nRowOffset offsets are calculated within the limits of the specified nFromCol column and nFromRow row cell only. If this value exceeds the cell width or height, another vertical/horizontal position will be set.

AddDefName

Define a new name for a range of cells.

AddImage

Adds the image to the current sheet with the parameters specified.

AddShape

Adds the shape to the current sheet with the parameters specified. Please note, that the horizontal nColOffset and vertical nRowOffset offsets are calculated within the limits of the specified nFromCol column and nFromRow row cell only. If this value exceeds the cell width or height, another vertical/horizontal position will be set.

Delete

Delete an ApiWorksheet object.

FormatAsTable

Format the selected range of cells from the current sheet as a table (with the first row formatted as a header). As the first row is always formatted as a table header, you need to select at least two rows for the table to be formed correctly.

GetActiveCell

Return an object that represents the active cell.

GetBottomMargin

Get the bottom margin of the sheet.

GetCells

Return an ApiRange that represents all the cells on the worksheet (not just the cells that are currently in use).

GetCols

Return an ApiRange that represents all the cells on the columns range.

GetComments

Return an ApiComment.

GetDefName

Return an ApiName.

GetDefNames

Return an array of ApiName objects.

GetIndex

Get a sheet index.

GetLeftMargin

Get the left margin of the sheet.

GetName

Get a sheet name.

GetPageOrientation

Get the page orientation

GetPrintGridlines

Get the page PrintGridlines property.

GetPrintHeadings

Get the page PrintHeadings property.

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.

GetRightMargin

Get the right margin of the sheet.

GetRows

Return an ApiRange that represents all the cells on the rows range.

GetSelection

Return an object that represents the selected range.

GetTopMargin

Get the top margin of the sheet.

GetUsedRange

Return an ApiRange that represents the used range on the specified worksheet.

GetVisible

Return the state of sheet visibility.

ReplaceCurrentImage

Replace current image.

SetActive

Make the current sheet the active sheet.

SetBottomMargin

Set the bottom margin of the sheet.

SetColumnWidth

Set the width of the specified columns. One unit of column width is equal to the width of one character in the Normal style. For proportional fonts, the width of the character 0 (zero) is used.

SetDisplayGridlines

Specify whether the current sheet gridlines must be displayed or not.

SetDisplayHeadings

Specify whether the current sheet row/column headers must be displayed or not.

SetHyperlink

Add a hyperlink to the specified range.

SetLeftMargin

Set the left margin of the sheet.

SetName

Set a name to the current active sheet.

SetPageOrientation

Set the page orientation.

SetPrintGridlines

Set the page PrintGridlines property.

SetPrintHeadings

Set the page PrintHeadings property.

SetRightMargin

Set the right margin of the sheet.

SetRowHeight

Set the height of the specified row measured in points. A point is 1/72 inch.

SetTopMargin

Set the top margin of the sheet.

SetVisible

Set the state of sheet visibility.

Presentation API

Api
Name Description
CreateBlipFill

Create a blip fill to apply to 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.

CreateGroup

Create a group of drawings.

CreateImage

Create an image with the parameters specified.

CreateLinearGradientFill

Create a linear gradient fill to apply to 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 to apply 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 to apply to 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 to apply to the object using a selected solid color as the object background.

CreateStroke

Create a stroke adding shadows to the element.

CreateTable

Create a table.

GetPresentation

Get the main presentation.

ReplaceTextSmart

Replaces each paragraph(or text in cell) in the select with the corresponding text from an array of strings.

Save

Save changes to the specified document.

ApiBullet
Name Description
GetClassType

Get the type of this class.

ApiChart
Name Description
GetClassType

Get the type of this class.

SetHorAxisLablesFontSize

Specify font size for labels of horizontal axis.

SetHorAxisMajorTickMark

Specify major tick mark for horizontal axis.

SetHorAxisMinorTickMark

Specify minor tick mark for horizontal axis.

SetHorAxisOrientation

Specify a horizontal axis orientation.

SetHorAxisTickLabelPosition

Spicify tick labels position for horizontal axis.

SetHorAxisTitle

Specify the chart horizontal axis title.

SetLegendFontSize

Specify a legend font size.

SetLegendPos

Specify the chart legend position.

SetMajorHorizontalGridlines

Specify major horizontal gridline's visual properties.

SetMajorVerticalGridlines

Specify major vertical gridline's visual properties.

SetMinorHorizontalGridlines

Specify minor vertical gridline's visual properties.

SetMinorVerticalGridlines

Specify minor vertical gridline's visual properties.

SetShowDataLabels

Specify which chart data labels are shown for the chart.

SetShowPointDataLabel

Spicify the show options for data labels.

SetTitle

Specify the chart title.

SetVerAxisOrientation

Specify a vertical axis orientation.

SetVerAxisTitle

Specify the chart vertical axis title.

SetVertAxisLablesFontSize

Specify font size for labels of vertical axis.

SetVertAxisMajorTickMark

Specify major tick mark for vertical axis.

SetVertAxisMinorTickMark

Specify minor tick mark for vertical axis.

SetVertAxisTickLabelPosition

Spicify tick labels position for vertical axis.

ApiDocument
Name Description
AddElement

Add a paragraph or a table or a blockLvl content control using its position in the document content.

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 the elements from the current document or from the current document element. When all elements are removed, a new empty paragraph is automatically created. If you want to add content to this paragraph, use the ApiDocumentContent.GetElement method.

RemoveElement

Remove element using the position specified.

ApiDocumentContent
Name Description
AddElement

Add a paragraph or a table or a blockLvl content control using its position in the document content.

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 the elements from the current document or from the current document element. When all elements are removed, a new empty paragraph is automatically created. If you want to add content to this paragraph, use the ApiDocumentContent.GetElement method.

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.

ApiHyperlink
Name Description
GetElement

Get the hyperlink element using the position specified.

GetElementsCount

Get the number of elements in the current hyperlink.

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.

Copy

Create a paragraph copy. Ingnore comments, footnote references, complex fields.

Delete

Delete current paragraph.

GetClassType

Get the type of this class.

GetElement

Get the paragraph element using the position specified.

GetElementsCount

Get the number of elements in the current paragraph.

GetIndFirstLine

Get the paragraph first line indentation.

GetIndLeft

Get the paragraph left side indentation.

GetIndRight

Get the paragraph right side indentation.

GetJc

Get paragraph contents justification.

GetNext

Get the next paragraph.

GetParaPr

Get paragraph properties.

GetPrevious

Get the previous paragraph.

GetSpacingAfter

Get the spacing after value of the current paragraph.

GetSpacingBefore

Get the spacing before value of the current paragraph.

GetSpacingLineRule

Get the paragraph line spacing rule.

GetSpacingLineValue

Get the paragraph line spacing value.

RemoveAllElements

Remove all the elements from the current paragraph. When all the elements are removed from the paragraph, a new empty run is automatically created. If you want to add content to this run, use the ApiParagraph.GetElement method.

RemoveElement

Remove the element using the position specified. If the element you remove is the last paragraph element (i.e. all the elements are removed from the paragraph), a new empty run is automatically created. If you want to add content to this run, use the ApiParagraph.GetElement method.

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. Warning: The lengths of aPos array and aVal array MUST BE equal to each other.

ApiParaPr
Name Description
GetClassType

Get the type of this class.

GetIndFirstLine

Get the paragraph first line indentation.

GetIndLeft

Get the paragraph left side indentation.

GetIndRight

Get the paragraph right side indentation.

GetJc

Get paragraph contents justification.

GetSpacingAfter

Get the spacing after value of the current paragraph.

GetSpacingBefore

Get the spacing before value of the current paragraph.

GetSpacingLineRule

Get the paragraph line spacing rule.

GetSpacingLineValue

Get the paragraph line spacing value.

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. Warning: The lengths of aPos array and aVal array MUST BE equal to each other.

ApiPresentation
Name Description
AddSlide

Append a new slide to the end of the presentation.

CreateNewHistoryPoint

Create new history point.

GetClassType

Get the type of this class.

GetCurrentSlide

Get the current slide.

GetCurSlideIndex

Get the index for the current slide.

GetSlideByIndex

Get the slide by its position in the presentation.

ReplaceCurrentImage

Replace current image.

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

Clear content from the current run.

Copy

Create a copy of the run.

Delete

Delete current run.

GetClassType

Get the type of this class.

GetTextPr

Get the text properties of the current run.

RemoveAllElements

Remove all the elements from 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 are 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.

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 the small letter characters in this text run are formatted for display only as their capital letter character equivalents which are 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

Set style for the current Run.

SetTextPr

Set the text properties for the current run.

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:

  • "baseline" - the characters in the current text run will be aligned by the default text baseline.
  • "subscript" - the characters in the current text run will be aligned below the default text baseline.
  • "superscript" - the characters in the current text run will be aligned above the default text baseline.
ApiSchemeColor
Name Description
GetClassType

Get the type of this class.

ApiShape
Name Description
GetClassType

Get the type of this class.

GetContent

Get the shape inner contents where a paragraph or text runs can be inserted.

GetDocContent

Deprecated in 6.2. 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.

ApiTable
Name Description
AddColumn

Add a new column to the end of the current table.

AddElement

Add a paragraph or a table or a blockLvl content control using its position in the cell.

AddRow

Add a new row to the current table.

Copy

Create a copy of a table.

GetClassType

Return type of object.

GetRow

Return row by index.

MergeCells

Merge array of cells. If merge was done successfully, it will return merged cell, otherwise "null". Warning: The number of cells in any row and the number of rows in the current table may be changed.

RemoveColumn

Remove the table column with a specified cell.

RemoveRow

Remove the table row with a specified cell.

Select

Select a table.

SetShd

Specify the shading which shall be applied to the extents of the current table.

SetTableLook

Specify the components of the conditional formatting of the referenced table style (if one exists) which shall 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 [Example: Different formatting for first column], which then can be applied or omitted from individual table rows in the parent table.

The default setting is to apply the row and column banding formatting, but not the first row, last row, first column, or last column formatting.

ApiTableCell
Name Description
GetClassType

Get the type of this class.

GetContent

Returns cell content.

SetCellBorderBottom

Set the border which shall be displayed at the bottom of the current table cell.

SetCellBorderLeft

Set the border which shall be displayed at the left of the current table cell.

SetCellBorderRight

Set the border which shall be displayed at the right of the current table cell.

SetCellBorderTop

Set the border which shall be displayed at the top of the current table cell.

SetCellMarginBottom

Specify the amount of space which shall be left between the bottom extent of the cell contents and the border of a specific individual table cell within a table.

SetCellMarginLeft

Specify the amount of space which shall be left between the left extent of the current cell contents and the left edge border of a specific individual table cell within a table.

SetCellMarginRight

Specifies the amount of space which shall be left between the right extent of the current cell contents and the right edge border of a specific individual table cell within a table.

SetCellMarginTop

Specifies the amount of space which shall be left between the top extent of the current cell contents and the top edge border of a specific individual table cell within a table.

SetShd

Specify the shading which shall be applied to the extents of the current table cell.

SetTextDirection

Specify the direction of the text flow for this table cell.

SetVerticalAlign

Specify the vertical alignment for text within the current table cell.

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.

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 are 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 the small letter characters in the text run are formatted for display only as their capital letter character equivalents which are 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 the run are displayed with a single horizontal line through the center of the line.

SetUnderline

Specify that the contents of the 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:

  • "baseline" - the characters in the current text run will be aligned by the default text baseline.
  • "subscript" - the characters in the current text run will be aligned below the default text baseline.
  • "superscript" - the characters in the current text run will be aligned above the default text baseline.
ApiUniColor
Name Description
GetClassType

Get the type of the class based on this base class.

Global