TableProperties

Contents
[ ]
Request Response Model
Get GetTablePropertiesOnlineRequest TablePropertiesResponse TableProperties
GetTablePropertiesRequest
Update UpdateTablePropertiesOnlineRequest UpdateTablePropertiesOnlineResponse
UpdateTablePropertiesRequest TablePropertiesResponse

TableProperties

Represents a dTO container with table properties.

This class is inherited from LinkElement and used in Table, TablePropertiesResponse, UpdateTablePropertiesOnlineRequest, UpdateTablePropertiesRequest.

The following properties are defined:

Property Type Description
Link WordsApiLink Gets or sets the link to the document.
Alignment AlignmentEnum Gets or sets the option that controls how an inline table is aligned in the document.
AllowAutoFit bool Gets or sets a value indicating whether to automatically resize cells in a table to fit their contents.
Bidi bool Gets or sets a value indicating whether this is a right-to-left table.
BottomPadding double Gets or sets the amount of space (in points) to add below the contents of cells.
CellSpacing double Gets or sets the amount of space (in points) between the cells.
LeftIndent double Gets or sets the value, that represents the left indent of the table.
LeftPadding double Gets or sets the amount of space (in points) to add to the left of the contents of cells.
PreferredWidth PreferredWidth Gets or sets the table preferred width. Preferred width can be specified as a percentage, number of points or a special “auto” value.
RightPadding double Gets or sets the amount of space (in points) to add to the right of the contents of cells.
StyleIdentifier StyleIdentifierEnum Gets or sets the locale independent style identifier of the table style applied to this table.
StyleName string Gets or sets the name of the table style applied to this table.
StyleOptions StyleOptionsEnum Gets or sets the bit flags, that specify how a table style is applied to this table.
TextWrapping TextWrappingEnum Gets or sets the option that controls text wrapping for the table.
TopPadding double Gets or sets the amount of space (in points) to add above the contents of cells.

TablePropertiesDto

Represents a tablePropertiesDto.

GetTablePropertiesOnlineRequest

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

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

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

GetTablePropertiesRequest

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

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

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

TablePropertiesResponse

Represents a REST response with a table.

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

The following properties are defined:

Property Type Description
RequestId string Gets or sets the request Id.
Properties TableProperties Gets or sets the table.

UpdateTablePropertiesOnlineRequest

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

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

  • UpdateTablePropertiesOnlineRequest()
  • UpdateTablePropertiesOnlineRequest(Stream document, TableProperties properties, 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.
properties Properties TableProperties The properties.
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.

UpdateTablePropertiesOnlineResponse

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

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

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

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

UpdateTablePropertiesRequest

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

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

  • UpdateTablePropertiesRequest()
  • UpdateTablePropertiesRequest(string name, int index, TableProperties properties, 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.
properties Properties TableProperties The properties.
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.

TableProperties.AlignmentEnum

The following values are defined: Left, Center, Right.

TableProperties.TextWrappingEnum

The following values are defined: Default, None, Around.

TableCell TableRow