Aspose::Cells::Pivot::IPivotTableCollection Class Referenceabstract

Represents the collection of all the PivotTable objects on the specified worksheet. More...

Inherits CollectionBase, and IDisposable.

Public Member Functions

virtual void Dispose ()=0
 Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. More...
 
virtual Aspose::Cells::Systems::Int32 Add (intrusive_ptr< Aspose::Cells::Systems::String > sourceData, intrusive_ptr< Aspose::Cells::Systems::String > destCellName, intrusive_ptr< Aspose::Cells::Systems::String > tableName)=0
 Adds a new PivotTable cache to a PivotCaches collection. More...
 
virtual Aspose::Cells::Systems::Int32 Add (intrusive_ptr< Aspose::Cells::Systems::String > sourceData, intrusive_ptr< Aspose::Cells::Systems::String > destCellName, intrusive_ptr< Aspose::Cells::Systems::String > tableName, bool useSameSource)=0
 Adds a new PivotTable cache to a PivotCaches collection. More...
 
virtual Aspose::Cells::Systems::Int32 Add (intrusive_ptr< Aspose::Cells::Systems::String > sourceData, Aspose::Cells::Systems::Int32 row, Aspose::Cells::Systems::Int32 column, intrusive_ptr< Aspose::Cells::Systems::String > tableName)=0
 Adds a new PivotTable cache to a PivotCaches collection. More...
 
virtual Aspose::Cells::Systems::Int32 Add (intrusive_ptr< Aspose::Cells::Systems::String > sourceData, Aspose::Cells::Systems::Int32 row, Aspose::Cells::Systems::Int32 column, intrusive_ptr< Aspose::Cells::Systems::String > tableName, bool useSameSource)=0
 Adds a new PivotTable cache to a PivotCaches collection. More...
 
virtual Aspose::Cells::Systems::Int32 AddIPivotTable (intrusive_ptr< Aspose::Cells::Pivot::IPivotTable > pivotTable, intrusive_ptr< Aspose::Cells::Systems::String > destCellName, intrusive_ptr< Aspose::Cells::Systems::String > tableName)=0
 Adds a new PivotTable Object to the collection from another PivotTable. More...
 
virtual Aspose::Cells::Systems::Int32 AddIPivotTable (intrusive_ptr< Aspose::Cells::Pivot::IPivotTable > pivotTable, Aspose::Cells::Systems::Int32 row, Aspose::Cells::Systems::Int32 column, intrusive_ptr< Aspose::Cells::Systems::String > tableName)=0
 Adds a new PivotTable Object to the collection from another PivotTable. More...
 
virtual Aspose::Cells::Systems::Int32 AddIPivotTable (intrusive_ptr< Aspose::Cells::Systems::Array1D< Aspose::Cells::Systems::String *>> sourceData, bool isAutoPage, intrusive_ptr< Aspose::Cells::Pivot::IPivotPageFields > pageFields, intrusive_ptr< Aspose::Cells::Systems::String > destCellName, intrusive_ptr< Aspose::Cells::Systems::String > tableName)=0
 Adds a new PivotTable Object to the collection with multiple consolidation ranges as data source. More...
 
virtual Aspose::Cells::Systems::Int32 AddIPivotTable (intrusive_ptr< Aspose::Cells::Systems::Array1D< Aspose::Cells::Systems::String *>> sourceData, bool isAutoPage, intrusive_ptr< Aspose::Cells::Pivot::IPivotPageFields > pageFields, Aspose::Cells::Systems::Int32 row, Aspose::Cells::Systems::Int32 column, intrusive_ptr< Aspose::Cells::Systems::String > tableName)=0
 Adds a new PivotTable Object to the collection with multiple consolidation ranges as data source. More...
 
virtual intrusive_ptr< Aspose::Cells::Pivot::IPivotTableGetObjectByIndex (Aspose::Cells::Systems::Int32 index)=0
 Gets the PivotTable report by index. More...
 
virtual intrusive_ptr< Aspose::Cells::Pivot::IPivotTableGetObjectByIndex (intrusive_ptr< Aspose::Cells::Systems::String > name)=0
 Gets the PivotTable report by pivottable's name. More...
 
virtual intrusive_ptr< Aspose::Cells::Pivot::IPivotTableGetObjectByIndex (Aspose::Cells::Systems::Int32 row, Aspose::Cells::Systems::Int32 column)=0
 Gets the PivotTable report by pivottable's position. More...
 
virtual void Clear ()=0
 Clear all pivot tables. More...
 
virtual void Remove (intrusive_ptr< Aspose::Cells::Pivot::IPivotTable > pivotTable)=0
 Deletes the specified PivotTable and delete the PivotTable data More...
 
virtual void Remove (intrusive_ptr< Aspose::Cells::Pivot::IPivotTable > pivotTable, bool keepData)=0
 Deletes the specified PivotTable More...
 
virtual void RemoveAt (Aspose::Cells::Systems::Int32 index)=0
 Deletes the PivotTable at the specified index and delete the PivotTable data More...
 
virtual void RemoveAt (Aspose::Cells::Systems::Int32 index, bool keepData)=0
 Deletes the PivotTable at the specified index More...
 
virtual void add_ref ()
 
virtual int release_ref ()
 

Detailed Description

Represents the collection of all the PivotTable objects on the specified worksheet.

Member Function Documentation

◆ Add() [1/4]

virtual Aspose::Cells::Systems::Int32 Aspose::Cells::Pivot::IPivotTableCollection::Add ( intrusive_ptr< Aspose::Cells::Systems::String >  sourceData,
intrusive_ptr< Aspose::Cells::Systems::String >  destCellName,
intrusive_ptr< Aspose::Cells::Systems::String >  tableName 
)
pure virtual

Adds a new PivotTable cache to a PivotCaches collection.

Parameters
sourceDataThe data for the new PivotTable cache.
destCellNameThe cell in the upper-left corner of the PivotTable report's destination range.
tableNameThe name of the new PivotTable report.
Returns
The new added cache index.

◆ Add() [2/4]

virtual Aspose::Cells::Systems::Int32 Aspose::Cells::Pivot::IPivotTableCollection::Add ( intrusive_ptr< Aspose::Cells::Systems::String >  sourceData,
intrusive_ptr< Aspose::Cells::Systems::String >  destCellName,
intrusive_ptr< Aspose::Cells::Systems::String >  tableName,
bool  useSameSource 
)
pure virtual

Adds a new PivotTable cache to a PivotCaches collection.

Parameters
sourceDataThe data for the new PivotTable cache.
destCellNameThe cell in the upper-left corner of the PivotTable report's destination range.
tableNameThe name of the new PivotTable report.
useSameSourceIndicates whether using same data source when another existing pivot table has used this data source. If the property is true, it will save memory.
Returns
The new added cache index.

◆ Add() [3/4]

virtual Aspose::Cells::Systems::Int32 Aspose::Cells::Pivot::IPivotTableCollection::Add ( intrusive_ptr< Aspose::Cells::Systems::String >  sourceData,
Aspose::Cells::Systems::Int32  row,
Aspose::Cells::Systems::Int32  column,
intrusive_ptr< Aspose::Cells::Systems::String >  tableName 
)
pure virtual

Adds a new PivotTable cache to a PivotCaches collection.

Parameters
sourceDataThe data cell range for the new PivotTable.Example : Sheet1!A1:C8
rowRow index of the cell in the upper-left corner of the PivotTable report's destination range.
columnColumn index of the cell in the upper-left corner of the PivotTable report's destination range.
tableNameThe name of the new PivotTable report.
Returns
The new added cache index.

◆ Add() [4/4]

virtual Aspose::Cells::Systems::Int32 Aspose::Cells::Pivot::IPivotTableCollection::Add ( intrusive_ptr< Aspose::Cells::Systems::String >  sourceData,
Aspose::Cells::Systems::Int32  row,
Aspose::Cells::Systems::Int32  column,
intrusive_ptr< Aspose::Cells::Systems::String >  tableName,
bool  useSameSource 
)
pure virtual

Adds a new PivotTable cache to a PivotCaches collection.

Parameters
sourceDataThe data cell range for the new PivotTable.Example : Sheet1!A1:C8
rowRow index of the cell in the upper-left corner of the PivotTable report's destination range.
columnColumn index of the cell in the upper-left corner of the PivotTable report's destination range.
tableNameThe name of the new PivotTable report.
useSameSourceIndicates whether using same data source when another existing pivot table has used this data source. If the property is true, it will save memory.
Returns
The new added cache index.

◆ add_ref()

virtual void Aspose::Cells::Pivot::IPivotTableCollection::add_ref ( )
inlinevirtual

◆ AddIPivotTable() [1/4]

virtual Aspose::Cells::Systems::Int32 Aspose::Cells::Pivot::IPivotTableCollection::AddIPivotTable ( intrusive_ptr< Aspose::Cells::Pivot::IPivotTable pivotTable,
intrusive_ptr< Aspose::Cells::Systems::String >  destCellName,
intrusive_ptr< Aspose::Cells::Systems::String >  tableName 
)
pure virtual

Adds a new PivotTable Object to the collection from another PivotTable.

Parameters
pivotTableThe source pivotTable.
destCellNameThe cell in the upper-left corner of the PivotTable report's destination range.
tableNameThe name of the new PivotTable report.
Returns
The new added PivotTable index.

◆ AddIPivotTable() [2/4]

virtual Aspose::Cells::Systems::Int32 Aspose::Cells::Pivot::IPivotTableCollection::AddIPivotTable ( intrusive_ptr< Aspose::Cells::Pivot::IPivotTable pivotTable,
Aspose::Cells::Systems::Int32  row,
Aspose::Cells::Systems::Int32  column,
intrusive_ptr< Aspose::Cells::Systems::String >  tableName 
)
pure virtual

Adds a new PivotTable Object to the collection from another PivotTable.

Parameters
pivotTableThe source pivotTable.
rowRow index of the cell in the upper-left corner of the PivotTable report's destination range.
columnColumn index of the cell in the upper-left corner of the PivotTable report's destination range.
tableNameThe name of the new PivotTable report.
Returns
The new added PivotTable index.

◆ AddIPivotTable() [3/4]

virtual Aspose::Cells::Systems::Int32 Aspose::Cells::Pivot::IPivotTableCollection::AddIPivotTable ( intrusive_ptr< Aspose::Cells::Systems::Array1D< Aspose::Cells::Systems::String *>>  sourceData,
bool  isAutoPage,
intrusive_ptr< Aspose::Cells::Pivot::IPivotPageFields pageFields,
intrusive_ptr< Aspose::Cells::Systems::String >  destCellName,
intrusive_ptr< Aspose::Cells::Systems::String >  tableName 
)
pure virtual

Adds a new PivotTable Object to the collection with multiple consolidation ranges as data source.

Parameters
sourceDataThe multiple consolidation ranges,such as {"Sheet1!A1:C8","Sheet2!A1:B8"}
isAutoPageWhether auto create a single page field. If true,the following param pageFields will be ignored.
pageFieldsThe pivot page field items.
destCellNamedestCellName The name of the new PivotTable report.
tableNamethe name of the new PivotTable report.
Returns
The new added PivotTable index.

◆ AddIPivotTable() [4/4]

virtual Aspose::Cells::Systems::Int32 Aspose::Cells::Pivot::IPivotTableCollection::AddIPivotTable ( intrusive_ptr< Aspose::Cells::Systems::Array1D< Aspose::Cells::Systems::String *>>  sourceData,
bool  isAutoPage,
intrusive_ptr< Aspose::Cells::Pivot::IPivotPageFields pageFields,
Aspose::Cells::Systems::Int32  row,
Aspose::Cells::Systems::Int32  column,
intrusive_ptr< Aspose::Cells::Systems::String >  tableName 
)
pure virtual

Adds a new PivotTable Object to the collection with multiple consolidation ranges as data source.

Parameters
sourceDataThe multiple consolidation ranges,such as {"Sheet1!A1:C8","Sheet2!A1:B8"}
isAutoPageWhether auto create a single page field. If true,the following param pageFields will be ignored
pageFieldsThe pivot page field items.
rowRow index of the cell in the upper-left corner of the PivotTable report's destination range.
columnColumn index of the cell in the upper-left corner of the PivotTable report's destination range.
tableNameThe name of the new PivotTable report.
Returns
The new added PivotTable index.

◆ Clear()

virtual void Aspose::Cells::Pivot::IPivotTableCollection::Clear ( )
pure virtual

Clear all pivot tables.

◆ Dispose()

virtual void Aspose::Cells::Pivot::IPivotTableCollection::Dispose ( )
pure virtual

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

◆ GetObjectByIndex() [1/3]

virtual intrusive_ptr<Aspose::Cells::Pivot::IPivotTable> Aspose::Cells::Pivot::IPivotTableCollection::GetObjectByIndex ( Aspose::Cells::Systems::Int32  index)
pure virtual

Gets the PivotTable report by index.

◆ GetObjectByIndex() [2/3]

virtual intrusive_ptr<Aspose::Cells::Pivot::IPivotTable> Aspose::Cells::Pivot::IPivotTableCollection::GetObjectByIndex ( intrusive_ptr< Aspose::Cells::Systems::String >  name)
pure virtual

Gets the PivotTable report by pivottable's name.

◆ GetObjectByIndex() [3/3]

virtual intrusive_ptr<Aspose::Cells::Pivot::IPivotTable> Aspose::Cells::Pivot::IPivotTableCollection::GetObjectByIndex ( Aspose::Cells::Systems::Int32  row,
Aspose::Cells::Systems::Int32  column 
)
pure virtual

Gets the PivotTable report by pivottable's position.

◆ release_ref()

virtual int Aspose::Cells::Pivot::IPivotTableCollection::release_ref ( )
inlinevirtual

◆ Remove() [1/2]

virtual void Aspose::Cells::Pivot::IPivotTableCollection::Remove ( intrusive_ptr< Aspose::Cells::Pivot::IPivotTable pivotTable)
pure virtual

Deletes the specified PivotTable and delete the PivotTable data

Parameters
pivotTablePivotTable object

◆ Remove() [2/2]

virtual void Aspose::Cells::Pivot::IPivotTableCollection::Remove ( intrusive_ptr< Aspose::Cells::Pivot::IPivotTable pivotTable,
bool  keepData 
)
pure virtual

Deletes the specified PivotTable

Parameters
pivotTablePivotTable object
keepDataWhether to keep the PivotTable data

◆ RemoveAt() [1/2]

virtual void Aspose::Cells::Pivot::IPivotTableCollection::RemoveAt ( Aspose::Cells::Systems::Int32  index)
pure virtual

Deletes the PivotTable at the specified index and delete the PivotTable data

Parameters
indexthe position index in PivotTable collection

◆ RemoveAt() [2/2]

virtual void Aspose::Cells::Pivot::IPivotTableCollection::RemoveAt ( Aspose::Cells::Systems::Int32  index,
bool  keepData 
)
pure virtual

Deletes the PivotTable at the specified index

Parameters
indexthe position index in PivotTable collection
keepDataWhether to keep the PivotTable data