Click or drag to resize

XlsPivotCache Class

Represents a pivot cache in an Excel workbook, which is used to store and manage the data for one or more PivotTables.
Inheritance Hierarchy
System Object
Spire.Xls.Core.Spreadsheet XlsObject
Spire.Xls.Core.Spreadsheet.PivotTables XlsPivotCache
Spire.Xls PivotCache

Namespace: Spire.Xls.Core.Spreadsheet.PivotTables
Assembly: Spire.XLS (in Spire.XLS.dll) Version: 15.4.0.0 (15.4.0.5046)
Syntax
Copy 
public class XlsPivotCache : XlsObject, 
	IPivotCache

The XlsPivotCache type exposes the following members.

Properties
Name Description
Public property CalculatedItemIndex
Gets the calculated index of the item. This property always returns 1.
Public property CreatedVersion
Specifies the version of the application that created the cache. This attribute is application-dependent.
Public property EnableRefresh
Specifies a boolean value that indicates whether the user can refresh the cache.
Public property HasNamedRange
Indicates whether the pivot cache has named range
Public property Index
Gets zero-based cache index.Read-only.
Public property IsBackgroundQuery
Specifies a boolean value that indicates whether the application should query and retrieve records asynchronously from the cache.
Public property IsInvalidData
Specifies a boolean value that indicates whether the cache needs to be refreshed.
Public property IsOptimizedCache
Specifies a boolean value that indicates whether the application will apply optimizations to the cache to reduce memory usage
Public property IsRefreshOnLoad
Specifies a boolean value that indicates whether the application will refresh the cache
Public property IsSaveData
Specifies a boolean value that indicates whether the pivot records are saved with the cache.
Public property IsSupportSubQuery
Specifies whether the cache's data source supports subqueries
Public property IsUpgradeOnRefresh
Specifies a boolean value that indicates whether the cache is scheduled for version upgrade.
Public property MinRefreshableVersion
Specifies the earliest version of the application that is required to refresh the cache.
Public property NeedDataArray
Indicates whether data array is required by this record.
Public property Parent
Gets parent object.
Public property RangeName
Contains the name of the pivot cache NamedRange
Protected property ReferenceCount
Get quantity of instance references.
(Inherited from XlsObject .)
Public property RefreshDate
Gets/sets refresh date of the cache.
Public property RefreshedBy
Gets or sets the name or identifier of the user or process that last refreshed the data.
Public property RefreshedVersion
Specifies the version of the application that last refreshed the cache. This attribute depends on whether the application exposes mechanisms via the user interface whereby the end-user can refresh the cache.
Public property SourceRange
Returns the data source for the PivotTable report. Read-only.
Public property SourceType
Data source is one of: 1 - Excel worksheet, 2 - external data, 4 - consolidation, 8 - scenario PivotTable. Specifies the pivot table cache source type.Read-only.
Public property SupportAdvancedDrill
Specifies whether the cache's data source supports attribute drilldown.
Top
Methods
Name Description
Protected method AddReference
Increase the quantity of reference. User must use this method when new wrapper on object is created or reference on object stored.
(Inherited from XlsObject .)
Protected method CheckDisposed
Checks whether object was disposed and throws exception if it was.
(Inherited from XlsObject .)
Public method Clone(Object)
Creates a clone of the current object with a new parent for worksheets.
Public method Clone(Object, Dictionary String, String )
Creates a clone of the current object with a new parent and a dictionary of new names for worksheets.
Public method Dispose
Dispose object and free resources.
(Inherited from XlsObject .)
Public method Equals
Determines whether the specified object is equal to the current object.
(Inherited from Object .)
Protected method Finalize
Destructor. Call dispose method of current object.
(Inherited from XlsObject .)
Protected method FindParent(Type)
This method is used to find parent with specific type.
(Inherited from XlsObject .)
Protected method FindParent( Type )
Find parent of object.
(Inherited from XlsObject .)
Protected method FindParent(Type, Boolean)
This method is used to find parent with specific type.
(Inherited from XlsObject .)
Protected method FindParents
Finds parent objects.
(Inherited from XlsObject .)
Public method GetHashCode
Serves as the default hash function.
(Inherited from Object .)
Public method GetType
Gets the Type of the current instance.
(Inherited from Object .)
Public method Static member InRange
Indicates whether specified insert row/column operation affected pivot cache in some way.
Protected method MemberwiseClone
Creates a shallow copy of the current Object .
(Inherited from Object .)
Protected method OnDispose
Method which can be overriden by users to take any specific actions when object is disposed.
(Inherited from XlsObject .)
Protected method ReleaseReference
Decrease quantity of Reference. User must call this method when freeing resources.
(Inherited from XlsObject .)
Protected method SetParent
Sets parent of the object.
(Inherited from XlsObject .)
Public method ToString
Returns a string that represents the current object.
(Inherited from Object .)
Top
Fields
Name Description
Protected field m_bIsDisposed
Flag which indicates if the object was disposed or not.
(Inherited from XlsObject .)
Top
See Also