Class CacheDataRecord

This record is stored on a separate stream that maintains information about each PivotTable cache. The record is followed by a single CacheDataExRecord and several FDB records, one for each field in the PivotTable. SXDBEX in Excel specification.

Inheritance

System.Object

Syncfusion.XlsIO.Parser.Biff_Records.BiffRecordRaw

CacheDataRecord

Implements

System.ICloneable

IBiffStorage

Inherited Members

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Syncfusion.XlsIO.Parser.Biff_Records.PivotTable

Assembly: Syncfusion.XlsIO.Base.dll

Syntax

[CLSCompliant(false)]
[Biff(TBIFFRecord.CacheData)]
public class CacheDataRecord : BiffRecordRaw, ICloneable, IBiffStorage

Constructors

CacheDataRecord()

Default constructor.

Declaration

public CacheDataRecord()

CacheDataRecord(Int32)

Reserved for record's internal data array.

Declaration

public CacheDataRecord(int iReserve)

Parameters

Type	Name	Description
System.Int32	iReserve	Amount of bytes for the data array.

Exceptions

Type	Condition
System.ArgumentOutOfRangeException	If amount of bytes requested is less than zero.

CacheDataRecord(Stream, out Int32)

Read / initialize constructor.

Declaration

public CacheDataRecord(Stream stream, out int itemSize)

Parameters

Type	Name	Description
System.IO.Stream	stream	Stream from which record data should be read.
System.Int32	itemSize	Size of read item.

Exceptions

Type	Condition
System.ArgumentNullException	When stream is not specified.
System.ApplicationException	When stream does not support read or seek operations.

Properties

BaseFieldsCount

Number of base fields in databases.

Declaration

public ushort BaseFieldsCount { get; set; }

Property Value

Type
System.UInt16

FieldsNumber

Number of base fields, grouped fields, and calculated fields.

Declaration

public ushort FieldsNumber { get; set; }

Property Value

Type
System.UInt16

IsBackgroundQuery

Indicates whether results of the query are obtained in the background.

Declaration

public bool IsBackgroundQuery { get; set; }

Property Value

Type
System.Boolean

IsEnableRefresh

Indicates whether refresh is enabled.

Declaration

public bool IsEnableRefresh { get; set; }

Property Value

Type
System.Boolean

IsInvalid

Indicates whether the PivotTable must be refreshed before next update.

Declaration

public bool IsInvalid { get; set; }

Property Value

Type
System.Boolean

IsOptimizeCache

Indicates whether the cache is optimized to use the least amount of memory.

Declaration

public bool IsOptimizeCache { get; set; }

Property Value

Type
System.Boolean

IsRefreshOnLoad

Indicates whether the PivotTable will be refreshed on load.

Declaration

public bool IsRefreshOnLoad { get; set; }

Property Value

Type
System.Boolean

IsSaveData

Indicates whether data is being saved with table layout.

Declaration

public bool IsSaveData { get; set; }

Property Value

Type
System.Boolean

Options

Option flags.

Declaration

public ushort Options { get; }

Property Value

Type
System.UInt16

RecordsInBlock

Number of records for each database block.

Declaration

public ushort RecordsInBlock { get; set; }

Property Value

Type
System.UInt16

RecordsNumber

Number of records in database.

Declaration

public int RecordsNumber { get; set; }

Property Value

Type
System.Int32

Reserved

This value is not used and can be set to zero. Read-only.

Declaration

public ushort Reserved { get; }

Property Value

Type
System.UInt16

SourceType

Data source is one of: 1 - Excel worksheet, 2 - external data, 4 - consolidation, 8 - scenario PivotTable.

Declaration

public ExcelDataSourceType SourceType { get; set; }

Property Value

Type
ExcelDataSourceType

StreamId

Identifies the stream.

Declaration

public ushort StreamId { get; set; }

Property Value

Type
System.UInt16

UserName

The user who last refreshed the PivotTable.

Declaration

public string UserName { get; set; }

Property Value

Type
System.String

UserNameSize

Number of characters in the string containing the name of the user who last refreshed the PivotTable. Read-only.

Declaration

public ushort UserNameSize { get; }

Property Value

Type
System.UInt16

Methods

FillCache(IRange)

Fills cache with data from the range.

Declaration

public void FillCache(IRange dataRange)

Parameters

Type	Name	Description
IRange	dataRange	Data range to fill.

GetStoreSize(ExcelVersion)

Evaluates size of the required storage space.

Declaration

public override int GetStoreSize(ExcelVersion version)

Parameters

Type	Name	Description
ExcelVersion	version

Returns

Type	Description
System.Int32	Size of the required storage space.

Overrides

Syncfusion.XlsIO.Parser.Biff_Records.BiffRecordRaw.GetStoreSize(Syncfusion.XlsIO.ExcelVersion)

ParseStructure(DataProvider, Int32, Int32, ExcelVersion)

Parse structure of record. Converts data buffer to special values according to record specification.

Declaration

public override void ParseStructure(DataProvider provider, int iOffset, int iLength, ExcelVersion version)

Parameters

Type	Name	Description
DataProvider	provider	Object that provides access to the data.
System.Int32	iOffset	Offset to the record's data.
System.Int32	iLength	Length of the record's data.
ExcelVersion	version	Excel version used for infill.

Overrides

Syncfusion.XlsIO.Parser.Biff_Records.BiffRecordRaw.ParseStructure(Syncfusion.XlsIO.Parser.Biff_Records.DataProvider, System.Int32, System.Int32, Syncfusion.XlsIO.ExcelVersion)

Implements

System.ICloneable

IBiffStorage