Table
Request | Response | Model | ||
---|---|---|---|---|
Delete | DeleteTableOnlineRequest | Dictionary |
||
DeleteTableRequest | Task | |||
Get | GetTableOnlineRequest | TableResponse | Table | |
GetTableRequest | ||||
GetTablesOnlineRequest | TableLinkCollectionResponse | TableLinkCollection | ||
GetTablesRequest | ||||
Insert | InsertTableOnlineRequest | InsertTableOnlineResponse | TableInsert | |
InsertTableRequest | TableResponse | TableTableInsert | ||
Render | RenderTableOnlineRequest | Stream | ||
RenderTableRequest |
PreferredWidth
Represents a dTO container with a preferred width value.
This class is used in TableCellFormat, TableProperties.
The following properties are defined:
Property | Type | Description |
---|---|---|
Type | TypeEnum | Gets or sets the unit of measure used for this preferred width value. |
Value | double | Gets or sets the preferred width value. The unit of measure is specified in the Type property. |
Table
Represents a dTO container with a table element.
This class is inherited from NodeLink and used in TableResponse.
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. |
TableProperties | TableProperties | Gets or sets table properties. |
TableRowList | List<TableRow> | Gets or sets the collection of table’s rows. |
TableInsert
Represents a dTO container with a table element.
This class is used in InsertTableOnlineRequest, InsertTableRequest.
The following properties are defined:
Property | Type | Description |
---|---|---|
ColumnsCount | int | Gets or sets the number of columns. The default value is 2. |
Position | DocumentPosition | Gets or sets the position to insert the table. The table will be inserted before the specified position. |
RowsCount | int | Gets or sets the number of rows. The default value is 2. |
TableInsertDto
Represents a dTO container with a table element.
The following properties are defined:
Property | Type | Description |
---|---|---|
ColumnsCount | int | Gets or sets the number of columns. The default value is 2. |
Position | DocumentPosition | Gets or sets the position to insert the table. The table will be inserted before the specified position. |
RowsCount | int | Gets or sets the number of rows. The default value is 2. |
TableLink
Represents a table link element.
This class is inherited from NodeLink and used in TableLinkCollection.
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. |
TableLinkCollection
Represents a collection of table’s links.
This class is inherited from LinkElement and used in TableLinkCollectionResponse.
The following properties are defined:
Property | Type | Description |
---|---|---|
Link | WordsApiLink | Gets or sets the link to the document. |
TableLinkList | List<TableLink> | Gets or sets the collection of table’s links. |
DeleteTableOnlineRequest
Represents a request model for WordsApi.DeleteTableOnline() operation.
An object of the DeleteTableOnlineRequest class is created by the following constructor methods:
- DeleteTableOnlineRequest()
- DeleteTableOnlineRequest(Stream document, 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. |
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. |
DeleteTableRequest
Represents a request model for WordsApi.DeleteTable() operation.
An object of the DeleteTableRequest class is created by the following constructor methods:
- DeleteTableRequest()
- DeleteTableRequest(string name, int index, 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. |
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. |
GetTableOnlineRequest
Represents a request model for WordsApi.GetTableOnline() operation.
An object of the GetTableOnlineRequest class is created by the following constructor methods:
- GetTableOnlineRequest()
- GetTableOnlineRequest(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. |
GetTableRequest
Represents a request model for WordsApi.GetTable() operation.
An object of the GetTableRequest class is created by the following constructor methods:
- GetTableRequest()
- GetTableRequest(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. |
GetTablesOnlineRequest
Represents a request model for WordsApi.GetTablesOnline() operation.
An object of the GetTablesOnlineRequest class is created by the following constructor methods:
- GetTablesOnlineRequest()
- GetTablesOnlineRequest(Stream document, 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. |
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. |
GetTablesRequest
Represents a request model for WordsApi.GetTables() operation.
An object of the GetTablesRequest class is created by the following constructor methods:
- GetTablesRequest()
- GetTablesRequest(string name, 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. |
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. |
InsertTableOnlineRequest
Represents a request model for WordsApi.InsertTableOnline() operation.
An object of the InsertTableOnlineRequest class is created by the following constructor methods:
- InsertTableOnlineRequest()
- InsertTableOnlineRequest(Stream document, TableInsert table, 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. |
table | Table | TableInsert | Table parameters. |
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. |
InsertTableOnlineResponse
Represents a response model for WordsApi.InsertTableOnline() operation.
An object of the InsertTableOnlineResponse class is created by the following constructor methods:
- InsertTableOnlineResponse(TableResponse model, Dictionary<string,Stream> document)
Each of those arguments initializes the corresponding self-titled property:
Argument | Property | Type | Description |
---|---|---|---|
model | Model | TableResponse | The response model. |
document | Document | Dictionary<string,Stream> | The document after modification. |
InsertTableRequest
Represents a request model for WordsApi.InsertTable() operation.
An object of the InsertTableRequest class is created by the following constructor methods:
- InsertTableRequest()
- InsertTableRequest(string name, TableInsert table, 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. |
table | Table | TableInsert | Table parameters. |
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. |
RenderTableOnlineRequest
Represents a request model for WordsApi.RenderTableOnline() operation.
An object of the RenderTableOnlineRequest class is created by the following constructor methods:
- RenderTableOnlineRequest()
- RenderTableOnlineRequest(Stream document, string format, int index, string nodePath, string loadEncoding, string password, string encryptedPassword, string destFileName, string fontsLocation)
Each of those arguments initializes the corresponding self-titled property:
Argument | Property | Type | Description |
---|---|---|---|
document | Document | Stream | The document. |
format | Format | string | The destination format. |
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. |
fontsLocation | FontsLocation | string | Folder in filestorage with custom fonts. |
RenderTableRequest
Represents a request model for WordsApi.RenderTable() operation.
An object of the RenderTableRequest class is created by the following constructor methods:
- RenderTableRequest()
- RenderTableRequest(string name, string format, int index, string nodePath, string folder, string storage, string loadEncoding, string password, string encryptedPassword, string destFileName, string fontsLocation)
Each of those arguments initializes the corresponding self-titled property:
Argument | Property | Type | Description |
---|---|---|---|
name | Name | string | The filename of the input document. |
format | Format | string | The destination format. |
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. |
fontsLocation | FontsLocation | string | Folder in filestorage with custom fonts. |
TableLinkCollectionResponse
Represents a REST response with a collection of tables.
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. |
Tables | TableLinkCollection | Gets or sets the collection of tables. |
TableResponse
Represents a REST response with a table.
This class is inherited from WordsResponse and used in WordsApi, InsertTableOnlineResponse.
The following properties are defined:
Property | Type | Description |
---|---|---|
RequestId | string | Gets or sets the request Id. |
Table | Table | Gets or sets the table. |
PreferredWidth.TypeEnum
The following values are defined: Auto, Percent, Points.