Paragraph

	Request	Response	Model
*Delete*	DeleteParagraphOnlineRequest	Dictionary
*Delete*	DeleteParagraphRequest	Task
*Get*	GetParagraphOnlineRequest	ParagraphResponse	Paragraph
	GetParagraphRequest	ParagraphResponse	Paragraph
	GetParagraphsOnlineRequest	ParagraphLinkCollectionResponse	ParagraphLinkCollection
	GetParagraphsRequest	ParagraphLinkCollectionResponse	ParagraphLinkCollection
*Insert*	InsertParagraphOnlineRequest	InsertParagraphOnlineResponse	ParagraphInsert
*Insert*	InsertParagraphRequest	ParagraphResponse	Paragraph ParagraphInsert
*Render*	RenderParagraphOnlineRequest	Stream
*Render*	RenderParagraphRequest	Stream

Paragraph

Represents a dTO container with a paragraph element.

This class is inherited from NodeLink and used in ParagraphResponse.

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.
ChildNodes	List<NodeLink>	Gets or sets the list of child nodes.

ParagraphInsert

Represents a dTO container with a paragraph’s text.

This class is used in InsertParagraphOnlineRequest, InsertParagraphRequest.

A single Text property is defined:

Property	Type	Description
Text	string	Gets or sets the paragraph’s text.

ParagraphLink

Represents a paragraph link element.

This class is inherited from NodeLink and used in ParagraphLinkCollection.

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.
Text	string	Gets or sets the paragraph’s text.

ParagraphLinkCollection

Represents a collection of paragraph’s links.

This class is inherited from LinkElement and used in ParagraphLinkCollectionResponse.

The following properties are defined:

Property	Type	Description
Link	WordsApiLink	Gets or sets the link to the document.
ParagraphLinkList	List<ParagraphLink>	Gets or sets the collection of paragraph’s links.

DeleteParagraphOnlineRequest

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

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

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

DeleteParagraphRequest

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

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

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

GetParagraphOnlineRequest

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

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

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

GetParagraphRequest

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

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

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

GetParagraphsOnlineRequest

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

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

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

GetParagraphsRequest

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

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

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

InsertParagraphOnlineRequest

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

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

InsertParagraphOnlineRequest()
InsertParagraphOnlineRequest(Stream document, ParagraphInsert paragraph, 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.
paragraph	Paragraph	ParagraphInsert	Paragraph 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 paragraph will be inserted before the node with the specified index.

InsertParagraphOnlineResponse

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

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

InsertParagraphOnlineResponse(ParagraphResponse model, Dictionary<string,Stream> document)

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

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

InsertParagraphRequest

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

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

InsertParagraphRequest()
InsertParagraphRequest(string name, ParagraphInsert paragraph, 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.
paragraph	Paragraph	ParagraphInsert	Paragraph 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 paragraph will be inserted before the node with the specified index.

ParagraphLinkCollectionResponse

Represents a REST response with a collection of paragraphs.

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.
Paragraphs	ParagraphLinkCollection	Gets or sets the collection of paragraphs.

ParagraphResponse

Represents a REST response with a paragraph.

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

The following properties are defined:

Property	Type	Description
RequestId	string	Gets or sets the request Id.
Paragraph	Paragraph	Gets or sets the paragraph.

RenderParagraphOnlineRequest

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

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

RenderParagraphOnlineRequest()
RenderParagraphOnlineRequest(Stream document, string format, int index, string nodePath, string loadEncoding, string password, string encryptedPassword, string destFileName, string fontsLocation)

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

Argument	Property	Type	Description
document	Document	Stream	The document.
format	Format	string	The destination format.
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.
fontsLocation	FontsLocation	string	Folder in filestorage with custom fonts.

RenderParagraphRequest

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

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

RenderParagraphRequest()
RenderParagraphRequest(string name, string format, int index, string nodePath, string folder, string storage, string loadEncoding, string password, string encryptedPassword, string destFileName, string fontsLocation)

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

Argument	Property	Type	Description
name	Name	string	The filename of the input document.
format	Format	string	The destination format.
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.
fontsLocation	FontsLocation	string	Folder in filestorage with custom fonts.

Page ParagraphFormat