Methods

applyStyleToRange()

Apply the table style to the range.

convertToRange()

Convert the table to range.

convertToRange(options)

Convert the table to range.

Parameter

Name Type Optional 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.

putCellValue(rowOffset, columnOffset, value)

Put the value to the cell.

Parameters

Name Type Optional Description

rowOffset

Number

 

The row offset.

columnOffset

Number

 

The column offset.

value

Object

 

The cell value.

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

Resize the range of the list object.

Parameters

Name Type Optional 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 the ListObject 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.

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.