Class XlsPivotCache

Namespace

Spire.Xls.Core.Spreadsheet.PivotTables

Assembly

Spire.XLS.dll

public class XlsPivotCache : XlsObject, IExcelApplication, IDisposable, IPivotCache

Inheritance

object

XlsObject

XlsPivotCache

Implements

IExcelApplication

IDisposable

IPivotCache

Derived

PivotCache

Inherited Members

XlsObject.m_bIsDisposed

XlsObject.AddReference()

XlsObject.ReleaseReference()

XlsObject.Dispose()

XlsObject.OnDispose()

XlsObject.FindParent(Type)

XlsObject.FindParent(Type, bool)

XlsObject.FindParent(object, Type)

XlsObject.FindParent(object, Type, bool)

XlsObject.FindParents(Type[])

XlsObject.FindParent(Type[])

XlsObject.SetParent(object)

XlsObject.CheckDisposed()

XlsObject.ReferenceCount

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Properties

CalculatedItemIndex

public int CalculatedItemIndex { get; }

Property Value

int

CreatedVersion

Specifies the version of the application that created the cache. This attribute is application-dependent.

public int CreatedVersion { get; set; }

Property Value

int

EnableRefresh

Specifies a boolean value that indicates whether the user can refresh the cache.

public bool EnableRefresh { get; set; }

Property Value

bool

HasNamedRange

Indicates whether the pivot cache has named range

public bool HasNamedRange { get; }

Property Value

bool

Index

public int Index { get; }

Property Value

int

IsBackgroundQuery

Specifies a boolean value that indicates whether the application should query and retrieve records asynchronously from the cache.

public bool IsBackgroundQuery { get; set; }

Property Value

bool

IsInvalidData

Specifies a boolean value that indicates whether the cache needs to be refreshed.

public bool IsInvalidData { get; set; }

Property Value

bool

IsOptimizedCache

Specifies a boolean value that indicates whether the application will apply optimizations to the cache to reduce memory usage

public bool IsOptimizedCache { get; set; }

Property Value

bool

IsRefreshOnLoad

Specifies a boolean value that indicates whether the application will refresh the cache

public bool IsRefreshOnLoad { get; set; }

Property Value

bool

IsSaveData

Specifies a boolean value that indicates whether the pivot records are saved with the cache.

public bool IsSaveData { get; set; }

Property Value

bool

IsSupportSubQuery

Specifies whether the cache's data source supports subqueries

public bool IsSupportSubQuery { get; set; }

Property Value

bool

IsUpgradeOnRefresh

Specifies a boolean value that indicates whether the cache is scheduled for version upgrade.

public bool IsUpgradeOnRefresh { get; set; }

Property Value

bool

MinRefreshableVersion

Specifies the earliest version of the application that is required to refresh the cache.

public int MinRefreshableVersion { get; set; }

Property Value

int

NeedDataArray

public bool NeedDataArray { get; }

Property Value

bool

Parent

public XlsPivotCachesCollection Parent { get; }

Property Value

XlsPivotCachesCollection

RangeName

Contains the name of the pivot cache NamedRange

public string RangeName { get; set; }

Property Value

string

RefreshDate

public DateTime RefreshDate { get; set; }

Property Value

DateTime

RefreshedBy

public string RefreshedBy { get; set; }

Property Value

string

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 int RefreshedVersion { get; set; }

Property Value

int

SourceRange

public IXLSRange SourceRange { get; }

Property Value

IXLSRange

SourceType

public DataSourceType SourceType { get; }

Property Value

DataSourceType

SupportAdvancedDrill

public bool SupportAdvancedDrill { get; set; }

Property Value

bool

Methods

Clone(object)

public object Clone(object parent)

Parameters

parent object

Returns

object

Clone(object, Dictionary<string, string>)

public object Clone(object parent, Dictionary<string, string> hashNewNames)

Parameters

parent object

hashNewNames Dictionary<string, string>

Returns

object

InRange(IXLSRange, XlsWorksheet, int, int, bool)

public static bool InRange(IXLSRange sourceRange, XlsWorksheet worksheet, int index, int count, bool isRow)

Parameters

sourceRange IXLSRange

worksheet XlsWorksheet

index int

count int

isRow bool

Returns

bool