asposecells.api

Classes

Constants

Class ListObject

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.

Example:

workbook = Workbook()
cells = workbook.getWorksheets().get(0).getCells()
for i in range(0, 5):
    cells.get(0, i).putValue(CellsHelper.columnIndexToName(i))
for row in range(1, 10):
    for column in range(0, 5):
        cells.get(row, column).putValue(row * column)

tables = workbook.getWorksheets().get(0).getListObjects()
index = tables.add(0, 0, 9, 4, True)
table = tables.get(0)
table.setShowTotals(True)
table.getListColumns().get(4).setTotalsCalculation(TotalsCalculation.SUM)
workbook.save("Book1.xlsx")

Property Getters/Setters Summary
`method`	`getAlternativeDescription()`
`method`	`setAlternativeDescription(value)`
	Gets and sets the alternative description.
`method`	`getAlternativeText()`
`method`	`setAlternativeText(value)`
	Gets and sets the alternative text.
`method`	`getAutoFilter()`
	Gets auto filter.
`method`	`getComment()`
`method`	`setComment(value)`
	Gets and sets the comment of the table.
`method`	`getDataRange()`
	Gets the data range of the ListObject.
`method`	`getDataSourceType()`
	Gets the data source type of the table. The value of the property is TableDataSourceType integer constant.
`method`	`getDisplayName()`
`method`	`setDisplayName(value)`
	Gets and sets the display name.
`method`	`getEndColumn()`
	Gets the end column of the range.
`method`	`getEndRow()`
	Gets the end row of the range.
`method`	`getListColumns()`
	Gets ListColumns of the ListObject.
`method`	`getQueryTable()`
	Gets the linked QueryTable.
`method`	`getShowHeaderRow()`
`method`	`setShowHeaderRow(value)`
	Gets and sets whether this ListObject show header row.
`method`	`getShowTableStyleColumnStripes()`
`method`	`setShowTableStyleColumnStripes(value)`
	Indicates whether column stripe formatting is applied.
`method`	`getShowTableStyleFirstColumn()`
`method`	`setShowTableStyleFirstColumn(value)`
	Indicates whether the first column in the table should have the style applied.
`method`	`getShowTableStyleLastColumn()`
`method`	`setShowTableStyleLastColumn(value)`
	Indicates whether the last column in the table should have the style applied.
`method`	`getShowTableStyleRowStripes()`
`method`	`setShowTableStyleRowStripes(value)`
	Indicates whether row stripe formatting is applied.
`method`	`getShowTotals()`
`method`	`setShowTotals(value)`
	Gets and sets whether this ListObject show total row.
`method`	`getStartColumn()`
	Gets the start column of the range.
`method`	`getStartRow()`
	Gets the start row of the range.
`method`	`getTableStyleName()`
`method`	`setTableStyleName(value)`
	Gets and sets the table style name.
`method`	`getTableStyleType()`
`method`	`setTableStyleType(value)`
	Gets and the built-in table style. The value of the property is TableStyleType integer constant.
`method`	`getXmlMap()`
	Gets an XmlMap used for this list.

Method Summary
`method`	`applyStyleToRange()`
`method`	Apply the table style to the range.
`method`	`convertToRange()`
`method`	Convert the table to range.
`method`	`convertToRange(options)`
`method`	Convert the table to range.
`method`	`filter()`
`method`	Filter the table.
`method`	`putCellFormula(rowOffset, columnOffset, formula)`
`method`	Put the formula to the cell in the table.
`method`	`putCellFormula(rowOffset, columnOffset, formula, isTotalsRowFormula)`
`method`	Put the formula to the cell in the table.
`method`	`putCellValue(rowOffset, columnOffset, value)`
`method`	Put the value to the cell.
`method`	`putCellValue(rowOffset, columnOffset, value, isTotalsRowLabel)`
`method`	Put the value to the cell.
`method`	`resize(startRow, startColumn, endRow, endColumn, hasHeaders)`
`method`	Resize the range of the list object.
`method`	`updateColumnName()`
`method`	Updates all list columns' name from the worksheet.

- Property Getters/Setters Detail
  - getStartRow : int
```
int getStartRow()
```
    Gets the start row of the range.
  - getStartColumn : int
```
int getStartColumn()
```
    Gets the start column of the range.
  - getEndRow : int
```
int getEndRow()
```
    Gets the end row of the range.
  - getEndColumn : int
```
int getEndColumn()
```
    Gets the end column of the range.
  - getListColumns : ListColumnCollection
```
ListColumnCollection getListColumns()
```
    Gets ListColumns of the ListObject.
  - getShowHeaderRow/setShowHeaderRow : boolean
```
boolean getShowHeaderRow() / setShowHeaderRow(value)
```
    Gets and sets whether this ListObject show header row.
  - getShowTotals/setShowTotals : boolean
```
boolean getShowTotals() / setShowTotals(value)
```
    Gets and sets whether this ListObject show total row.
  - getDataRange : Range
```
Range getDataRange()
```
    Gets the data range of the ListObject.
  - getQueryTable : QueryTable
```
QueryTable getQueryTable()
```
    Gets the linked QueryTable.
  - getDataSourceType : int
```
int getDataSourceType()
```
    Gets the data source type of the table. The value of the property is TableDataSourceType integer constant.
  - getAutoFilter : AutoFilter
```
AutoFilter getAutoFilter()
```
    Gets auto filter.
  - getDisplayName/setDisplayName : String
```
String getDisplayName() / setDisplayName(value)
```
    Gets and sets the display name.
  - getComment/setComment : String
```
String getComment() / setComment(value)
```
    Gets and sets the comment of the table.
  - getShowTableStyleFirstColumn/setShowTableStyleFirstColumn : boolean
```
boolean getShowTableStyleFirstColumn() / setShowTableStyleFirstColumn(value)
```
    Indicates whether the first column in the table should have the style applied.
  - getShowTableStyleLastColumn/setShowTableStyleLastColumn : boolean
```
boolean getShowTableStyleLastColumn() / setShowTableStyleLastColumn(value)
```
    Indicates whether the last column in the table should have the style applied.
  - getShowTableStyleRowStripes/setShowTableStyleRowStripes : boolean
```
boolean getShowTableStyleRowStripes() / setShowTableStyleRowStripes(value)
```
    Indicates whether row stripe formatting is applied.
  - getShowTableStyleColumnStripes/setShowTableStyleColumnStripes : boolean
```
boolean getShowTableStyleColumnStripes() / setShowTableStyleColumnStripes(value)
```
    Indicates whether column stripe formatting is applied.
  - getTableStyleType/setTableStyleType : int
```
int getTableStyleType() / setTableStyleType(value)
```
    Gets and the built-in table style. The value of the property is TableStyleType integer constant.
  - getTableStyleName/setTableStyleName : String
```
String getTableStyleName() / setTableStyleName(value)
```
    Gets and sets the table style name.
  - getXmlMap : XmlMap
```
XmlMap getXmlMap()
```
    Gets an XmlMap used for this list.
  - getAlternativeText/setAlternativeText : String
```
String getAlternativeText() / setAlternativeText(value)
```
    Gets and sets the alternative text.
  - getAlternativeDescription/setAlternativeDescription : String
```
String getAlternativeDescription() / setAlternativeDescription(value)
```
    Gets and sets the alternative description.
- Method Detail
  - resize
```
 resize(startRow, startColumn, endRow, endColumn, hasHeaders)
```
    Resize the range of the list object.
    Parameters:
    startRow: int - The start row index of the new range.
    startColumn: int - The start column index of the new range.
    endRow: int - The end row index of the new range.
    endColumn: int - The end column index of the new range.
    hasHeaders: boolean - Whether this table has headers.
  - putCellValue
```
 putCellValue(rowOffset, columnOffset, value)
```
    Put the value to the cell.
    Parameters:
    rowOffset: int - The row offset in the table.
    columnOffset: int - The column offset in the table.
    value: Object - The cell value.
  - putCellValue
```
 putCellValue(rowOffset, columnOffset, value, isTotalsRowLabel)
```
    Put the value to the cell.
    Parameters:
    rowOffset: int - The row offset in the table.
    columnOffset: int - 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.
  - putCellFormula
```
 putCellFormula(rowOffset, columnOffset, formula)
```
    Put the formula to the cell in the table.
    Parameters:
    rowOffset: int - The row offset in the table.
    columnOffset: int - The column offset in the table.
    formula: String - The formula of the cell.
  - putCellFormula
```
 putCellFormula(rowOffset, columnOffset, formula, isTotalsRowFormula)
```
    Put the formula to the cell in the table.
    Parameters:
    rowOffset: int - The row offset in the table.
    columnOffset: int - The column offset in the table.
    formula: String - The formula of the cell.
    isTotalsRowFormula: boolean -
  - 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.
  - filter
```
AutoFilter filter()
```
    Filter the table.
  - applyStyleToRange
```
 applyStyleToRange()
```
    Apply the table style to the range.
  - convertToRange
```
 convertToRange()
```
    Convert the table to range.
  - convertToRange
```
 convertToRange(options)
```
    Convert the table to range.
    Parameters:
    options: TableToRangeOptions - the options when converting table to range.

asposecells.api

Classes

Constants

Class ListObject

Property Getters/Setters Detail

getStartRow : int

getStartColumn : int

getEndRow : int

getEndColumn : int

getListColumns : ListColumnCollection

getShowHeaderRow/setShowHeaderRow : boolean

getShowTotals/setShowTotals : boolean

getDataRange : Range

getQueryTable : QueryTable

getDataSourceType : int

getAutoFilter : AutoFilter

getDisplayName/setDisplayName : String

getComment/setComment : String

getShowTableStyleFirstColumn/setShowTableStyleFirstColumn : boolean

getShowTableStyleLastColumn/setShowTableStyleLastColumn : boolean

getShowTableStyleRowStripes/setShowTableStyleRowStripes : boolean

getShowTableStyleColumnStripes/setShowTableStyleColumnStripes : boolean

getTableStyleType/setTableStyleType : int

getTableStyleName/setTableStyleName : String

getXmlMap : XmlMap

getAlternativeText/setAlternativeText : String

getAlternativeDescription/setAlternativeDescription : String

Method Detail

resize

putCellValue

putCellValue

putCellFormula

putCellFormula

updateColumnName

filter

applyStyleToRange

convertToRange

convertToRange