ParagraphList

	Request	Response	Model
*Delete*	DeleteParagraphListFormatOnlineRequest	DeleteParagraphListFormatOnlineResponse
*Delete*	DeleteParagraphListFormatRequest	ParagraphListFormatResponse	ListFormat
*Get*	GetParagraphListFormatOnlineRequest
*Get*	GetParagraphListFormatRequest
*Update*	UpdateParagraphListFormatOnlineRequest	UpdateParagraphListFormatOnlineResponse	ListFormatUpdate
*Update*	UpdateParagraphListFormatRequest	ParagraphListFormatResponse	ListFormat ListFormatUpdate

ListFormat

Represents a dTO container with a paragraph list format element.

This class is inherited from LinkElement and used in ParagraphListFormatResponse.

The following properties are defined:

Property	Type	Description
Link	WordsApiLink	Gets or sets the link to the document.
IsListItem	bool	Gets or sets a value indicating whether the paragraph has bulleted or numbered formatting applied to it.
ListId	int	Gets or sets the list id of this paragraph.
ListLevelNumber	int	Gets or sets the list level number (0 to 8) for the paragraph.

ListFormatUpdate

Represents a paragraph list format element for update.

This class is used in UpdateParagraphListFormatOnlineRequest, UpdateParagraphListFormatRequest.

The following properties are defined:

Property	Type	Description
ListId	int	Gets or sets the list id of this paragraph.
ListLevelNumber	int	Gets or sets the list level number (0 to 8) for the paragraph.

DeleteParagraphListFormatOnlineRequest

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

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

DeleteParagraphListFormatOnlineRequest()
DeleteParagraphListFormatOnlineRequest(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.

DeleteParagraphListFormatOnlineResponse

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

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

DeleteParagraphListFormatOnlineResponse(ParagraphListFormatResponse model, Dictionary<string,Stream> document)

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

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

DeleteParagraphListFormatRequest

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

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

DeleteParagraphListFormatRequest()
DeleteParagraphListFormatRequest(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.

GetParagraphListFormatOnlineRequest

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

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

GetParagraphListFormatOnlineRequest()
GetParagraphListFormatOnlineRequest(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.

GetParagraphListFormatRequest

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

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

GetParagraphListFormatRequest()
GetParagraphListFormatRequest(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.

ParagraphListFormatResponse

Represents a REST response with a list format for a paragraph.

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

The following properties are defined:

Property	Type	Description
RequestId	string	Gets or sets the request Id.
ListFormat	ListFormat	Gets or sets the list format for a paragraph.

UpdateParagraphListFormatOnlineRequest

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

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

UpdateParagraphListFormatOnlineRequest()
UpdateParagraphListFormatOnlineRequest(Stream document, ListFormatUpdate listFormatDto, 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.
listFormatDto	ListFormatDto	ListFormatUpdate	ListFormatUpdate dto.
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.

UpdateParagraphListFormatOnlineResponse

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

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

UpdateParagraphListFormatOnlineResponse(ParagraphListFormatResponse model, Dictionary<string,Stream> document)

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

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

UpdateParagraphListFormatRequest

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

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

UpdateParagraphListFormatRequest()
UpdateParagraphListFormatRequest(string name, int index, ListFormatUpdate listFormatDto, 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.
listFormatDto	ListFormatDto	ListFormatUpdate	ListFormatUpdate dto.
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.

ParagraphFormat ParagraphTabStop