DocumentProperties

	Request	Response	Model
CreateOrUpdate	CreateOrUpdateDocumentPropertyOnlineRequest	CreateOrUpdateDocumentPropertyOnlineResponse	DocumentPropertyCreateOrUpdate
	CreateOrUpdateDocumentPropertyRequest	DocumentPropertyResponse	DocumentProperty DocumentPropertyCreateOrUpdate
Delete	DeleteDocumentPropertyOnlineRequest	Dictionary
	DeleteDocumentPropertyRequest	Task
Get	GetDocumentPropertiesOnlineRequest	DocumentPropertiesResponse	DocumentProperties
	GetDocumentPropertiesRequest
	GetDocumentPropertyOnlineRequest	DocumentPropertyResponse	DocumentProperty
	GetDocumentPropertyRequest

DocumentProperties

Represents a collection of document properties.

This class is inherited from LinkElement and used in Document, DocumentPropertiesResponse.

The following properties are defined:

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

DocumentPropertyBase

Represents a words document property DTO base class.

A single Value property is defined:

Property	Type	Description
Value	string	Gets or sets the value of the document property.

DocumentProperty

Represents a words document property DTO.

This class is inherited from LinkElement and used in DocumentProperties, DocumentPropertyResponse.

The following properties are defined:

Property	Type	Description
Link	WordsApiLink	Gets or sets the link to the document.
BuiltIn	bool	Gets or sets a value indicating whether the property is built-in or not. If true the property is built-in, if false the property is custom.
Name	string	Gets or sets the name of the document property.
Value	string	Gets or sets the value of the document property.

DocumentPropertyCreateOrUpdate

Represents a words document property DTO for create or update.

This class is inherited from DocumentPropertyBase and used in CreateOrUpdateDocumentPropertyOnlineRequest, CreateOrUpdateDocumentPropertyRequest.

A single Value property is defined:

Property	Type	Description
Value	string	Gets or sets the value of the document property.

DocumentPropertiesResponse

Represents a REST response with a collection of document properties.

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.
DocumentProperties	DocumentProperties	Gets or sets the collection of document properties.

CreateOrUpdateDocumentPropertyOnlineRequest

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

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

• CreateOrUpdateDocumentPropertyOnlineRequest()
• CreateOrUpdateDocumentPropertyOnlineRequest(Stream document, string propertyName, DocumentPropertyCreateOrUpdate property, 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.
propertyName	PropertyName	string	The name of the property.
property	Property	DocumentPropertyCreateOrUpdate	The property with new value.
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.

CreateOrUpdateDocumentPropertyOnlineResponse

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

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

• CreateOrUpdateDocumentPropertyOnlineResponse(DocumentPropertyResponse model, Dictionary<string,Stream> document)

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

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

CreateOrUpdateDocumentPropertyRequest

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

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

• CreateOrUpdateDocumentPropertyRequest()
• CreateOrUpdateDocumentPropertyRequest(string name, string propertyName, DocumentPropertyCreateOrUpdate property, 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.
propertyName	PropertyName	string	The name of the property.
property	Property	DocumentPropertyCreateOrUpdate	The property with new value.
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.

DeleteDocumentPropertyOnlineRequest

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

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

• DeleteDocumentPropertyOnlineRequest()
• DeleteDocumentPropertyOnlineRequest(Stream document, string propertyName, 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.
propertyName	PropertyName	string	The name of the property.
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.

DeleteDocumentPropertyRequest

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

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

• DeleteDocumentPropertyRequest()
• DeleteDocumentPropertyRequest(string name, string propertyName, 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.
propertyName	PropertyName	string	The name of the property.
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.

DocumentPropertyResponse

Represents a REST response with a document property.

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

The following properties are defined:

Property	Type	Description
RequestId	string	Gets or sets the request Id.
DocumentProperty	DocumentProperty	Gets or sets the document property.

GetDocumentPropertiesOnlineRequest

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

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

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

GetDocumentPropertiesRequest

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

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

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

GetDocumentPropertyOnlineRequest

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

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

• GetDocumentPropertyOnlineRequest()
• GetDocumentPropertyOnlineRequest(Stream document, string propertyName, 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.
propertyName	PropertyName	string	The name of the property.
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.

GetDocumentPropertyRequest

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

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

• GetDocumentPropertyRequest()
• GetDocumentPropertyRequest(string name, string propertyName, 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.
propertyName	PropertyName	string	The name of the property.
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.