PivotCache Class |
Represents a cache of data used by a PivotTable in Excel. The PivotCache stores the data source and any filters or transformations applied to the data, which can then be used to quickly refresh the PivotTable without re-querying the original data source.
Inheritance Hierarchy
System
Object
Spire.Xls.Core.Spreadsheet XlsObject
Spire.Xls.Core.Spreadsheet.PivotTables XlsPivotCache
Spire.Xls PivotCache
Spire.Xls.Core.Spreadsheet XlsObject
Spire.Xls.Core.Spreadsheet.PivotTables XlsPivotCache
Spire.Xls PivotCache
Namespace: Spire.Xls
Assembly: Spire.XLS (in Spire.XLS.dll) Version: 15.4.0.0 (15.4.0.5046)
Syntax
The PivotCache type exposes the following members.
Properties
| Name | Description | |
|---|---|---|
|
CalculatedItemIndex |
Gets the calculated index of the item. This property always returns 1.
(Inherited from
XlsPivotCache
.)
|
|
|
CreatedVersion |
Specifies the version of the application that created the cache. This attribute is
application-dependent.
(Inherited from
XlsPivotCache
.)
|
|
|
EnableRefresh |
Specifies a boolean value that indicates whether the user can refresh the cache.
(Inherited from
XlsPivotCache
.)
|
|
|
HasNamedRange |
Indicates whether the pivot cache has named range
(Inherited from
XlsPivotCache
.)
|
|
|
Index |
Gets zero-based cache index.Read-only.
(Inherited from
XlsPivotCache
.)
|
|
|
IsBackgroundQuery |
Specifies a boolean value that indicates whether the application should query and
retrieve records asynchronously from the cache.
(Inherited from
XlsPivotCache
.)
|
|
|
IsInvalidData |
Specifies a boolean value that indicates whether the cache needs to be refreshed.
(Inherited from
XlsPivotCache
.)
|
|
|
IsOptimizedCache |
Specifies a boolean value that indicates whether the application will apply optimizations
to the cache to reduce memory usage
(Inherited from
XlsPivotCache
.)
|
|
|
IsRefreshOnLoad |
Specifies a boolean value that indicates whether the application will refresh the cache
(Inherited from
XlsPivotCache
.)
|
|
|
IsSaveData |
Specifies a boolean value that indicates whether the pivot records are saved with the
cache.
(Inherited from
XlsPivotCache
.)
|
|
|
IsSupportSubQuery |
Specifies whether the cache's data source supports subqueries
(Inherited from
XlsPivotCache
.)
|
|
|
IsUpgradeOnRefresh |
Specifies a boolean value that indicates whether the cache is scheduled for version
upgrade.
(Inherited from
XlsPivotCache
.)
|
|
|
MinRefreshableVersion |
Specifies the earliest version of the application that is required to refresh the cache.
(Inherited from
XlsPivotCache
.)
|
|
|
NeedDataArray |
Indicates whether data array is required by this record.
(Inherited from
XlsPivotCache
.)
|
|
|
Parent |
Gets parent object.
(Inherited from
XlsPivotCache
.)
|
|
|
RangeName |
Contains the name of the pivot cache NamedRange
(Inherited from
XlsPivotCache
.)
|
|
ReferenceCount |
Get quantity of instance references.
(Inherited from
XlsObject
.)
|
|
|
RefreshDate |
Gets/sets refresh date of the cache.
(Inherited from
XlsPivotCache
.)
|
|
|
RefreshedBy |
Gets or sets the name or identifier of the user or process that last refreshed the data.
(Inherited from
XlsPivotCache
.)
|
|
|
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.
(Inherited from
XlsPivotCache
.)
|
|
|
SourceRange |
Returns the data source for the PivotTable report. Read-only.
(Inherited from
XlsPivotCache
.)
|
|
|
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.
(Inherited from
XlsPivotCache
.)
|
|
|
SupportAdvancedDrill |
Specifies whether the cache's data source supports attribute drilldown.
(Inherited from
XlsPivotCache
.)
|
Methods
| Name | Description | |
|---|---|---|
|
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
.)
|
|
|
CheckDisposed |
Checks whether object was disposed and throws exception if it was.
(Inherited from
XlsObject
.)
|
|
Clone(Object) |
Creates a clone of the current object with a new parent for worksheets.
(Inherited from
XlsPivotCache
.)
|
|
|
Clone(Object, Dictionary String, String ) |
Creates a clone of the current object with a new parent and a dictionary of new names for worksheets.
(Inherited from
XlsPivotCache
.)
|
|
|
Dispose |
Dispose object and free resources.
(Inherited from
XlsObject
.)
|
|
|
Equals |
Determines whether the specified object is equal to the current object.
(Inherited from
Object
.)
|
|
|
Finalize |
Destructor. Call dispose method of current object.
(Inherited from
XlsObject
.)
|
|
|
FindParent(Type) |
This method is used to find parent with specific type.
(Inherited from
XlsObject
.)
|
|
|
FindParent( Type ) |
Find parent of object.
(Inherited from
XlsObject
.)
|
|
|
FindParent(Type, Boolean) |
This method is used to find parent with specific type.
(Inherited from
XlsObject
.)
|
|
|
FindParents |
Finds parent objects.
(Inherited from
XlsObject
.)
|
|
|
GetHashCode |
Serves as the default hash function.
(Inherited from
Object
.)
|
|
|
GetType |
Gets the
Type
of the current instance.
(Inherited from
Object
.)
|
|
|
MemberwiseClone |
Creates a shallow copy of the current
Object
.
(Inherited from
Object
.)
|
|
|
OnDispose |
Method which can be overriden by users to take any specific actions when
object is disposed.
(Inherited from
XlsObject
.)
|
|
|
ReleaseReference |
Decrease quantity of Reference. User must call this method
when freeing resources.
(Inherited from
XlsObject
.)
|
|
|
SetParent |
Sets parent of the object.
(Inherited from
XlsObject
.)
|
|
|
ToString |
Returns a string that represents the current object.
(Inherited from
Object
.)
|
Fields
| Name | Description | |
|---|---|---|
|
m_bIsDisposed |
Flag which indicates if the object was disposed or not.
(Inherited from
XlsObject
.)
|
See Also
