TableCell

Contents
[ ]
Request Response Model
Delete DeleteTableCellOnlineRequest Dictionary
DeleteTableCellRequest Task
Get GetTableCellFormatOnlineRequest TableCellFormatResponse TableCellFormat
GetTableCellFormatRequest
GetTableCellOnlineRequest TableCellResponse TableCell
GetTableCellRequest
Insert InsertTableCellOnlineRequest InsertTableCellOnlineResponse TableCellInsert
InsertTableCellRequest TableCellResponse TableCell
TableCellInsert
Update UpdateTableCellFormatOnlineRequest UpdateTableCellFormatOnlineResponse TableCellFormat
UpdateTableCellFormatRequest TableCellFormatResponse

TableCell

Represents a dTO container with a table cell element.

This class is inherited from NodeLink and used in TableCellResponse, TableRow.

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.

TableCellFormatDto

Represents a tableCellFormatDto.

TableCellInsertDto

Represents a dTO container with a table cell.

A single InsertAfter property is defined:

Property Type Description
InsertAfter int Gets or sets the 0-based index, the table cell will be inserted after.

TableCellFormat

Represents a dTO container with all formatting for a table row.

This class is inherited from LinkElement and used in TableCellFormatResponse, UpdateTableCellFormatOnlineRequest, UpdateTableCellFormatRequest.

The following properties are defined:

Property Type Description
Link WordsApiLink Gets or sets the link to the document.
BottomPadding double Gets or sets the amount of space (in points) to add below the contents of the cell.
FitText bool Gets or sets a value indicating whether to fit text in the cell, compress each paragraph to the width of the cell.
HorizontalMerge HorizontalMergeEnum Gets or sets the option that controls how the cell is merged horizontally with other cells in the row.
LeftPadding double Gets or sets the amount of space (in points) to add to the left of the contents of the cell.
Orientation OrientationEnum Gets or sets the orientation of text in a table cell.
PreferredWidth PreferredWidth Gets or sets the preferred width of the cell.
RightPadding double Gets or sets the amount of space (in points) to add to the right of the contents of the cell.
TopPadding double Gets or sets the amount of space (in points) to add above the contents of the cell.
VerticalAlignment VerticalAlignmentEnum Gets or sets the vertical alignment of text in the cell.
VerticalMerge VerticalMergeEnum Gets or sets the option that controls how the cell is merged with other cells vertically.
Width double Gets or sets the width of the cell in points.
WrapText bool Gets or sets a value indicating whether to wrap text in the cell.

TableCellInsert

Represents a dTO container with a table cell.

This class is used in InsertTableCellOnlineRequest, InsertTableCellRequest.

A single InsertAfter property is defined:

Property Type Description
InsertAfter int Gets or sets the 0-based index, the table cell will be inserted after.

DeleteTableCellOnlineRequest

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

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

  • DeleteTableCellOnlineRequest()
  • DeleteTableCellOnlineRequest(Stream document, string tableRowPath, 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.
tableRowPath TableRowPath string The path to the table row 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.

DeleteTableCellRequest

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

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

  • DeleteTableCellRequest()
  • DeleteTableCellRequest(string name, string tableRowPath, 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.
tableRowPath TableRowPath string The path to the table row 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.

GetTableCellFormatOnlineRequest

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

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

  • GetTableCellFormatOnlineRequest()
  • GetTableCellFormatOnlineRequest(Stream document, string tableRowPath, 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.
tableRowPath TableRowPath string The path to the table row 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.

GetTableCellFormatRequest

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

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

  • GetTableCellFormatRequest()
  • GetTableCellFormatRequest(string name, string tableRowPath, 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.
tableRowPath TableRowPath string The path to the table row 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.

GetTableCellOnlineRequest

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

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

  • GetTableCellOnlineRequest()
  • GetTableCellOnlineRequest(Stream document, string tableRowPath, 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.
tableRowPath TableRowPath string The path to the table row 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.

GetTableCellRequest

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

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

  • GetTableCellRequest()
  • GetTableCellRequest(string name, string tableRowPath, 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.
tableRowPath TableRowPath string The path to the table row 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.

InsertTableCellOnlineRequest

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

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

  • InsertTableCellOnlineRequest()
  • InsertTableCellOnlineRequest(Stream document, string tableRowPath, TableCellInsert cell, 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.
tableRowPath TableRowPath string The path to the table row in the document tree.
cell Cell TableCellInsert Table cell 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.

InsertTableCellOnlineResponse

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

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

  • InsertTableCellOnlineResponse(TableCellResponse model, Dictionary<string,Stream> document)

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

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

InsertTableCellRequest

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

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

  • InsertTableCellRequest()
  • InsertTableCellRequest(string name, string tableRowPath, TableCellInsert cell, 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.
tableRowPath TableRowPath string The path to the table row in the document tree.
cell Cell TableCellInsert Table cell 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.

TableCellFormatResponse

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

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

The following properties are defined:

Property Type Description
RequestId string Gets or sets the request Id.
CellFormat TableCellFormat Gets or sets the formatting properties of a table cell.

TableCellResponse

Represents a REST response with a table cell.

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

The following properties are defined:

Property Type Description
RequestId string Gets or sets the request Id.
Cell TableCell Gets or sets the table cell.

UpdateTableCellFormatOnlineRequest

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

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

  • UpdateTableCellFormatOnlineRequest()
  • UpdateTableCellFormatOnlineRequest(Stream document, string tableRowPath, TableCellFormat 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.
tableRowPath TableRowPath string The path to the table row in the document tree.
format Format TableCellFormat The properties.
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.

UpdateTableCellFormatOnlineResponse

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

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

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

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

UpdateTableCellFormatRequest

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

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

  • UpdateTableCellFormatRequest()
  • UpdateTableCellFormatRequest(string name, string tableRowPath, int index, TableCellFormat 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.
tableRowPath TableRowPath string The path to the table row in the document tree.
index Index int Object index.
format Format TableCellFormat The properties.
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.

TableCellFormat.HorizontalMergeEnum

The following values are defined: None, First, Previous.

TableCellFormat.OrientationEnum

The following values are defined: Horizontal, Downward, Upward, HorizontalRotatedFarEast, VerticalFarEast, VerticalRotatedFarEast.

TableCellFormat.VerticalAlignmentEnum

The following values are defined: Top, Center, Bottom.

TableCellFormat.VerticalMergeEnum

The following values are defined: None, First, Previous.