Api

Represents the Api class.

Methods

Method	Returns	Description
AddComment	ApiComment	Adds a comment to the specifed document element or array of Runs.
ConvertDocument	string	Converts a document to Markdown or HTML text.
CreateBlipFill	ApiFill	Creates a blip fill to apply to the object using the selected image as the object background.
CreateBlockLvlSdt	ApiBlockLvlSdt	Creates a new block level container.
CreateChart	ApiChart	Creates a chart with the parameters specified.
CreateCheckBoxContentControl	ApiInlineLvlSdt	Creates a checkbox content control.
CreateComboBoxContentControl	ApiInlineLvlSdt	Creates a new combo box container with the given list of options.
CreateDatePickerContentControl	ApiInlineLvlSdt	Creates a new date picker content control.
CreateDropDownListContentControl	ApiInlineLvlSdt	Creates a new drop-down list container with the given list of options.
CreateGradientStop	ApiGradientStop	Creates a gradient stop used for different types of gradients.
CreateGroup	ApiGroup	Groups an array of drawings.
CreateHyperlink	ApiHyperlink	Creates a new hyperlink text block to be inserted to the current paragraph or table.
CreateImage	ApiImage	Creates an image with the parameters specified.
CreateInlineLvlSdt	ApiInlineLvlSdt	Creates a new inline container.
CreateLinearGradientFill	ApiFill	Creates a linear gradient fill to apply to the object using the selected linear gradient as the object background.
CreateNoFill	ApiFill	Creates no fill and removes the fill from the element.
CreateOleObject	ApiOleObject	Creates an OLE object with the parameters specified.
CreateParagraph	ApiParagraph	Creates a new paragraph.
CreatePatternFill	ApiFill	Creates a pattern fill to apply to the object using the selected pattern as the object background.
CreatePictureContentControl	ApiInlineLvlSdt	Creates a new picture container.
CreatePresetColor	ApiPresetColor	Creates a color selecting it from one of the available color presets.
CreateRGBColor	ApiRGBColor	Creates an RGB color setting the appropriate values for the red, green and blue color components.
CreateRadialGradientFill	ApiFill	Creates a radial gradient fill to apply to the object using the selected radial gradient as the object background.
CreateRange	ApiRange | null	Creates an element range. If you do not specify the start and end positions, the range will be taken from the entire element.
CreateRun	ApiRun	Creates a new smaller text block to be inserted to the current paragraph or table.
CreateSchemeColor	ApiSchemeColor	Creates a complex color scheme selecting from one of the available schemes.
CreateShape	ApiShape	Creates a shape with the parameters specified.
CreateSolidFill	ApiFill	Creates a solid fill to apply to the object using a selected solid color as the object background.
CreateStroke	ApiStroke	Creates a stroke adding shadows to the element.
CreateTable	ApiTable	Creates a new table with a specified number of rows and columns.
CreateTextPr	ApiTextPr	Creates the empty text properties.
CreateWordArt	ApiDrawing	Creates a Text Art object with the parameters specified.
FromJSON	object	Converts the specified JSON object into the Document Builder object of the corresponding type.
GetDocument	ApiDocument	Returns the main document.
GetFullName	string	Returns the full name of the currently opened file.
GetMailMergeReceptionsCount	number	Returns the mail merge receptions count.
GetMailMergeTemplateDocContent	ApiDocumentContent	Returns the mail merge template document.
LoadMailMergeData	boolean	Loads data for the mail merge.
MailMerge	boolean	Starts the mail merge process.
ReplaceDocumentContent	boolean	Replaces the main document content with another document content.
ReplaceTextSmart	boolean	Replaces each paragraph (or text in cell) in the select with the corresponding text from an array of strings.
Save	boolean	Saves changes to the specified document.
attachEvent	boolean	Subscribes to the specified event and calls the callback function when the event fires.
detachEvent	boolean	Unsubscribes from the specified event.