Field

Contents
[ ]
Request Response Model
Delete DeleteFieldOnlineRequest Dictionary
DeleteFieldRequest Task
DeleteFieldsOnlineRequest Dictionary
DeleteFieldsRequest Task
Get GetDocumentFieldNamesOnlineRequest FieldNamesResponse FieldNames
GetDocumentFieldNamesRequest
GetFieldOnlineRequest FieldResponse Field
GetFieldRequest
GetFieldsOnlineRequest FieldsResponse FieldCollection
GetFieldsRequest
Insert InsertFieldOnlineRequest InsertFieldOnlineResponse FieldInsert
InsertFieldRequest FieldResponse Field
FieldInsert
Update UpdateFieldOnlineRequest UpdateFieldOnlineResponse FieldUpdate
UpdateFieldRequest FieldResponse Field
FieldUpdate
UpdateFieldsOnlineRequest UpdateFieldsOnlineResponse
UpdateFieldsRequest DocumentResponse Document

Field

Represents a dTO container with a field.

This class is inherited from FieldLink and used in FieldCollection, FieldResponse.

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.
FieldCode string Gets or sets the field code.
LocaleId string Gets or sets the LCID of the field.
Result string Gets or sets the field result.

FieldBase

Represents a field.

The following properties are defined:

Property Type Description
FieldCode string Gets or sets the field code.
LocaleId string Gets or sets the LCID of the field.

FieldCollection

Represents a dTO container with a collection of fields.

This class is inherited from LinkElement and used in FieldsResponse.

The following properties are defined:

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

FieldInsert

Represents a field for insert.

This class is inherited from FieldBase and used in InsertFieldOnlineRequest, InsertFieldRequest.

The following properties are defined:

Property Type Description
FieldCode string Gets or sets the field code.
LocaleId string Gets or sets the LCID of the field.

Represents a field link.

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.
FieldCode string Gets or sets the field code.

FieldNames

Represents a collection of merge fields within a document.

This class is inherited from LinkElement and used in FieldNamesResponse.

The following properties are defined:

Property Type Description
Link WordsApiLink Gets or sets the link to the document.
Names List<string> Gets or sets the collection of fields names.

FieldUpdate

Represents a field for update.

This class is inherited from FieldBase and used in UpdateFieldOnlineRequest, UpdateFieldRequest.

The following properties are defined:

Property Type Description
FieldCode string Gets or sets the field code.
LocaleId string Gets or sets the LCID of the field.

FieldNamesResponse

Represents a REST response with a collection of mail merge 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.
FieldNames FieldNames Gets or sets the collection of mail merge fields.

DeleteFieldOnlineRequest

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

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

  • DeleteFieldOnlineRequest()
  • DeleteFieldOnlineRequest(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.

DeleteFieldRequest

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

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

  • DeleteFieldRequest()
  • DeleteFieldRequest(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.

DeleteFieldsOnlineRequest

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

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

  • DeleteFieldsOnlineRequest()
  • DeleteFieldsOnlineRequest(Stream document, 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.
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.

DeleteFieldsRequest

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

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

  • DeleteFieldsRequest()
  • DeleteFieldsRequest(string name, 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.
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.

FieldResponse

Represents a REST response with a field.

This class is inherited from WordsResponse and used in WordsApi, InsertFieldOnlineResponse, UpdateFieldOnlineResponse.

The following properties are defined:

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

FieldsResponse

Represents a REST response with a collection of 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.
Fields FieldCollection Gets or sets the collection of fields.

GetDocumentFieldNamesOnlineRequest

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

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

  • GetDocumentFieldNamesOnlineRequest()
  • GetDocumentFieldNamesOnlineRequest(Stream template, string loadEncoding, string password, string encryptedPassword, bool? useNonMergeFields)

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

Argument Property Type Description
template Template Stream The template document.
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.
useNonMergeFields UseNonMergeFields bool? The flag indicating whether to use non merge fields. If true, result includes “mustache” field names.

GetDocumentFieldNamesRequest

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

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

  • GetDocumentFieldNamesRequest()
  • GetDocumentFieldNamesRequest(string name, string folder, string storage, string loadEncoding, string password, string encryptedPassword, bool? useNonMergeFields)

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

Argument Property Type Description
name Name string The filename of the input document.
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.
useNonMergeFields UseNonMergeFields bool? The flag indicating whether to use non merge fields. If true, result includes “mustache” field names.

GetFieldOnlineRequest

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

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

  • GetFieldOnlineRequest()
  • GetFieldOnlineRequest(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.

GetFieldRequest

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

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

  • GetFieldRequest()
  • GetFieldRequest(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.

GetFieldsOnlineRequest

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

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

  • GetFieldsOnlineRequest()
  • GetFieldsOnlineRequest(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.

GetFieldsRequest

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

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

  • GetFieldsRequest()
  • GetFieldsRequest(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.

InsertFieldOnlineRequest

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

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

  • InsertFieldOnlineRequest()
  • InsertFieldOnlineRequest(Stream document, FieldInsert field, 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.
field Field FieldInsert 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 field will be inserted before the node with the specified node Id.

InsertFieldOnlineResponse

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

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

  • InsertFieldOnlineResponse(FieldResponse model, Dictionary<string,Stream> document)

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

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

InsertFieldRequest

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

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

  • InsertFieldRequest()
  • InsertFieldRequest(string name, FieldInsert field, 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.
field Field FieldInsert 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 field will be inserted before the node with the specified node Id.

UpdateFieldOnlineRequest

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

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

  • UpdateFieldOnlineRequest()
  • UpdateFieldOnlineRequest(Stream document, FieldUpdate field, 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.
field Field FieldUpdate 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.

UpdateFieldOnlineResponse

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

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

  • UpdateFieldOnlineResponse(FieldResponse model, Dictionary<string,Stream> document)

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

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

UpdateFieldRequest

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

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

  • UpdateFieldRequest()
  • UpdateFieldRequest(string name, int index, FieldUpdate field, 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.
field Field FieldUpdate 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.

UpdateFieldsOnlineRequest

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

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

  • UpdateFieldsOnlineRequest()
  • UpdateFieldsOnlineRequest(Stream document, string loadEncoding, string password, string encryptedPassword, string destFileName)

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

Argument Property Type Description
document Document Stream The document.
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.

UpdateFieldsOnlineResponse

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

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

  • UpdateFieldsOnlineResponse(DocumentResponse model, Dictionary<string,Stream> document)

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

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

UpdateFieldsRequest

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

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

  • UpdateFieldsRequest()
  • UpdateFieldsRequest(string name, string folder, string storage, string loadEncoding, string password, string encryptedPassword, string destFileName)

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

Argument Property Type Description
name Name string The filename of the input document.
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.

FieldOptions.FieldIndexFormatEnum

The following values are defined: Template, Classic, Fancy, Modern, Bulleted, Formal, Simple.

FieldOptions.FieldUpdateCultureSourceEnum

The following values are defined: CurrentThread, FieldCode.