ApiListObject

Represents the ApiListObject class.

note

This functionality is available in paid ONLYOFFICE Docs editions.

Properties

Name	Type	Description
Active	boolean	Indicates whether the active cell is within the table range.
AlternativeText	string	Returns or sets the alternative text for the table.
AutoFilter	ApiAutoFilter | null	Returns the AutoFilter object for the table, or null.
Comment	string	Returns or sets the comment (summary alternative text) for the table.
DataBodyRange	ApiRange | null	Returns the range of the data rows.
DisplayName	string	Returns or sets the display name of the table.
HeaderRowRange	ApiRange | null	Returns the range of the header row.
Name	string	Returns or sets the display name of the table.
Parent	ApiWorksheet	Returns the parent worksheet.
Range	ApiRange | null	Returns the range of the table.
ShowAutoFilter	boolean	Returns or sets whether the AutoFilter is present.
ShowAutoFilterDropDown	boolean	Returns or sets whether the AutoFilter dropdown arrows are shown.
ShowHeaders	boolean	Returns or sets whether the header row is displayed.
ShowTableStyleColumnStripes	boolean	Returns or sets whether column stripes are applied.
ShowTableStyleFirstColumn	boolean	Returns or sets whether the first column style is applied.
ShowTableStyleLastColumn	boolean	Returns or sets whether the last column style is applied.
ShowTableStyleRowStripes	boolean	Returns or sets whether row stripes are applied.
ShowTotals	boolean	Returns or sets whether the totals row is displayed.
Sort	ApiSort	Returns the Sort object associated with the table.
SourceType	XlListObjectSourceType	Returns the data source type of the table.
Summary	string	Returns or sets the description of the table.
TableStyle	string	Returns or sets the name of the table style.
TotalsRowRange	ApiRange | null	Returns the range of the totals row; null if not shown.

Methods

Method	Returns	Description
AddListColumn	ApiListColumn | null	Adds a new column to the table at the specified 1-based position.
AddListRow	ApiListRow | null	Adds a new data row to the table at the specified 1-based position.
Delete	None	Deletes the ListObject object and clears the cell formatting.
GetActive	boolean	Returns a Boolean value that indicates whether the ListObject is active,
GetAlternativeText	string	Returns the alternative text for the table.
GetAutoFilter	ApiAutoFilter | null	Returns the ApiAutoFilter object representing the autofilter applied to the table.
GetComment	string	Returns the comment (summary alternative text) for the table.
GetDataBodyRange	ApiRange | null	Returns the range of the data rows in the table, excluding the header row and totals row.
GetDisplayName	string	Returns the display name of the table.
GetHeaderRowRange	ApiRange | null	Returns the range of the header row of the table.
GetListColumns	ApiListColumn[]	Returns an array of all columns in the table.
GetListRows	ApiListRow[]	Returns an array of all data rows in the table, excluding the header and totals rows.
GetName	string	Returns the display name of the table.
GetParent	ApiWorksheet	Returns the ApiWorksheet object that is the parent of the table.
GetRange	ApiRange | null	Returns the ApiRange object that represents the range of the table.
GetShowAutoFilter	boolean	Returns whether the AutoFilter dropdown buttons are displayed on the header row of the table.
GetShowAutoFilterDropDown	boolean	Returns whether the AutoFilter dropdown arrows are displayed on the header row of the table.
GetShowHeaders	boolean	Returns whether the header row is displayed for the table.
GetShowTableStyleColumnStripes	boolean	Returns whether banded column formatting is applied to the table.
GetShowTableStyleFirstColumn	boolean	Returns whether the first column formatting is applied to the table.
GetShowTableStyleLastColumn	boolean	Returns whether the last column formatting is applied to the table.
GetShowTableStyleRowStripes	boolean	Returns whether banded row formatting is applied to the table.
GetShowTotals	boolean	Returns whether the totals row is displayed for the table.
GetSort	ApiSort	Returns the Sort object for this list object.
GetSourceType	string	Returns the source type of the table. Always returns "xlSrcRange" for range-based tables.
GetSummary	string	Returns the summary description (alternative text summary) for the table.
GetTableStyle	string	Returns the name of the table style applied to the table.
GetTotalsRowRange	ApiRange | null	Returns the range of the totals row of the table.
Resize	None	Resizes the ListObject to a new range. Cells are not inserted or moved.
SetAlternativeText	None	Sets the alternative text for the table.
SetComment	None	Sets the comment (summary alternative text) for the table.
SetDisplayName	boolean	Sets the display name of the table.
SetName	boolean	Sets the name of the table. Equivalent to SetDisplayName.
SetShowAutoFilter	None	Sets whether the AutoFilter is present on the table.
SetShowAutoFilterDropDown	None	Sets whether the AutoFilter dropdown arrows are displayed on the header row of the table.
SetShowHeaders	None	Sets whether the header row is displayed for the table.
SetShowTableStyleColumnStripes	None	Sets whether banded column formatting is applied to the table.
SetShowTableStyleFirstColumn	None	Sets whether the first column formatting is applied to the table.
SetShowTableStyleLastColumn	None	Sets whether the last column formatting is applied to the table.
SetShowTableStyleRowStripes	None	Sets whether banded row formatting is applied to the table.
SetShowTotals	None	Sets whether the totals row is displayed for the table.
SetSummary	None	Sets the summary description (alternative text summary) for the table.
SetTableStyle	None	Sets the table style by name.
Unlist	None	Removes the list functionality from the ListObject and converts it to a regular data range.