Skip to main content

ApiDocument

Represents the ApiDocument class.

Methods

MethodReturnsDescription
ClearAllFieldsbooleanClears all forms in the document.
GetAllFormsApiForm[]Returns all existing forms in the document.
GetFormKeysByRolestring[]Returns a list of all form keys attached to the specified role.
GetFormRolesApiFormRolesReturns a collection of form roles.
GetFormValueByKeynull | boolean | stringReturns the form value for the specified key. For a group of radio buttons returns Choice, i.e. the name of the selected item.
GetFormsByKeyApiForm[]Returns a list of all forms in the document with the specified key.
GetFormsByRoleApiForm[]Returns a list of all forms in the document with the specified role name.
GetFormsByTagApiForm[]Returns a list of all forms in the document with the specified tag name.
GetFormsDataFormData[]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.
GetTagsOfAllFormsString[]Returns a list of all tags that are used for all forms in the document.
InsertTextFormApiTextFormInserts a text box with the specified text box properties over the selected text.
SetFormsDatabooleanSets the data to the specified forms.
SetFormsHighlightbooleanSets the highlight to the forms in the document.