ApiListColumn
Represents the ApiListColumn class.
note
This functionality is available in paid ONLYOFFICE Docs editions.
Properties
| Name | Type | Description |
|---|---|---|
| DataBodyRange | ApiRange | null | Returns the data body range of the column, excluding header and totals rows. |
| Index | number | Returns the 1-based index of the column within the table. |
| Name | string | Returns or sets the name of the column. |
| Parent | ApiListObject | Returns the parent list object. |
| Range | ApiRange | null | Returns the full range of the column, including header and totals rows. |
| Total | ApiRange | null | Returns the totals row cell range for the column. |
| TotalsCalculation | XlTotalsCalculation | Returns or sets the totals row calculation type. |
Methods
| Method | Returns | Description |
|---|---|---|
| Delete | boolean | Deletes the column from the table. |
| GetDataBodyRange | ApiRange | null | Returns the range of the data body of the column, excluding the header and totals rows. |
| GetIndex | number | Returns the 1-based index of the column within the table. |
| GetName | string | Returns the name of the table column. |
| GetParent | ApiListObject | Returns the parent list object. |
| GetRange | ApiRange | null | Returns the range of the entire column, including the header and totals rows. |
| GetTotal | ApiRange | null | Returns the range of the totals row cell for the column. |
| GetTotalsCalculation | XlTotalsCalculation | Returns the totals calculation type for the column. |
| SetName | None | Sets the name of the table column. |
| SetTotalsCalculation | None | Sets the totals calculation type for the column. |