ListObject

ListObject class

Represents a list object on a worksheet. The ListObject object is a member of the ListObjects collection. The ListObjects collection contains all the list objects on a worksheet.

Methods

Name	Description
applyStyleToRange()	Apply the table style to the range.
convertToRange()	Convert the table to range.
convertToRange(options)	Convert the table to range.
filter()	Filter the table.
getAlternativeDescription()	Gets and sets the alternative description.
getAlternativeText()	Gets and sets the alternative text.
getAutoFilter()	Gets auto filter.
getComment()	Gets and sets the comment of the table.
getDataRange()	Gets the data range of the ListObject.
getDataSourceType()	Gets the data source type of the table. The value of the property is TableDataSourceType integer constant.
getDisplayName()	Gets and sets the display name.
getEndColumn()	Gets the end column of the range.
getEndRow()	Gets the end row of the range.
getListColumns()	Gets ListColumns of the ListObject.
getQueryTable()	Gets the linked QueryTable.
getShowHeaderRow()	Gets and sets whether this ListObject show header row.
getShowTableStyleColumnStripes()	Indicates whether column stripe formatting is applied.
getShowTableStyleFirstColumn()	Indicates whether the first column in the table should have the style applied.
getShowTableStyleLastColumn()	Indicates whether the last column in the table should have the style applied.
getShowTableStyleRowStripes()	Indicates whether row stripe formatting is applied.
getShowTotals()	Gets and sets whether this ListObject show total row.
getStartColumn()	Gets the start column of the range.
getStartRow()	Gets the start row of the range.
getTableStyleName()	Gets and sets the table style name.
getTableStyleType()	Gets and the built-in table style. The value of the property is TableStyleType integer constant.
getXmlMap()	Gets an XmlMap used for this list.
hasAutoFilter()
putCellFormula(rowOffset, columnOffset, formula)	Put the formula to the cell in the table.
putCellFormula(rowOffset, columnOffset, formula, isTotalsRowFormula)	Put the formula to the cell in the table.
putCellValue(rowOffset, columnOffset, value)	Put the value to the cell.
putCellValue(rowOffset, columnOffset, value, isTotalsRowLabel)	Put the value to the cell.
removeAutoFilter()
resize(startRow, startColumn, endRow, endColumn, hasHeaders)	Resize the range of the list object.
setAlternativeDescription()	Gets and sets the alternative description.
setAlternativeText()	Gets and sets the alternative text.
setComment()	Gets and sets the comment of the table.
setDisplayName()	Gets and sets the display name.
setHasAutoFilter()
setShowHeaderRow()	Gets and sets whether this ListObject show header row.
setShowTableStyleColumnStripes()	Indicates whether column stripe formatting is applied.
setShowTableStyleFirstColumn()	Indicates whether the first column in the table should have the style applied.
setShowTableStyleLastColumn()	Indicates whether the last column in the table should have the style applied.
setShowTableStyleRowStripes()	Indicates whether row stripe formatting is applied.
setShowTotals()	Gets and sets whether this ListObject show total row.
setTableStyleName()	Gets and sets the table style name.
setTableStyleType()	Gets and the built-in table style. The value of the property is TableStyleType integer constant.
updateColumnName()	Updates all list columns’ name from the worksheet. The value of the cells in the header row of the table must be same as

applyStyleToRange()

Apply the table style to the range.

convertToRange()

Convert the table to range.

convertToRange(options)

Convert the table to range.

Parameter	Type	Description
options	TableToRangeOptions	the options when converting table to range.

filter()

Filter the table.

getAlternativeDescription()

Gets and sets the alternative description.

getAlternativeText()

Gets and sets the alternative text.

getAutoFilter()

Gets auto filter.

getComment()

Gets and sets the comment of the table.

getDataRange()

Gets the data range of the ListObject.

getDataSourceType()

Gets the data source type of the table. The value of the property is TableDataSourceType integer constant.

getDisplayName()

Gets and sets the display name.

getEndColumn()

Gets the end column of the range.

getEndRow()

Gets the end row of the range.

getListColumns()

Gets ListColumns of the ListObject.

getQueryTable()

Gets the linked QueryTable.

getShowHeaderRow()

Gets and sets whether this ListObject show header row.

getShowTableStyleColumnStripes()

Indicates whether column stripe formatting is applied.

getShowTableStyleFirstColumn()

Indicates whether the first column in the table should have the style applied.

getShowTableStyleLastColumn()

Indicates whether the last column in the table should have the style applied.

getShowTableStyleRowStripes()

Indicates whether row stripe formatting is applied.

getShowTotals()

Gets and sets whether this ListObject show total row.

getStartColumn()

Gets the start column of the range.

getStartRow()

Gets the start row of the range.

getTableStyleName()

Gets and sets the table style name.

getTableStyleType()

Gets and the built-in table style. The value of the property is TableStyleType integer constant.

getXmlMap()

Gets an XmlMap used for this list.

hasAutoFilter()

putCellFormula(rowOffset, columnOffset, formula)

Put the formula to the cell in the table.

Parameter	Type	Description
rowOffset	Number	The row offset in the table.
columnOffset	Number	The column offset in the table.
formula	String	The formula of the cell.

putCellFormula(rowOffset, columnOffset, formula, isTotalsRowFormula)

Put the formula to the cell in the table.

Parameter	Type	Description
rowOffset	Number	The row offset in the table.
columnOffset	Number	The column offset in the table.
formula	String	The formula of the cell.
isTotalsRowFormula	boolean

putCellValue(rowOffset, columnOffset, value)

Put the value to the cell.

Parameter	Type	Description
rowOffset	Number	The row offset in the table.
columnOffset	Number	The column offset in the table.
value	Object	The cell value.

putCellValue(rowOffset, columnOffset, value, isTotalsRowLabel)

Put the value to the cell.

Parameter	Type	Description
rowOffset	Number	The row offset in the table.
columnOffset	Number	The column offset in the table.
value	Object	The cell value.
isTotalsRowLabel	boolean	Indicates whether it is a label for total row,only works for total row. If False and this row is total row, a new row will be inserted.

removeAutoFilter()

resize(startRow, startColumn, endRow, endColumn, hasHeaders)

Resize the range of the list object.

Parameter	Type	Description
startRow	Number	The start row index of the new range.
startColumn	Number	The start column index of the new range.
endRow	Number	The end row index of the new range.
endColumn	Number	The end column index of the new range.
hasHeaders	boolean	Whether this table has headers.

setAlternativeDescription()

Gets and sets the alternative description.

setAlternativeText()

Gets and sets the alternative text.

setComment()

Gets and sets the comment of the table.

setDisplayName()

Gets and sets the display name.

setHasAutoFilter()

setShowHeaderRow()

Gets and sets whether this ListObject show header row.

setShowTableStyleColumnStripes()

Indicates whether column stripe formatting is applied.

setShowTableStyleFirstColumn()

Indicates whether the first column in the table should have the style applied.

setShowTableStyleLastColumn()

Indicates whether the last column in the table should have the style applied.

setShowTableStyleRowStripes()

Indicates whether row stripe formatting is applied.

setShowTotals()

Gets and sets whether this ListObject show total row.

setTableStyleName()

Gets and sets the table style name.

setTableStyleType()

Gets and the built-in table style. The value of the property is TableStyleType integer constant.

updateColumnName()

Updates all list columns’ name from the worksheet. The value of the cells in the header row of the table must be same as the name of the ListColumn; Cell.PutValue do not auto modify the name of the ListColumn for performance.