ParagraphTabStop

Contents
[ ]
Request Response Model
DeleteAll DeleteAllParagraphTabStopsOnlineRequest DeleteAllParagraphTabStopsOnlineResponse
DeleteAllParagraphTabStopsRequest TabStopsResponse TabStop
Delete DeleteParagraphTabStopOnlineRequest DeleteParagraphTabStopOnlineResponse
DeleteParagraphTabStopRequest TabStopsResponse TabStop
Get GetParagraphTabStopsOnlineRequest
GetParagraphTabStopsRequest
InsertOrUpdate InsertOrUpdateParagraphTabStopOnlineRequest InsertOrUpdateParagraphTabStopOnlineResponse TabStopInsert
InsertOrUpdateParagraphTabStopRequest TabStopsResponse TabStop
TabStopInsert

TabStopBase

Represents a base class for paragraph format tab stop DTO.

The following properties are defined:

Property Type Description
Alignment AlignmentEnum Gets or sets the alignment of text at this tab stop.
Leader LeaderEnum Gets or sets the type of the leader line displayed under the tab character.
Position double Gets or sets the position of the tab stop in points.

TabStop

Represents a dTO container with paragraph format tab stop.

This class is inherited from TabStopBase and used in TabStopsResponse.

The following properties are defined:

Property Type Description
Alignment AlignmentEnum Gets or sets the alignment of text at this tab stop.
Leader LeaderEnum Gets or sets the type of the leader line displayed under the tab character.
Position double Gets or sets the position of the tab stop in points.
IsClear bool Gets or sets a value indicating whether this tab stop clears any existing tab stops in this position.

TabStopInsert

Represents a DTO to Insert / replace a tab stop.

This class is inherited from TabStopBase and used in InsertOrUpdateParagraphTabStopOnlineRequest, InsertOrUpdateParagraphTabStopRequest.

The following properties are defined:

Property Type Description
Alignment AlignmentEnum Gets or sets the alignment of text at this tab stop.
Leader LeaderEnum Gets or sets the type of the leader line displayed under the tab character.
Position double Gets or sets the position of the tab stop in points.

DeleteAllParagraphTabStopsOnlineRequest

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

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

  • DeleteAllParagraphTabStopsOnlineRequest()
  • DeleteAllParagraphTabStopsOnlineRequest(Stream document, int index, string nodePath, string loadEncoding, string password, string encryptedPassword, string destFileName)

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.

DeleteAllParagraphTabStopsOnlineResponse

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

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

  • DeleteAllParagraphTabStopsOnlineResponse(TabStopsResponse model, Dictionary<string,Stream> document)

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

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

DeleteAllParagraphTabStopsRequest

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

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

  • DeleteAllParagraphTabStopsRequest()
  • DeleteAllParagraphTabStopsRequest(string name, int index, string nodePath, string folder, string storage, string loadEncoding, string password, string encryptedPassword, string destFileName)

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.

DeleteParagraphTabStopOnlineRequest

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

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

  • DeleteParagraphTabStopOnlineRequest()
  • DeleteParagraphTabStopOnlineRequest(Stream document, double position, int index, string nodePath, string loadEncoding, string password, string encryptedPassword, string destFileName)

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

Argument Property Type Description
document Document Stream The document.
position Position double The position of a tab stop to remove.
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.

DeleteParagraphTabStopOnlineResponse

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

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

  • DeleteParagraphTabStopOnlineResponse(TabStopsResponse model, Dictionary<string,Stream> document)

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

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

DeleteParagraphTabStopRequest

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

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

  • DeleteParagraphTabStopRequest()
  • DeleteParagraphTabStopRequest(string name, double position, int index, string nodePath, string folder, string storage, string loadEncoding, string password, string encryptedPassword, string destFileName)

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

Argument Property Type Description
name Name string The filename of the input document.
position Position double The position of a tab stop to remove.
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.

GetParagraphTabStopsOnlineRequest

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

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

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

GetParagraphTabStopsRequest

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

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

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

InsertOrUpdateParagraphTabStopOnlineRequest

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

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

  • InsertOrUpdateParagraphTabStopOnlineRequest()
  • InsertOrUpdateParagraphTabStopOnlineRequest(Stream document, TabStopInsert tabStopInsertDto, int index, string nodePath, string loadEncoding, string password, string encryptedPassword, string destFileName)

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

Argument Property Type Description
document Document Stream The document.
tabStopInsertDto TabStopInsertDto TabStopInsert TabStopInsert 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.

InsertOrUpdateParagraphTabStopOnlineResponse

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

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

  • InsertOrUpdateParagraphTabStopOnlineResponse(TabStopsResponse model, Dictionary<string,Stream> document)

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

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

InsertOrUpdateParagraphTabStopRequest

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

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

  • InsertOrUpdateParagraphTabStopRequest()
  • InsertOrUpdateParagraphTabStopRequest(string name, int index, TabStopInsert tabStopInsertDto, string nodePath, string folder, string storage, string loadEncoding, string password, string encryptedPassword, string destFileName)

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.
tabStopInsertDto TabStopInsertDto TabStopInsert TabStopInsert 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.

TabStopsResponse

Represents a REST response with an array of tab stops.

This class is inherited from WordsResponse and used in WordsApi, DeleteAllParagraphTabStopsOnlineResponse, DeleteParagraphTabStopOnlineResponse, InsertOrUpdateParagraphTabStopOnlineResponse.

The following properties are defined:

Property Type Description
RequestId string Gets or sets the request Id.
TabStops List<TabStop> Gets or sets the array of tab stops.

TabStopBase.AlignmentEnum

The following values are defined: Left, Center, Right, Decimal, Bar, List, Clear.

TabStopBase.LeaderEnum

The following values are defined: None, Dots, Dashes, Line, Heavy, MiddleDot.