alexa
menu

MAUI

  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Search Results for

    Show / Hide Table of Contents

    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
    object
    BiffRecordRaw
    CacheDataRecord
    Implements
    ICloneable
    IBiffStorage
    Inherited Members
    object.Equals(object)
    object.Equals(object, object)
    object.GetHashCode()
    object.GetType()
    object.MemberwiseClone()
    object.ReferenceEquals(object, object)
    object.ToString()
    Namespace: Syncfusion.XlsIO.Parser.Biff_Records.PivotTable
    Assembly: Syncfusion.XlsIO.NET.dll
    Syntax
    [Biff(TBIFFRecord.CacheData)]
    [CLSCompliant(false)]
    public class CacheDataRecord : BiffRecordRaw, ICloneable, IBiffStorage

    Constructors

    CacheDataRecord()

    Default constructor.

    Declaration
    public CacheDataRecord()

    CacheDataRecord(Stream, out int)

    Read / initialize constructor.

    Declaration
    public CacheDataRecord(Stream stream, out int itemSize)
    Parameters
    Type Name Description
    Stream stream

    Stream from which record data should be read.

    int itemSize

    Size of read item.

    Exceptions
    Type Condition
    ArgumentNullException

    When stream is not specified.

    ApplicationException

    When stream does not support read or seek operations.

    CacheDataRecord(int)

    Reserved for record's internal data array.

    Declaration
    public CacheDataRecord(int iReserve)
    Parameters
    Type Name Description
    int iReserve

    Amount of bytes for the data array.

    Exceptions
    Type Condition
    ArgumentOutOfRangeException

    If amount of bytes requested is less than zero.

    Properties

    BaseFieldsCount

    Number of base fields in databases.

    Declaration
    public ushort BaseFieldsCount { get; set; }
    Property Value
    Type
    ushort

    FieldsNumber

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

    Declaration
    public ushort FieldsNumber { get; set; }
    Property Value
    Type
    ushort

    IsBackgroundQuery

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

    Declaration
    public bool IsBackgroundQuery { get; set; }
    Property Value
    Type
    bool

    IsEnableRefresh

    Indicates whether refresh is enabled.

    Declaration
    public bool IsEnableRefresh { get; set; }
    Property Value
    Type
    bool

    IsInvalid

    Indicates whether the PivotTable must be refreshed before next update.

    Declaration
    public bool IsInvalid { get; set; }
    Property Value
    Type
    bool

    IsOptimizeCache

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

    Declaration
    public bool IsOptimizeCache { get; set; }
    Property Value
    Type
    bool

    IsRefreshOnLoad

    Indicates whether the PivotTable will be refreshed on load.

    Declaration
    public bool IsRefreshOnLoad { get; set; }
    Property Value
    Type
    bool

    IsSaveData

    Indicates whether data is being saved with table layout.

    Declaration
    public bool IsSaveData { get; set; }
    Property Value
    Type
    bool

    Options

    Option flags.

    Declaration
    public ushort Options { get; }
    Property Value
    Type
    ushort

    RecordsInBlock

    Number of records for each database block.

    Declaration
    public ushort RecordsInBlock { get; set; }
    Property Value
    Type
    ushort

    RecordsNumber

    Number of records in database.

    Declaration
    public int RecordsNumber { get; set; }
    Property Value
    Type
    int

    Reserved

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

    Declaration
    public ushort Reserved { get; }
    Property Value
    Type
    ushort

    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
    ushort

    UserName

    The user who last refreshed the PivotTable.

    Declaration
    public string UserName { get; set; }
    Property Value
    Type
    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
    ushort

    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
    int

    Size of the required storage space.

    Overrides
    BiffRecordRaw.GetStoreSize(ExcelVersion)

    ParseStructure(DataProvider, int, int, 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.

    int iOffset

    Offset to the record's data.

    int iLength

    Length of the record's data.

    ExcelVersion version

    Excel version used for infill.

    Overrides
    BiffRecordRaw.ParseStructure(DataProvider, int, int, ExcelVersion)

    Implements

    ICloneable
    IBiffStorage
    In this article
    Back to top Generated by DocFX
    Copyright © 2001 - 2026 Syncfusion Inc. All Rights Reserved