ApiDocument

Represents the ApiDocument class.

Methods

Method	Returns	Description
ClearAllFields	boolean	Clears all forms in the document.
GetAllForms	ApiForm[]	Returns all existing forms in the document.
GetFormKeysByRole	string[]	Returns a list of all form keys attached to the specified role.
GetFormRoles	ApiFormRoles	Returns a collection of form roles.
GetFormValueByKey	null | boolean | string	Returns the form value for the specified key. For a group of radio buttons returns Choice, i.e. the name of the selected item.
GetFormsByKey	ApiForm[]	Returns a list of all forms in the document with the specified key.
GetFormsByRole	ApiForm[]	Returns a list of all forms in the document with the specified role name.
GetFormsByTag	ApiForm[]	Returns a list of all forms in the document with the specified tag name.
GetFormsData	FormData[]	Returns the data from all forms present in the current document. If a form was created and not assigned to any part of the document, it won't appear in this list.
GetTagsOfAllForms	String[]	Returns a list of all tags that are used for all forms in the document.
InsertTextForm	ApiTextForm	Inserts a text box with the specified text box properties over the selected text.
SetFormsData	boolean	Sets the data to the specified forms.
SetFormsHighlight	boolean	Sets the highlight to the forms in the document.