CustomXmlPart

	Request	Response	Model
Delete	DeleteCustomXmlPartOnlineRequest	Dictionary
	DeleteCustomXmlPartRequest	Task
	DeleteCustomXmlPartsOnlineRequest	Dictionary
	DeleteCustomXmlPartsRequest	Task
Get	GetCustomXmlPartOnlineRequest	CustomXmlPartResponse	CustomXmlPart
	GetCustomXmlPartRequest
	GetCustomXmlPartsOnlineRequest	CustomXmlPartsResponse	CustomXmlPartsCollection
	GetCustomXmlPartsRequest
Insert	InsertCustomXmlPartOnlineRequest	InsertCustomXmlPartOnlineResponse	CustomXmlPartInsert
	InsertCustomXmlPartRequest	CustomXmlPartResponse	CustomXmlPart CustomXmlPartInsert
Update	UpdateCustomXmlPartOnlineRequest	UpdateCustomXmlPartOnlineResponse	CustomXmlPartUpdate
	UpdateCustomXmlPartRequest	CustomXmlPartResponse	CustomXmlPart CustomXmlPartUpdate

CustomXmlPart

Represents a dTO container with a CustomXmlPart.

This class is inherited from CustomXmlPartLink and used in CustomXmlPartResponse, CustomXmlPartsCollection.

The following properties are defined:

Property	Type	Description
Link	WordsApiLink	Gets or sets the link to the document.
Data	string	Gets or sets the custom xml part data.
Id	string	Gets or sets the custom xml part id.

CustomXmlPartInsert

Represents a custom xml part insert.

This class is inherited from CustomXmlPart and used in InsertCustomXmlPartOnlineRequest, InsertCustomXmlPartRequest.

The following properties are defined:

Property	Type	Description
Link	WordsApiLink	Gets or sets the link to the document.
Data	string	Gets or sets the custom xml part data.
Id	string	Gets or sets the custom xml part id.

CustomXmlPartLink

Represents a customXmlPart link.

A single Link property is defined:

Property	Type	Description
Link	WordsApiLink	Gets or sets the link to the document.

CustomXmlPartsCollection

Represents a collection of CustomXmlPart.

This class is inherited from LinkElement and used in CustomXmlPartsResponse.

The following properties are defined:

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

CustomXmlPartUpdate

Represents a custom xml part update.

This class is inherited from CustomXmlPart and used in UpdateCustomXmlPartOnlineRequest, UpdateCustomXmlPartRequest.

The following properties are defined:

Property	Type	Description
Link	WordsApiLink	Gets or sets the link to the document.
Data	string	Gets or sets the custom xml part data.
Id	string	Gets or sets the custom xml part id.

CustomXmlPartResponse

Represents a REST response with a custom xml part.

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

The following properties are defined:

Property	Type	Description
RequestId	string	Gets or sets the request Id.
CustomXmlPart	CustomXmlPart	Gets or sets the custom xml part.

CustomXmlPartsResponse

Represents a REST response with a collection of custom xml parts.

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.
CustomXmlParts	CustomXmlPartsCollection	Gets or sets the collection of comments.

DeleteCustomXmlPartOnlineRequest

Represents a request model for WordsApi operation.

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

• DeleteCustomXmlPartOnlineRequest()
• DeleteCustomXmlPartOnlineRequest(Stream document, int customXmlPartIndex, 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.
customXmlPartIndex	CustomXmlPartIndex	int	The index of the custom xml part. This index is the number of the entry in the collection of custom xml parts, not the ID of the part.
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.

DeleteCustomXmlPartRequest

Represents a request model for WordsApi operation.

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

• DeleteCustomXmlPartRequest()
• DeleteCustomXmlPartRequest(string name, int customXmlPartIndex, 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.
customXmlPartIndex	CustomXmlPartIndex	int	The index of the custom xml part. This index is the number of the entry in the collection of custom xml parts, not the ID of the part.
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.

DeleteCustomXmlPartsOnlineRequest

Represents a request model for WordsApi operation.

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

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

DeleteCustomXmlPartsRequest

Represents a request model for WordsApi operation.

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

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

GetCustomXmlPartOnlineRequest

Represents a request model for WordsApi operation.

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

• GetCustomXmlPartOnlineRequest()
• GetCustomXmlPartOnlineRequest(Stream document, int customXmlPartIndex, 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.
customXmlPartIndex	CustomXmlPartIndex	int	The index of the custom xml part. This index is the number of the entry in the collection of custom xml parts, not the ID of the part.
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.

GetCustomXmlPartRequest

Represents a request model for WordsApi operation.

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

• GetCustomXmlPartRequest()
• GetCustomXmlPartRequest(string name, int customXmlPartIndex, 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.
customXmlPartIndex	CustomXmlPartIndex	int	The index of the custom xml part. This index is the number of the entry in the collection of custom xml parts, not the ID of the part.
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.

GetCustomXmlPartsOnlineRequest

Represents a request model for WordsApi operation.

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

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

GetCustomXmlPartsRequest

Represents a request model for WordsApi operation.

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

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

InsertCustomXmlPartOnlineRequest

Represents a request model for WordsApi operation.

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

• InsertCustomXmlPartOnlineRequest()
• InsertCustomXmlPartOnlineRequest(Stream document, CustomXmlPartInsert customXmlPart, 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.
customXmlPart	CustomXmlPart	CustomXmlPartInsert	Custom xml part.
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.

InsertCustomXmlPartOnlineResponse

Represents a response model for WordsApi operation.

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

• InsertCustomXmlPartOnlineResponse(CustomXmlPartResponse model, Dictionary<string,Stream> document)

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

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

InsertCustomXmlPartRequest

Represents a request model for WordsApi operation.

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

• InsertCustomXmlPartRequest()
• InsertCustomXmlPartRequest(string name, CustomXmlPartInsert customXmlPart, 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.
customXmlPart	CustomXmlPart	CustomXmlPartInsert	Custom xml part.
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.

UpdateCustomXmlPartOnlineRequest

Represents a request model for WordsApi operation.

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

• UpdateCustomXmlPartOnlineRequest()
• UpdateCustomXmlPartOnlineRequest(Stream document, int customXmlPartIndex, CustomXmlPartUpdate customXmlPart, 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.
customXmlPartIndex	CustomXmlPartIndex	int	The index of the custom xml part. This index is the number of the entry in the collection of custom xml parts, not the ID of the part.
customXmlPart	CustomXmlPart	CustomXmlPartUpdate	Custom xml part.
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.

UpdateCustomXmlPartOnlineResponse

Represents a response model for WordsApi operation.

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

• UpdateCustomXmlPartOnlineResponse(CustomXmlPartResponse model, Dictionary<string,Stream> document)

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

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

UpdateCustomXmlPartRequest

Represents a request model for WordsApi operation.

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

• UpdateCustomXmlPartRequest()
• UpdateCustomXmlPartRequest(string name, int customXmlPartIndex, CustomXmlPartUpdate customXmlPart, 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.
customXmlPartIndex	CustomXmlPartIndex	int	The index of the custom xml part. This index is the number of the entry in the collection of custom xml parts, not the ID of the part.
customXmlPart	CustomXmlPart	CustomXmlPartUpdate	Custom xml part.
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.