TableRow

Contents
[ ]
Request Response Model
Delete DeleteTableRowOnlineRequest Dictionary
DeleteTableRowRequest Task
Get GetTableRowFormatOnlineRequest TableRowFormatResponse TableRowFormat
GetTableRowFormatRequest
GetTableRowOnlineRequest TableRowResponse TableRow
GetTableRowRequest
Insert InsertTableRowOnlineRequest InsertTableRowOnlineResponse TableRowInsert
InsertTableRowRequest TableRowResponse TableRow
TableRowInsert
Update UpdateTableRowFormatOnlineRequest UpdateTableRowFormatOnlineResponse TableRowFormat
UpdateTableRowFormatRequest TableRowFormatResponse

TableRow

Represents a dTO container with a table row element.

This class is inherited from NodeLink and used in Table, TableRowResponse.

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.
RowFormat TableRowFormat Gets or sets the formatting properties of a row.
TableCellList List<TableCell> Gets or sets the collection of rows.

TableRowFormatDto

Represents a tableRowFormatDto.

TableRowInsertDto

Represents a dTO container with a table row element.

The following properties are defined:

Property Type Description
ColumnsCount int Gets or sets the count of columns. The default value is 1.
InsertAfter int Gets or sets table row will be inserted after row with specified 0-based index.

TableRowFormat

Represents a dTO container with formatting for a table row.

This class is inherited from LinkElement and used in TableRow, TableRowFormatResponse, UpdateTableRowFormatOnlineRequest, UpdateTableRowFormatRequest.

The following properties are defined:

Property Type Description
Link WordsApiLink Gets or sets the link to the document.
AllowBreakAcrossPages bool Gets or sets a value indicating whether the text in a table row is allowed to split across a page break.
HeadingFormat bool Gets or sets a value indicating whether the row is repeated as a table heading on every page when the table spans more than one page.
Height double Gets or sets the height of the table row in points.
HeightRule HeightRuleEnum Gets or sets the rule for determining the height of the table row.

TableRowInsert

Represents a dTO container with a table row element.

This class is used in InsertTableRowOnlineRequest, InsertTableRowRequest.

The following properties are defined:

Property Type Description
ColumnsCount int Gets or sets the count of columns. The default value is 1.
InsertAfter int Gets or sets table row will be inserted after row with specified 0-based index.

DeleteTableRowOnlineRequest

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

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

  • DeleteTableRowOnlineRequest()
  • DeleteTableRowOnlineRequest(Stream document, string tablePath, 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.
tablePath TablePath string The path to the table 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.

DeleteTableRowRequest

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

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

  • DeleteTableRowRequest()
  • DeleteTableRowRequest(string name, string tablePath, 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.
tablePath TablePath string The path to the table 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.

GetTableRowFormatOnlineRequest

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

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

  • GetTableRowFormatOnlineRequest()
  • GetTableRowFormatOnlineRequest(Stream document, string tablePath, 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.
tablePath TablePath string The path to the table 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.

GetTableRowFormatRequest

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

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

  • GetTableRowFormatRequest()
  • GetTableRowFormatRequest(string name, string tablePath, 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.
tablePath TablePath string The path to the table 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.

GetTableRowOnlineRequest

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

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

  • GetTableRowOnlineRequest()
  • GetTableRowOnlineRequest(Stream document, string tablePath, 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.
tablePath TablePath string The path to the table 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.

GetTableRowRequest

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

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

  • GetTableRowRequest()
  • GetTableRowRequest(string name, string tablePath, 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.
tablePath TablePath string The path to the table 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.

InsertTableRowOnlineRequest

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

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

  • InsertTableRowOnlineRequest()
  • InsertTableRowOnlineRequest(Stream document, string tablePath, TableRowInsert row, 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.
tablePath TablePath string The path to the table in the document tree.
row Row TableRowInsert Table row parameters.
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.

InsertTableRowOnlineResponse

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

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

  • InsertTableRowOnlineResponse(TableRowResponse model, Dictionary<string,Stream> document)

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

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

InsertTableRowRequest

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

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

  • InsertTableRowRequest()
  • InsertTableRowRequest(string name, string tablePath, TableRowInsert row, 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.
tablePath TablePath string The path to the table in the document tree.
row Row TableRowInsert Table row parameters.
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.

TableRowFormatResponse

Represents a REST response with the formatting properties of a table row.

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

The following properties are defined:

Property Type Description
RequestId string Gets or sets the request Id.
RowFormat TableRowFormat Gets or sets the formatting properties of a table row.

TableRowResponse

Represents a REST response with a table row.

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

The following properties are defined:

Property Type Description
RequestId string Gets or sets the request Id.
Row TableRow Gets or sets the table row.

UpdateTableRowFormatOnlineRequest

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

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

  • UpdateTableRowFormatOnlineRequest()
  • UpdateTableRowFormatOnlineRequest(Stream document, string tablePath, TableRowFormat format, 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.
tablePath TablePath string The path to the table in the document tree.
format Format TableRowFormat Table row format.
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.

UpdateTableRowFormatOnlineResponse

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

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

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

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

UpdateTableRowFormatRequest

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

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

  • UpdateTableRowFormatRequest()
  • UpdateTableRowFormatRequest(string name, string tablePath, int index, TableRowFormat format, 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.
tablePath TablePath string The path to the table in the document tree.
index Index int Object index.
format Format TableRowFormat Table row format.
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.

TableRowFormat.HeightRuleEnum

The following values are defined: AtLeast, Exactly, Auto.