aspose.cells

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 = new cells\Workbook();
$cells = $workbook->getWorksheets()->get(0)->getCells();
for ($i = 0; $i < 5; $i++)
{
    $cells->get(0, $i)->putValue(cells\CellsHelper::columnIndexToName($i));
}
for ($row = 1; $row < 10; $row++)
{
    for ($column = 0; $column < 5; $column++)
    {
        $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(cells\TotalsCalculation::SUM);

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

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

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

aspose.cells

Classes

Constants

Class ListObject

Property Getters/Setters Detail

getStartRow : Number

getStartColumn : Number

getEndRow : Number

getEndColumn : Number

getListColumns : ListColumnCollection

getShowHeaderRow/setShowHeaderRow : boolean

getShowTotals/setShowTotals : boolean

getDataRange : Range

getQueryTable : QueryTable

getDataSourceType : Number

getAutoFilter : AutoFilter

getDisplayName/setDisplayName : String

getComment/setComment : String

getShowTableStyleFirstColumn/setShowTableStyleFirstColumn : boolean

getShowTableStyleLastColumn/setShowTableStyleLastColumn : boolean

getShowTableStyleRowStripes/setShowTableStyleRowStripes : boolean

getShowTableStyleColumnStripes/setShowTableStyleColumnStripes : boolean

getTableStyleType/setTableStyleType : Number

getTableStyleName/setTableStyleName : String

getXmlMap : XmlMap

getAlternativeText/setAlternativeText : String

getAlternativeDescription/setAlternativeDescription : String

Method Detail

resize

putCellValue

updateColumnName

filter

applyStyleToRange

convertToRange

convertToRange