## 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()](#applystyletorange) | Apply the table style to the range. |
| [convertToRange()](#converttorange) | Convert the table to range. |
| [convertToRange(options)](#converttorange-1) | Convert the table to range. |
| [filter()](#filter) | Filter the table. |
| [getAlternativeDescription()](#getalternativedescription) | Gets and sets the alternative description. |
| [getAlternativeText()](#getalternativetext) | Gets and sets the alternative text. |
| [getAutoFilter()](#getautofilter) | Gets auto filter. |
| [getComment()](#getcomment) | Gets and sets the comment of the table. |
| [getDataRange()](#getdatarange) | Gets the data range of the ListObject. |
| [getDataSourceType()](#getdatasourcetype) | Gets the data source type of the table. The value of the property is TableDataSourceType integer constant. |
| [getDisplayName()](#getdisplayname) | Gets and sets the display name. |
| [getEndColumn()](#getendcolumn) | Gets the end column of the range. |
| [getEndRow()](#getendrow) | Gets the end row of the range. |
| [getListColumns()](#getlistcolumns) | Gets ListColumns of the ListObject. |
| [getQueryTable()](#getquerytable) | Gets the linked QueryTable. |
| [getShowHeaderRow()](#getshowheaderrow) | Gets and sets whether this ListObject show header row. |
| [getShowTableStyleColumnStripes()](#getshowtablestylecolumnstripes) | Indicates whether column stripe formatting is applied. |
| [getShowTableStyleFirstColumn()](#getshowtablestylefirstcolumn) | Indicates whether the first column in the table should have the style applied. |
| [getShowTableStyleLastColumn()](#getshowtablestylelastcolumn) | Indicates whether the last column in the table should have the style applied. |
| [getShowTableStyleRowStripes()](#getshowtablestylerowstripes) | Indicates whether row stripe formatting is applied. |
| [getShowTotals()](#getshowtotals) | Gets and sets whether this ListObject show total row. |
| [getStartColumn()](#getstartcolumn) | Gets the start column of the range. |
| [getStartRow()](#getstartrow) | Gets the start row of the range. |
| [getTableStyleName()](#gettablestylename) | Gets and sets the table style name. |
| [getTableStyleType()](#gettablestyletype) | Gets and the built-in table style. The value of the property is TableStyleType integer constant. |
| [getXmlMap()](#getxmlmap) | Gets an XmlMap used for this list. |
| [hasAutoFilter()](#hasautofilter) |  |
| [putCellFormula(rowOffset, columnOffset, formula)](#putcellformula) | Put the formula to the cell in the table. |
| [putCellFormula(rowOffset, columnOffset, formula, isTotalsRowFormula)](#putcellformula-1) | Put the formula to the cell in the table. |
| [putCellValue(rowOffset, columnOffset, value)](#putcellvalue) | Put the value to the cell. |
| [putCellValue(rowOffset, columnOffset, value, isTotalsRowLabel)](#putcellvalue-1) | Put the value to the cell. |
| [removeAutoFilter()](#removeautofilter) |  |
| [resize(startRow, startColumn, endRow, endColumn, hasHeaders)](#resize) | Resize the range of the list object. |
| [setAlternativeDescription()](#setalternativedescription) | Gets and sets the alternative description. |
| [setAlternativeText()](#setalternativetext) | Gets and sets the alternative text. |
| [setComment()](#setcomment) | Gets and sets the comment of the table. |
| [setDisplayName()](#setdisplayname) | Gets and sets the display name. |
| [setHasAutoFilter()](#sethasautofilter) |  |
| [setShowHeaderRow()](#setshowheaderrow) | Gets and sets whether this ListObject show header row. |
| [setShowTableStyleColumnStripes()](#setshowtablestylecolumnstripes) | Indicates whether column stripe formatting is applied. |
| [setShowTableStyleFirstColumn()](#setshowtablestylefirstcolumn) | Indicates whether the first column in the table should have the style applied. |
| [setShowTableStyleLastColumn()](#setshowtablestylelastcolumn) | Indicates whether the last column in the table should have the style applied. |
| [setShowTableStyleRowStripes()](#setshowtablestylerowstripes) | Indicates whether row stripe formatting is applied. |
| [setShowTotals()](#setshowtotals) | Gets and sets whether this ListObject show total row. |
| [setTableStyleName()](#settablestylename) | Gets and sets the table style name. |
| [setTableStyleType()](#settablestyletype) | Gets and the built-in table style. The value of the property is TableStyleType integer constant. |
| [updateColumnName()](#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() {#applystyletorange}

Apply the table style to the range.

### convertToRange() {#converttorange}

Convert the table to range.

### convertToRange(options) {#converttorange-1}

Convert the table to range.

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

### filter() {#filter}

Filter the table.

### getAlternativeDescription() {#getalternativedescription}

Gets and sets the alternative description.

### getAlternativeText() {#getalternativetext}

Gets and sets the alternative text.

### getAutoFilter() {#getautofilter}

Gets auto filter.

### getComment() {#getcomment}

Gets and sets the comment of the table.

### getDataRange() {#getdatarange}

Gets the data range of the ListObject.

### getDataSourceType() {#getdatasourcetype}

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

### getDisplayName() {#getdisplayname}

Gets and sets the display name.

### getEndColumn() {#getendcolumn}

Gets the end column of the range.

### getEndRow() {#getendrow}

Gets the end row of the range.

### getListColumns() {#getlistcolumns}

Gets ListColumns of the ListObject.

### getQueryTable() {#getquerytable}

Gets the linked QueryTable.

### getShowHeaderRow() {#getshowheaderrow}

Gets and sets whether this ListObject show header row.

### getShowTableStyleColumnStripes() {#getshowtablestylecolumnstripes}

Indicates whether column stripe formatting is applied.

### getShowTableStyleFirstColumn() {#getshowtablestylefirstcolumn}

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

### getShowTableStyleLastColumn() {#getshowtablestylelastcolumn}

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

### getShowTableStyleRowStripes() {#getshowtablestylerowstripes}

Indicates whether row stripe formatting is applied.

### getShowTotals() {#getshowtotals}

Gets and sets whether this ListObject show total row.

### getStartColumn() {#getstartcolumn}

Gets the start column of the range.

### getStartRow() {#getstartrow}

Gets the start row of the range.

### getTableStyleName() {#gettablestylename}

Gets and sets the table style name.

### getTableStyleType() {#gettablestyletype}

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

### getXmlMap() {#getxmlmap}

Gets an XmlMap used for this list.

### hasAutoFilter() {#hasautofilter}

### putCellFormula(rowOffset, columnOffset, formula) {#putcellformula}

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) {#putcellformula-1}

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) {#putcellvalue}

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) {#putcellvalue-1}

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() {#removeautofilter}

### resize(startRow, startColumn, endRow, endColumn, hasHeaders) {#resize}

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() {#setalternativedescription}

Gets and sets the alternative description.

### setAlternativeText() {#setalternativetext}

Gets and sets the alternative text.

### setComment() {#setcomment}

Gets and sets the comment of the table.

### setDisplayName() {#setdisplayname}

Gets and sets the display name.

### setHasAutoFilter() {#sethasautofilter}

### setShowHeaderRow() {#setshowheaderrow}

Gets and sets whether this ListObject show header row.

### setShowTableStyleColumnStripes() {#setshowtablestylecolumnstripes}

Indicates whether column stripe formatting is applied.

### setShowTableStyleFirstColumn() {#setshowtablestylefirstcolumn}

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

### setShowTableStyleLastColumn() {#setshowtablestylelastcolumn}

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

### setShowTableStyleRowStripes() {#setshowtablestylerowstripes}

Indicates whether row stripe formatting is applied.

### setShowTotals() {#setshowtotals}

Gets and sets whether this ListObject show total row.

### setTableStyleName() {#settablestylename}

Gets and sets the table style name.

### setTableStyleType() {#settablestyletype}

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

### updateColumnName() {#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.