Get Started
Plugins
Macros
More information

Api

new Api()

Base class.

Methods

Name Description
AcceptReviewChanges

Accepts review changes.

AddComment

Adds a comment to the document.

AddContentControl

Adds an empty content control to the document.

AddContentControlCheckBox

Adds an empty content control checkbox to the document.

AddContentControlDatePicker

Adds an empty content control datepicker to the document.

AddContentControlList

Adds an empty content control list to the document.

AddContentControlPicture

Adds an empty content control picture to the document.

ChangeComment

Changes the specified comment.

ChangeOleObject

Changes the OLE object with the InternalId specified in OLE object data.

ChangeOleObjects

Changes multiple OLE objects with the InternalIds specified in OLE object data.

GetAllComments

Returns all the comments from the document.

GetAllContentControls

Returns information about all the content controls that have been added to the page.

GetAllOleObjects

Returns all OLE object data for objects which can be opened by the specified plugin. If sPluginId is not defined, this method returns all OLE objects contained in the currrent document.

GetCurrentContentControl

Returns an identifier of the selected content control (i.e. the content control where the mouse cursor is currently positioned).

GetCurrentContentControlPr

Returns the current content control properties.

GetFields

Returns all fields as a text.

GetFileHTML

Returns file content in the HTML format.

InsertAndReplaceContentControls

Inserts the content control containing data. The data is specified by the JS code for Document Builder, or by a link to the shared document.

InsertOleObject

Inserts the OLE object at the current document position.

MoveCursorToContentControl

Moves a cursor to the specified content control.

MoveCursorToEnd

Moves a cursor to the end of the current editing area (document body, footer/header, footnote, or autoshape). This method is similar to pressing the Ctrl + End keyboard shortcut.

MoveCursorToStart

Moves a cursor to the beginning of the current editing area (document body, footer/header, footnote, or autoshape). This method is similar to pressing the Ctrl + Home keyboard shortcut.

MoveToComment

Moves a cursor to the specified comment.

MoveToNextReviewChange

Navigates through the review changes.

OpenFile

Opens a file with fields.

RejectReviewChanges

Rejects review changes.

RemoveComments

Removes the specified comments.

RemoveContentControl

Removes the currently selected content control retaining all its contents. The content control where the mouse cursor is currently positioned will be removed.

RemoveContentControls

Removes several content controls.

RemoveOleObject

Removes the OLE object from the document by its internal ID.

RemoveOleObjects

Removes several OLE objects from the document by their internal IDs.

RemoveSelectedContent

Removes the selected content from the document.

SearchAndReplace

Finds and replaces the text.

SelectContentControl

Selects the specified content control.

SelectOleObject

Selects the specified OLE object.

SetDisplayModeInReview

Sets the display mode for track changes.