Run

	Request	Response	Model
Delete	DeleteRunOnlineRequest	Dictionary
	DeleteRunRequest	Task
Get	GetRunFontOnlineRequest	FontResponse	Font
	GetRunFontRequest
	GetRunOnlineRequest	RunResponse	Run
	GetRunRequest
	GetRunsOnlineRequest	RunsResponse	Runs
	GetRunsRequest
Insert	InsertRunOnlineRequest	InsertRunOnlineResponse	RunInsert
	InsertRunRequest	RunResponse	Run RunInsert
Update	UpdateRunFontOnlineRequest	UpdateRunFontOnlineResponse	Font
	UpdateRunFontRequest	FontResponse
	UpdateRunOnlineRequest	UpdateRunOnlineResponse	RunUpdate
	UpdateRunRequest	RunResponse	Run RunUpdate

Run

Represents a run element.

This class is inherited from RunLink and used in RunResponse, Runs.

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 run’s text.

RunBase

Represents a run element.

A single Text property is defined:

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

RunInsert

Represents a run element for insert.

This class is inherited from RunBase and used in InsertRunOnlineRequest, InsertRunRequest.

A single Text property is defined:

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

RunLink

Represents a run link element.

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 run’s text.

Runs

Represents a dTO container with a collection of runs.

This class is inherited from LinkElement and used in RunsResponse.

The following properties are defined:

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

RunUpdate

Represents a run element for insert.

This class is inherited from RunBase and used in UpdateRunOnlineRequest, UpdateRunRequest.

A single Text property is defined:

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

DeleteRunOnlineRequest

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

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

• DeleteRunOnlineRequest()
• DeleteRunOnlineRequest(Stream document, string paragraphPath, int index, 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.
paragraphPath	ParagraphPath	string	The path to the paragraph in the document tree.
index	Index	int	Object index.
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.

DeleteRunRequest

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

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

• DeleteRunRequest()
• DeleteRunRequest(string name, string paragraphPath, int index, 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.
paragraphPath	ParagraphPath	string	The path to the paragraph in the document tree.
index	Index	int	Object index.
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.

FontResponse

Represents a REST response with a font.

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

The following properties are defined:

Property	Type	Description
RequestId	string	Gets or sets the request Id.
Font	Font	Gets or sets the font.

GetRunFontOnlineRequest

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

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

• GetRunFontOnlineRequest()
• GetRunFontOnlineRequest(Stream document, string paragraphPath, int index, 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.
paragraphPath	ParagraphPath	string	The path to the paragraph in the document tree.
index	Index	int	Object index.
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.

GetRunFontRequest

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

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

• GetRunFontRequest()
• GetRunFontRequest(string name, string paragraphPath, int index, 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.
paragraphPath	ParagraphPath	string	The path to the paragraph in the document tree.
index	Index	int	Object index.
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.

GetRunOnlineRequest

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

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

• GetRunOnlineRequest()
• GetRunOnlineRequest(Stream document, string paragraphPath, int index, 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.
paragraphPath	ParagraphPath	string	The path to the paragraph in the document tree.
index	Index	int	Object index.
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.

GetRunRequest

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

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

• GetRunRequest()
• GetRunRequest(string name, string paragraphPath, int index, 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.
paragraphPath	ParagraphPath	string	The path to the paragraph in the document tree.
index	Index	int	Object index.
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.

GetRunsOnlineRequest

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

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

• GetRunsOnlineRequest()
• GetRunsOnlineRequest(Stream document, string paragraphPath, 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.
paragraphPath	ParagraphPath	string	The path to the paragraph 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.

GetRunsRequest

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

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

• GetRunsRequest()
• GetRunsRequest(string name, string paragraphPath, 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.
paragraphPath	ParagraphPath	string	The path to the paragraph 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.

InsertRunOnlineRequest

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

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

• InsertRunOnlineRequest()
• InsertRunOnlineRequest(Stream document, string paragraphPath, RunInsert run, 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.
paragraphPath	ParagraphPath	string	The path to the paragraph in the document tree.
run	Run	RunInsert	Run data.
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 Run object will be inserted before the node with the specified node Id.

InsertRunOnlineResponse

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

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

• InsertRunOnlineResponse(RunResponse model, Dictionary<string,Stream> document)

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

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

InsertRunRequest

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

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

• InsertRunRequest()
• InsertRunRequest(string name, string paragraphPath, RunInsert run, 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.
paragraphPath	ParagraphPath	string	The path to the paragraph in the document tree.
run	Run	RunInsert	Run data.
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 Run object will be inserted before the node with the specified node Id.

RunResponse

Represents a REST response with a Run element.

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

The following properties are defined:

Property	Type	Description
RequestId	string	Gets or sets the request Id.
Run	Run	Gets or sets the Run element.

RunsResponse

Represents a REST response with a collection of Run elements.

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.
Runs	Runs	Gets or sets the collection of Run elements.

UpdateRunFontOnlineRequest

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

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

• UpdateRunFontOnlineRequest()
• UpdateRunFontOnlineRequest(Stream document, string paragraphPath, Font fontDto, int index, 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.
paragraphPath	ParagraphPath	string	The path to the paragraph in the document tree.
fontDto	FontDto	Font	Font dto object.
index	Index	int	Object index.
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.

UpdateRunFontOnlineResponse

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

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

• UpdateRunFontOnlineResponse(FontResponse model, Dictionary<string,Stream> document)

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

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

UpdateRunFontRequest

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

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

• UpdateRunFontRequest()
• UpdateRunFontRequest(string name, string paragraphPath, int index, Font fontDto, 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.
paragraphPath	ParagraphPath	string	The path to the paragraph in the document tree.
index	Index	int	Object index.
fontDto	FontDto	Font	Font dto object.
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.

UpdateRunOnlineRequest

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

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

• UpdateRunOnlineRequest()
• UpdateRunOnlineRequest(Stream document, string paragraphPath, RunUpdate run, int index, 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.
paragraphPath	ParagraphPath	string	The path to the paragraph in the document tree.
run	Run	RunUpdate	Run data.
index	Index	int	Object index.
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.

UpdateRunOnlineResponse

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

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

• UpdateRunOnlineResponse(RunResponse model, Dictionary<string,Stream> document)

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

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

UpdateRunRequest

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

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

• UpdateRunRequest()
• UpdateRunRequest(string name, string paragraphPath, int index, RunUpdate run, 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.
paragraphPath	ParagraphPath	string	The path to the paragraph in the document tree.
index	Index	int	Object index.
run	Run	RunUpdate	Run data.
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.