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. More...

Inherits Object.

Public Member Functions
virtual Aspose::Cells::Systems::Int32	GetStartRow ()=0
	Gets the start row of the range. More...

virtual Aspose::Cells::Systems::Int32	GetStartColumn ()=0
	Gets the start column of the range. More...

virtual Aspose::Cells::Systems::Int32	GetEndRow ()=0
	Gets the end row of the range. More...

virtual Aspose::Cells::Systems::Int32	GetEndColumn ()=0
	Gets the end column of the range. More...

virtual intrusive_ptr< Aspose::Cells::Tables::IListColumnCollection >	GetIListColumns ()=0
	Gets ListColumns of the IListObject. More...

virtual void	Resize (Aspose::Cells::Systems::Int32 startRow, Aspose::Cells::Systems::Int32 startColumn, Aspose::Cells::Systems::Int32 endRow, Aspose::Cells::Systems::Int32 endColumn, bool hasHeaders)=0
	Resize the range of the list object. More...

virtual void	PutCellValue (Aspose::Cells::Systems::Int32 rowOffset, Aspose::Cells::Systems::Int32 columnOffset, intrusive_ptr< Aspose::Cells::Systems::Object > value)=0
	Put the value to the cell. More...

virtual bool	GetShowHeaderRow ()=0
	Gets and sets whether this IListObject show header row. More...

virtual void	SetShowHeaderRow (bool value)=0
	Gets and sets whether this IListObject show header row. More...

virtual bool	GetShowTotals ()=0
	Gets and sets whether this IListObject show total row. More...

virtual void	SetShowTotals (bool value)=0
	Gets and sets whether this IListObject show total row. More...

virtual intrusive_ptr< Aspose::Cells::IRange >	GetDataIRange ()=0
	Gets the data range of the ListObject. More...

virtual void	UpdateColumnName ()=0
	Updates all list columns' name from the worksheet. More...

virtual Aspose::Cells::Tables::TableDataSourceType	GetDataSourceType ()=0
	Gets the data source type of the table. More...

virtual intrusive_ptr< Aspose::Cells::IAutoFilter >	GetIFilter ()=0
	Filter the table. More...

virtual intrusive_ptr< Aspose::Cells::IAutoFilter >	GetIAutoFilter ()=0
	Gets auto filter. More...

virtual intrusive_ptr< Aspose::Cells::Systems::String >	GetDisplayName ()=0
	Gets and sets the display name. More...

virtual void	SetDisplayName (intrusive_ptr< Aspose::Cells::Systems::String > value)=0
	Gets and sets the display name. More...

virtual intrusive_ptr< Aspose::Cells::Systems::String >	GetComment ()=0
	Gets and sets the comment of the table. More...

virtual void	SetComment (intrusive_ptr< Aspose::Cells::Systems::String > value)=0
	Gets and sets the comment of the table. More...

virtual bool	GetShowTableStyleFirstColumn ()=0
	Indicates whether the first column in the table should have the style applied. More...

virtual void	SetShowTableStyleFirstColumn (bool value)=0
	Indicates whether the first column in the table should have the style applied. More...

virtual bool	GetShowTableStyleLastColumn ()=0
	Indicates whether the last column in the table should have the style applied. More...

virtual void	SetShowTableStyleLastColumn (bool value)=0
	Indicates whether the last column in the table should have the style applied. More...

virtual bool	GetShowTableStyleRowStripes ()=0
	Indicates whether row stripe formatting is applied. More...

virtual void	SetShowTableStyleRowStripes (bool value)=0
	Indicates whether row stripe formatting is applied. More...

virtual bool	GetShowTableStyleColumnStripes ()=0
	Indicates whether column stripe formatting is applied. More...

virtual void	SetShowTableStyleColumnStripes (bool value)=0
	Indicates whether column stripe formatting is applied. More...

virtual void	ApplyStyleToRange ()=0
	Apply the table style to the range. More...

virtual void	ConvertToRange ()=0
	Convert the table to range. More...

virtual Aspose::Cells::Tables::TableStyleType	GetTableStyleType ()=0
	Gets and the built-in table style. More...

virtual void	SetTableStyleType (Aspose::Cells::Tables::TableStyleType value)=0
	Gets and the built-in table style. More...

virtual intrusive_ptr< Aspose::Cells::Systems::String >	GetTableStyleName ()=0
	Gets and sets the table style name. More...

virtual void	SetTableStyleName (intrusive_ptr< Aspose::Cells::Systems::String > value)=0
	Gets and sets the table style name. More...

virtual intrusive_ptr< Aspose::Cells::Systems::String >	GetAlternativeText ()=0
	Gets the alternative text. More...

virtual void	SetAlternativeText (intrusive_ptr< Aspose::Cells::Systems::String > value)=0
	Sets the alternative text. More...

virtual intrusive_ptr< Aspose::Cells::Systems::String >	GetAlternativeDescription ()=0
	Gets the alternative description. More...

virtual void	SetAlternativeDescription (intrusive_ptr< Aspose::Cells::Systems::String > value)=0
	Sets the alternative description. More...

Detailed Description

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.

[C++]
intrusive_ptr<Aspose::Cells::IWorkbook> workbook = Factory::CreateIWorkbook();
intrusive_ptr<Aspose::Cells::IWorksheet> sheet = workbook->GetIWorksheets()->GetObjectByIndex(0);
intrusive_ptr<Aspose::Cells::ICells> cells = sheet->GetICells();
for (int i = 0; i < 5; i++)
{
    cells->GetObjectByIndex(0, i)->PutValue(ICellsHelper::ColumnIndexToName_i(i));
}
for (int row = 1; row < 10; row++)
{
    for (int column = 0; column < 5; column++)
    {
        cells->GetObjectByIndex(row, column)->PutValue(row * column);
    }
}
intrusive_ptr<IListObjectCollection> tables = workbook->GetIWorksheets()->GetObjectByIndex(0)->GetIListObjects();
int index = tables->Add(0, 0, 9, 4, true);
intrusive_ptr<IListObject> table = tables->GetObjectByIndex(0);
table->SetShowTotals(true);
workbook->Save(new String("C:\\Book1.xlsx"));

Member Function Documentation

◆ ApplyStyleToRange()

virtual void Aspose::Cells::Tables::IListObject::ApplyStyleToRange ( )

pure virtual

Apply the table style to the range.

◆ ConvertToRange()

virtual void Aspose::Cells::Tables::IListObject::ConvertToRange ( )

pure virtual

Convert the table to range.

◆ GetAlternativeDescription()

virtual intrusive_ptr<Aspose::Cells::Systems::String> Aspose::Cells::Tables::IListObject::GetAlternativeDescription ( )

pure virtual

Gets the alternative description.

◆ GetAlternativeText()

virtual intrusive_ptr<Aspose::Cells::Systems::String> Aspose::Cells::Tables::IListObject::GetAlternativeText ( )

pure virtual

Gets the alternative text.

◆ GetComment()

virtual intrusive_ptr<Aspose::Cells::Systems::String> Aspose::Cells::Tables::IListObject::GetComment ( )

pure virtual

Gets and sets the comment of the table.

◆ GetDataIRange()

virtual intrusive_ptr<Aspose::Cells::IRange> Aspose::Cells::Tables::IListObject::GetDataIRange ( )

pure virtual

Gets the data range of the ListObject.

◆ GetDataSourceType()

virtual Aspose::Cells::Tables::TableDataSourceType Aspose::Cells::Tables::IListObject::GetDataSourceType ( )

pure virtual

Gets the data source type of the table.

◆ GetDisplayName()

virtual intrusive_ptr<Aspose::Cells::Systems::String> Aspose::Cells::Tables::IListObject::GetDisplayName ( )

pure virtual

Gets and sets the display name.

◆ GetEndColumn()

virtual Aspose::Cells::Systems::Int32 Aspose::Cells::Tables::IListObject::GetEndColumn ( )

pure virtual

Gets the end column of the range.

◆ GetEndRow()

virtual Aspose::Cells::Systems::Int32 Aspose::Cells::Tables::IListObject::GetEndRow ( )

pure virtual

Gets the end row of the range.

◆ GetIAutoFilter()

virtual intrusive_ptr<Aspose::Cells::IAutoFilter> Aspose::Cells::Tables::IListObject::GetIAutoFilter ( )

pure virtual

Gets auto filter.

◆ GetIFilter()

virtual intrusive_ptr<Aspose::Cells::IAutoFilter> Aspose::Cells::Tables::IListObject::GetIFilter ( )

pure virtual

Filter the table.

◆ GetIListColumns()

virtual intrusive_ptr<Aspose::Cells::Tables::IListColumnCollection> Aspose::Cells::Tables::IListObject::GetIListColumns ( )

pure virtual

Gets ListColumns of the IListObject.

◆ GetShowHeaderRow()

virtual bool Aspose::Cells::Tables::IListObject::GetShowHeaderRow ( )

pure virtual

Gets and sets whether this IListObject show header row.

◆ GetShowTableStyleColumnStripes()

virtual bool Aspose::Cells::Tables::IListObject::GetShowTableStyleColumnStripes ( )

pure virtual

Indicates whether column stripe formatting is applied.

◆ GetShowTableStyleFirstColumn()

virtual bool Aspose::Cells::Tables::IListObject::GetShowTableStyleFirstColumn ( )

pure virtual

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

◆ GetShowTableStyleLastColumn()

virtual bool Aspose::Cells::Tables::IListObject::GetShowTableStyleLastColumn ( )

pure virtual

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

◆ GetShowTableStyleRowStripes()

virtual bool Aspose::Cells::Tables::IListObject::GetShowTableStyleRowStripes ( )

pure virtual

Indicates whether row stripe formatting is applied.

◆ GetShowTotals()

virtual bool Aspose::Cells::Tables::IListObject::GetShowTotals ( )

pure virtual

Gets and sets whether this IListObject show total row.

◆ GetStartColumn()

virtual Aspose::Cells::Systems::Int32 Aspose::Cells::Tables::IListObject::GetStartColumn ( )

pure virtual

Gets the start column of the range.

◆ GetStartRow()

virtual Aspose::Cells::Systems::Int32 Aspose::Cells::Tables::IListObject::GetStartRow ( )

pure virtual

Gets the start row of the range.

◆ GetTableStyleName()

virtual intrusive_ptr<Aspose::Cells::Systems::String> Aspose::Cells::Tables::IListObject::GetTableStyleName ( )

pure virtual

Gets and sets the table style name.

◆ GetTableStyleType()

virtual Aspose::Cells::Tables::TableStyleType Aspose::Cells::Tables::IListObject::GetTableStyleType ( )

pure virtual

Gets and the built-in table style.

◆ PutCellValue()

virtual void Aspose::Cells::Tables::IListObject::PutCellValue	(	Aspose::Cells::Systems::Int32	rowOffset,
		Aspose::Cells::Systems::Int32	columnOffset,
		intrusive_ptr< Aspose::Cells::Systems::Object >	value
	)

pure virtual

Put the value to the cell.

Parameters

rowOffset The row offset.

Parameters

columnOffset The column offset.

Parameters

value The cell value.

◆ Resize()

virtual void Aspose::Cells::Tables::IListObject::Resize	(	Aspose::Cells::Systems::Int32	startRow,
		Aspose::Cells::Systems::Int32	startColumn,
		Aspose::Cells::Systems::Int32	endRow,
		Aspose::Cells::Systems::Int32	endColumn,
		bool	hasHeaders
	)

pure virtual

Resize the range of the list object.

Parameters

startRow The start row index of the new range.

Parameters

startColumn The start column index of the new range.

Parameters

endRow The end row index of the new range.

Parameters

endColumn The end column index of the new range.

Parameters

hasHeaders Whether the ListObject has headers.

◆ SetAlternativeDescription()

virtual void Aspose::Cells::Tables::IListObject::SetAlternativeDescription ( intrusive_ptr< Aspose::Cells::Systems::String > value )

pure virtual

Sets the alternative description.

◆ SetAlternativeText()

virtual void Aspose::Cells::Tables::IListObject::SetAlternativeText ( intrusive_ptr< Aspose::Cells::Systems::String > value )

pure virtual

Sets the alternative text.

◆ SetComment()

virtual void Aspose::Cells::Tables::IListObject::SetComment ( intrusive_ptr< Aspose::Cells::Systems::String > value )

pure virtual

Gets and sets the comment of the table.

◆ SetDisplayName()

virtual void Aspose::Cells::Tables::IListObject::SetDisplayName ( intrusive_ptr< Aspose::Cells::Systems::String > value )

pure virtual

Gets and sets the display name.

◆ SetShowHeaderRow()

virtual void Aspose::Cells::Tables::IListObject::SetShowHeaderRow ( bool value )

pure virtual

Gets and sets whether this IListObject show header row.

◆ SetShowTableStyleColumnStripes()

virtual void Aspose::Cells::Tables::IListObject::SetShowTableStyleColumnStripes ( bool value )

pure virtual

Indicates whether column stripe formatting is applied.

◆ SetShowTableStyleFirstColumn()

virtual void Aspose::Cells::Tables::IListObject::SetShowTableStyleFirstColumn ( bool value )

pure virtual

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

◆ SetShowTableStyleLastColumn()

virtual void Aspose::Cells::Tables::IListObject::SetShowTableStyleLastColumn ( bool value )

pure virtual

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

◆ SetShowTableStyleRowStripes()

virtual void Aspose::Cells::Tables::IListObject::SetShowTableStyleRowStripes ( bool value )

pure virtual

Indicates whether row stripe formatting is applied.

◆ SetShowTotals()

virtual void Aspose::Cells::Tables::IListObject::SetShowTotals ( bool value )

pure virtual

Gets and sets whether this IListObject show total row.

◆ SetTableStyleName()

virtual void Aspose::Cells::Tables::IListObject::SetTableStyleName ( intrusive_ptr< Aspose::Cells::Systems::String > value )

pure virtual

Gets and sets the table style name.

◆ SetTableStyleType()

virtual void Aspose::Cells::Tables::IListObject::SetTableStyleType ( Aspose::Cells::Tables::TableStyleType value )

pure virtual

Gets and the built-in table style.

◆ UpdateColumnName()

virtual void Aspose::Cells::Tables::IListObject::UpdateColumnName ( )

pure virtual

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.

Public Member Functions

Detailed Description

Member Function Documentation

◆ ApplyStyleToRange()

◆ ConvertToRange()

◆ GetAlternativeDescription()

◆ GetAlternativeText()

◆ GetComment()

◆ GetDataIRange()

◆ GetDataSourceType()

◆ GetDisplayName()

◆ GetEndColumn()

◆ GetEndRow()

◆ GetIAutoFilter()

◆ GetIFilter()

◆ GetIListColumns()

◆ GetShowHeaderRow()

◆ GetShowTableStyleColumnStripes()

◆ GetShowTableStyleFirstColumn()

◆ GetShowTableStyleLastColumn()

◆ GetShowTableStyleRowStripes()

◆ GetShowTotals()

◆ GetStartColumn()

◆ GetStartRow()

◆ GetTableStyleName()

◆ GetTableStyleType()

◆ PutCellValue()

◆ Resize()

◆ SetAlternativeDescription()

◆ SetAlternativeText()

◆ SetComment()

◆ SetDisplayName()

◆ SetShowHeaderRow()

◆ SetShowTableStyleColumnStripes()

◆ SetShowTableStyleFirstColumn()

◆ SetShowTableStyleLastColumn()

◆ SetShowTableStyleRowStripes()

◆ SetShowTotals()

◆ SetTableStyleName()

◆ SetTableStyleType()

◆ UpdateColumnName()