FormField

	Request	Response	Model
Delete	DeleteFormFieldOnlineRequest	Dictionary
	DeleteFormFieldRequest	Task
Get	GetFormFieldOnlineRequest	FormFieldResponse	FormField
	GetFormFieldRequest
	GetFormFieldsOnlineRequest	FormFieldsResponse	FormFieldCollection
	GetFormFieldsRequest
Insert	InsertFormFieldOnlineRequest	InsertFormFieldOnlineResponse	FormField
	InsertFormFieldRequest	FormFieldResponse
Update	UpdateFormFieldOnlineRequest	UpdateFormFieldOnlineResponse
	UpdateFormFieldRequest	FormFieldResponse

FormField

Represents a fromField.

This class is inherited from NodeLink and used in FormFieldCollection, FormFieldResponse, InsertFormFieldOnlineRequest, InsertFormFieldRequest, UpdateFormFieldOnlineRequest, UpdateFormFieldRequest.

The following properties are defined:

Property	Type	Description
Link	WordsApiLink	Gets or sets the link to the document.
NodeId	string	Gets or sets the node id.
CalculateOnExit	bool	Gets or sets a value indicating whether references to the specified form field are automatically updated whenever the field is exited.
Enabled	bool	Gets or sets a value indicating whether a form field is enabled.
EntryMacro	string	Gets or sets the entry macro name for the form field.
ExitMacro	string	Gets or sets the exit macro name for the form field.
HelpText	string	Gets or sets text, displayed in a message box when the form field has the focus and the user presses F1.
Name	string	Gets or sets the form field name.
OwnHelp	bool	Gets or sets a value indicating whether the source of the text that’s displayed in a message box when a form field has the focus and the user presses F1.
OwnStatus	bool	Gets or sets a value indicating whether the source of the text that’s displayed in the status bar when a form field has the focus.
StatusText	string	Gets or sets text, displayed in the status bar when a form field has the focus.

FormFieldCheckbox

Represents a formField checkbox element.

The following properties are defined:

Property	Type	Description
Link	WordsApiLink	Gets or sets the link to the document.
NodeId	string	Gets or sets the node id.
CalculateOnExit	bool	Gets or sets a value indicating whether references to the specified form field are automatically updated whenever the field is exited.
Enabled	bool	Gets or sets a value indicating whether a form field is enabled.
EntryMacro	string	Gets or sets the entry macro name for the form field.
ExitMacro	string	Gets or sets the exit macro name for the form field.
HelpText	string	Gets or sets text, displayed in a message box when the form field has the focus and the user presses F1.
Name	string	Gets or sets the form field name.
OwnHelp	bool	Gets or sets a value indicating whether the source of the text that’s displayed in a message box when a form field has the focus and the user presses F1.
OwnStatus	bool	Gets or sets a value indicating whether the source of the text that’s displayed in the status bar when a form field has the focus.
StatusText	string	Gets or sets text, displayed in the status bar when a form field has the focus.
CheckBoxSize	double	Gets or sets the size of the checkbox in points. Has effect only when IsCheckBoxExactSize is true.
Checked	bool	Gets or sets the checked status of the check box form field.
IsCheckBoxExactSize	bool	Gets or sets a value indicating whether the size of the textbox is automatic or specified explicitly.

FormFieldCollection

Represents a dTO container with a collection of form fields.

This class is inherited from LinkElement and used in FormFieldsResponse.

The following properties are defined:

Property	Type	Description
Link	WordsApiLink	Gets or sets the link to the document.
List	List<FormField>	Gets or sets the collection of form fields.

FormFieldDropDown

Represents a formField dropdownlist element.

The following properties are defined:

Property	Type	Description
Link	WordsApiLink	Gets or sets the link to the document.
NodeId	string	Gets or sets the node id.
CalculateOnExit	bool	Gets or sets a value indicating whether references to the specified form field are automatically updated whenever the field is exited.
Enabled	bool	Gets or sets a value indicating whether a form field is enabled.
EntryMacro	string	Gets or sets the entry macro name for the form field.
ExitMacro	string	Gets or sets the exit macro name for the form field.
HelpText	string	Gets or sets text, displayed in a message box when the form field has the focus and the user presses F1.
Name	string	Gets or sets the form field name.
OwnHelp	bool	Gets or sets a value indicating whether the source of the text that’s displayed in a message box when a form field has the focus and the user presses F1.
OwnStatus	bool	Gets or sets a value indicating whether the source of the text that’s displayed in the status bar when a form field has the focus.
StatusText	string	Gets or sets text, displayed in the status bar when a form field has the focus.
DropDownItems	List<string>	Gets or sets the items array of a dropdown form field.
DropDownSelectedIndex	int	Gets or sets the index specifying the currently selected item in a dropdown form field.

FormFieldTextInput

Represents a formField text input element.

The following properties are defined:

Property	Type	Description
Link	WordsApiLink	Gets or sets the link to the document.
NodeId	string	Gets or sets the node id.
CalculateOnExit	bool	Gets or sets a value indicating whether references to the specified form field are automatically updated whenever the field is exited.
Enabled	bool	Gets or sets a value indicating whether a form field is enabled.
EntryMacro	string	Gets or sets the entry macro name for the form field.
ExitMacro	string	Gets or sets the exit macro name for the form field.
HelpText	string	Gets or sets text, displayed in a message box when the form field has the focus and the user presses F1.
Name	string	Gets or sets the form field name.
OwnHelp	bool	Gets or sets a value indicating whether the source of the text that’s displayed in a message box when a form field has the focus and the user presses F1.
OwnStatus	bool	Gets or sets a value indicating whether the source of the text that’s displayed in the status bar when a form field has the focus.
StatusText	string	Gets or sets text, displayed in the status bar when a form field has the focus.
MaxLength	int	Gets or sets the maximum length for the text field. Zero when the length is not limited.
TextInputDefault	string	Gets or sets the default string or a calculation expression of the text form field.
TextInputFormat	string	Gets or sets text formatting for the text form field.
TextInputType	TextInputTypeEnum	Gets or sets the type of the text form field.

DeleteFormFieldOnlineRequest

Represents a request model for WordsApi.DeleteFormFieldOnline() operation.

An object of the DeleteFormFieldOnlineRequest class is created by the following constructor methods:

• DeleteFormFieldOnlineRequest()
• DeleteFormFieldOnlineRequest(Stream document, int index, string nodePath, string loadEncoding, string password, string encryptedPassword, string destFileName, string revisionAuthor, string revisionDateTime)

Each of those arguments initializes the corresponding self-titled property:

Argument	Property	Type	Description
document	Document	Stream	The document.
index	Index	int	Object index.
nodePath	NodePath	string	The path to the node in the document tree.
loadEncoding	LoadEncoding	string	Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML.
password	Password	string	Password of protected Word document. Use the parameter to pass a password via SDK. SDK encrypts it automatically. We don’t recommend to use the parameter to pass a plain password for direct call of API.
encryptedPassword	EncryptedPassword	string	Password of protected Word document. Use the parameter to pass an encrypted password for direct calls of API. See SDK code for encyption details.
destFileName	DestFileName	string	Result path of the document after the operation. If this parameter is omitted then result of the operation will be saved as the source document.
revisionAuthor	RevisionAuthor	string	Initials of the author to use for revisions.If you set this parameter and then make some changes to the document programmatically, save the document and later open the document in MS Word you will see these changes as revisions.
revisionDateTime	RevisionDateTime	string	The date and time to use for revisions.

DeleteFormFieldRequest

Represents a request model for WordsApi.DeleteFormField() operation.

An object of the DeleteFormFieldRequest class is created by the following constructor methods:

• DeleteFormFieldRequest()
• DeleteFormFieldRequest(string name, int index, string nodePath, string folder, string storage, string loadEncoding, string password, string encryptedPassword, string destFileName, string revisionAuthor, string revisionDateTime)

Each of those arguments initializes the corresponding self-titled property:

Argument	Property	Type	Description
name	Name	string	The filename of the input document.
index	Index	int	Object index.
nodePath	NodePath	string	The path to the node in the document tree.
folder	Folder	string	Original document folder.
storage	Storage	string	Original document storage.
loadEncoding	LoadEncoding	string	Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML.
password	Password	string	Password of protected Word document. Use the parameter to pass a password via SDK. SDK encrypts it automatically. We don’t recommend to use the parameter to pass a plain password for direct call of API.
encryptedPassword	EncryptedPassword	string	Password of protected Word document. Use the parameter to pass an encrypted password for direct calls of API. See SDK code for encyption details.
destFileName	DestFileName	string	Result path of the document after the operation. If this parameter is omitted then result of the operation will be saved as the source document.
revisionAuthor	RevisionAuthor	string	Initials of the author to use for revisions.If you set this parameter and then make some changes to the document programmatically, save the document and later open the document in MS Word you will see these changes as revisions.
revisionDateTime	RevisionDateTime	string	The date and time to use for revisions.

FormFieldResponse

Represents a REST response with a form field.

This class is inherited from WordsResponse and used in WordsApi, InsertFormFieldOnlineResponse, UpdateFormFieldOnlineResponse.

The following properties are defined:

Property	Type	Description
RequestId	string	Gets or sets the request Id.
FormField	FormField	Gets or sets the form field.

FormFieldsResponse

Represents a REST response with a collection of form fields.

This class is inherited from WordsResponse and used in WordsApi.

The following properties are defined:

Property	Type	Description
RequestId	string	Gets or sets the request Id.
FormFields	FormFieldCollection	Gets or sets the collection of form fields.

GetFormFieldOnlineRequest

Represents a request model for WordsApi.GetFormFieldOnline() operation.

An object of the GetFormFieldOnlineRequest class is created by the following constructor methods:

• GetFormFieldOnlineRequest()
• GetFormFieldOnlineRequest(Stream document, int index, string nodePath, string loadEncoding, string password, string encryptedPassword)

Each of those arguments initializes the corresponding self-titled property:

Argument	Property	Type	Description
document	Document	Stream	The document.
index	Index	int	Object index.
nodePath	NodePath	string	The path to the node in the document tree.
loadEncoding	LoadEncoding	string	Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML.
password	Password	string	Password of protected Word document. Use the parameter to pass a password via SDK. SDK encrypts it automatically. We don’t recommend to use the parameter to pass a plain password for direct call of API.
encryptedPassword	EncryptedPassword	string	Password of protected Word document. Use the parameter to pass an encrypted password for direct calls of API. See SDK code for encyption details.

GetFormFieldRequest

Represents a request model for WordsApi.GetFormField() operation.

An object of the GetFormFieldRequest class is created by the following constructor methods:

• GetFormFieldRequest()
• GetFormFieldRequest(string name, int index, string nodePath, string folder, string storage, string loadEncoding, string password, string encryptedPassword)

Each of those arguments initializes the corresponding self-titled property:

Argument	Property	Type	Description
name	Name	string	The filename of the input document.
index	Index	int	Object index.
nodePath	NodePath	string	The path to the node in the document tree.
folder	Folder	string	Original document folder.
storage	Storage	string	Original document storage.
loadEncoding	LoadEncoding	string	Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML.
password	Password	string	Password of protected Word document. Use the parameter to pass a password via SDK. SDK encrypts it automatically. We don’t recommend to use the parameter to pass a plain password for direct call of API.
encryptedPassword	EncryptedPassword	string	Password of protected Word document. Use the parameter to pass an encrypted password for direct calls of API. See SDK code for encyption details.

GetFormFieldsOnlineRequest

Represents a request model for WordsApi.GetFormFieldsOnline() operation.

An object of the GetFormFieldsOnlineRequest class is created by the following constructor methods:

• GetFormFieldsOnlineRequest()
• GetFormFieldsOnlineRequest(Stream document, string nodePath, string loadEncoding, string password, string encryptedPassword)

Each of those arguments initializes the corresponding self-titled property:

Argument	Property	Type	Description
document	Document	Stream	The document.
nodePath	NodePath	string	The path to the node in the document tree.
loadEncoding	LoadEncoding	string	Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML.
password	Password	string	Password of protected Word document. Use the parameter to pass a password via SDK. SDK encrypts it automatically. We don’t recommend to use the parameter to pass a plain password for direct call of API.
encryptedPassword	EncryptedPassword	string	Password of protected Word document. Use the parameter to pass an encrypted password for direct calls of API. See SDK code for encyption details.

GetFormFieldsRequest

Represents a request model for WordsApi.GetFormFields() operation.

An object of the GetFormFieldsRequest class is created by the following constructor methods:

• GetFormFieldsRequest()
• GetFormFieldsRequest(string name, string nodePath, string folder, string storage, string loadEncoding, string password, string encryptedPassword)

Each of those arguments initializes the corresponding self-titled property:

Argument	Property	Type	Description
name	Name	string	The filename of the input document.
nodePath	NodePath	string	The path to the node in the document tree.
folder	Folder	string	Original document folder.
storage	Storage	string	Original document storage.
loadEncoding	LoadEncoding	string	Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML.
password	Password	string	Password of protected Word document. Use the parameter to pass a password via SDK. SDK encrypts it automatically. We don’t recommend to use the parameter to pass a plain password for direct call of API.
encryptedPassword	EncryptedPassword	string	Password of protected Word document. Use the parameter to pass an encrypted password for direct calls of API. See SDK code for encyption details.

InsertFormFieldOnlineRequest

Represents a request model for WordsApi.InsertFormFieldOnline() operation.

An object of the InsertFormFieldOnlineRequest class is created by the following constructor methods:

• InsertFormFieldOnlineRequest()
• InsertFormFieldOnlineRequest(Stream document, FormField formField, string nodePath, string loadEncoding, string password, string encryptedPassword, string destFileName, string revisionAuthor, string revisionDateTime, string insertBeforeNode)

Each of those arguments initializes the corresponding self-titled property:

Argument	Property	Type	Description
document	Document	Stream	The document.
formField	FormField	FormField	From field data.
nodePath	NodePath	string	The path to the node in the document tree.
loadEncoding	LoadEncoding	string	Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML.
password	Password	string	Password of protected Word document. Use the parameter to pass a password via SDK. SDK encrypts it automatically. We don’t recommend to use the parameter to pass a plain password for direct call of API.
encryptedPassword	EncryptedPassword	string	Password of protected Word document. Use the parameter to pass an encrypted password for direct calls of API. See SDK code for encyption details.
destFileName	DestFileName	string	Result path of the document after the operation. If this parameter is omitted then result of the operation will be saved as the source document.
revisionAuthor	RevisionAuthor	string	Initials of the author to use for revisions.If you set this parameter and then make some changes to the document programmatically, save the document and later open the document in MS Word you will see these changes as revisions.
revisionDateTime	RevisionDateTime	string	The date and time to use for revisions.
insertBeforeNode	InsertBeforeNode	string	The index of the node. A new form field will be inserted before the node with the specified node Id.

InsertFormFieldOnlineResponse

Represents a response model for WordsApi.InsertFormFieldOnline() operation.

An object of the InsertFormFieldOnlineResponse class is created by the following constructor methods:

• InsertFormFieldOnlineResponse(FormFieldResponse model, Dictionary<string,Stream> document)

Each of those arguments initializes the corresponding self-titled property:

Argument	Property	Type	Description
model	Model	FormFieldResponse	The response model.
document	Document	Dictionary<string,Stream>	The document after modification.

InsertFormFieldRequest

Represents a request model for WordsApi.InsertFormField() operation.

An object of the InsertFormFieldRequest class is created by the following constructor methods:

• InsertFormFieldRequest()
• InsertFormFieldRequest(string name, FormField formField, string nodePath, string folder, string storage, string loadEncoding, string password, string encryptedPassword, string destFileName, string revisionAuthor, string revisionDateTime, string insertBeforeNode)

Each of those arguments initializes the corresponding self-titled property:

Argument	Property	Type	Description
name	Name	string	The filename of the input document.
formField	FormField	FormField	From field data.
nodePath	NodePath	string	The path to the node in the document tree.
folder	Folder	string	Original document folder.
storage	Storage	string	Original document storage.
loadEncoding	LoadEncoding	string	Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML.
password	Password	string	Password of protected Word document. Use the parameter to pass a password via SDK. SDK encrypts it automatically. We don’t recommend to use the parameter to pass a plain password for direct call of API.
encryptedPassword	EncryptedPassword	string	Password of protected Word document. Use the parameter to pass an encrypted password for direct calls of API. See SDK code for encyption details.
destFileName	DestFileName	string	Result path of the document after the operation. If this parameter is omitted then result of the operation will be saved as the source document.
revisionAuthor	RevisionAuthor	string	Initials of the author to use for revisions.If you set this parameter and then make some changes to the document programmatically, save the document and later open the document in MS Word you will see these changes as revisions.
revisionDateTime	RevisionDateTime	string	The date and time to use for revisions.
insertBeforeNode	InsertBeforeNode	string	The index of the node. A new form field will be inserted before the node with the specified node Id.

UpdateFormFieldOnlineRequest

Represents a request model for WordsApi.UpdateFormFieldOnline() operation.

An object of the UpdateFormFieldOnlineRequest class is created by the following constructor methods:

• UpdateFormFieldOnlineRequest()
• UpdateFormFieldOnlineRequest(Stream document, FormField formField, int index, string nodePath, string loadEncoding, string password, string encryptedPassword, string destFileName, string revisionAuthor, string revisionDateTime)

Each of those arguments initializes the corresponding self-titled property:

Argument	Property	Type	Description
document	Document	Stream	The document.
formField	FormField	FormField	From field data.
index	Index	int	Object index.
nodePath	NodePath	string	The path to the node in the document tree.
loadEncoding	LoadEncoding	string	Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML.
password	Password	string	Password of protected Word document. Use the parameter to pass a password via SDK. SDK encrypts it automatically. We don’t recommend to use the parameter to pass a plain password for direct call of API.
encryptedPassword	EncryptedPassword	string	Password of protected Word document. Use the parameter to pass an encrypted password for direct calls of API. See SDK code for encyption details.
destFileName	DestFileName	string	Result path of the document after the operation. If this parameter is omitted then result of the operation will be saved as the source document.
revisionAuthor	RevisionAuthor	string	Initials of the author to use for revisions.If you set this parameter and then make some changes to the document programmatically, save the document and later open the document in MS Word you will see these changes as revisions.
revisionDateTime	RevisionDateTime	string	The date and time to use for revisions.

UpdateFormFieldOnlineResponse

Represents a response model for WordsApi.UpdateFormFieldOnline() operation.

An object of the UpdateFormFieldOnlineResponse class is created by the following constructor methods:

• UpdateFormFieldOnlineResponse(FormFieldResponse model, Dictionary<string,Stream> document)

Each of those arguments initializes the corresponding self-titled property:

Argument	Property	Type	Description
model	Model	FormFieldResponse	The response model.
document	Document	Dictionary<string,Stream>	The document after modification.

UpdateFormFieldRequest

Represents a request model for WordsApi.UpdateFormField() operation.

An object of the UpdateFormFieldRequest class is created by the following constructor methods:

• UpdateFormFieldRequest()
• UpdateFormFieldRequest(string name, int index, FormField formField, string nodePath, string folder, string storage, string loadEncoding, string password, string encryptedPassword, string destFileName, string revisionAuthor, string revisionDateTime)

Each of those arguments initializes the corresponding self-titled property:

Argument	Property	Type	Description
name	Name	string	The filename of the input document.
index	Index	int	Object index.
formField	FormField	FormField	From field data.
nodePath	NodePath	string	The path to the node in the document tree.
folder	Folder	string	Original document folder.
storage	Storage	string	Original document storage.
loadEncoding	LoadEncoding	string	Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML.
password	Password	string	Password of protected Word document. Use the parameter to pass a password via SDK. SDK encrypts it automatically. We don’t recommend to use the parameter to pass a plain password for direct call of API.
encryptedPassword	EncryptedPassword	string	Password of protected Word document. Use the parameter to pass an encrypted password for direct calls of API. See SDK code for encyption details.
destFileName	DestFileName	string	Result path of the document after the operation. If this parameter is omitted then result of the operation will be saved as the source document.
revisionAuthor	RevisionAuthor	string	Initials of the author to use for revisions.If you set this parameter and then make some changes to the document programmatically, save the document and later open the document in MS Word you will see these changes as revisions.
revisionDateTime	RevisionDateTime	string	The date and time to use for revisions.

FormFieldTextInput.TextInputTypeEnum

The following values are defined: Regular, Number, Date, CurrentDate, CurrentTime, Calculated.