alexa
menu

MAUI

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

    Show / Hide Table of Contents

    Class RuleDataRecord

    This record stores PivotTable rule data.

    Inheritance
    object
    BiffRecordRaw
    RuleDataRecord
    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.RuleData)]
    [CLSCompliant(false)]
    public class RuleDataRecord : BiffRecordRaw, ICloneable, IBiffStorage

    Constructors

    RuleDataRecord()

    Default constructor.

    Declaration
    public RuleDataRecord()

    RuleDataRecord(Stream, out int)

    Read / initialize constructor.

    Declaration
    public RuleDataRecord(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.

    RuleDataRecord(int)

    Reserved for record's internal data array.

    Declaration
    public RuleDataRecord(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

    CurrentField

    Current field.

    Declaration
    public byte CurrentField { get; set; }
    Property Value
    Type
    byte

    Dim

    Position of current field in axis.

    Declaration
    public byte Dim { get; set; }
    Property Value
    Type
    byte

    FiltersCount

    Number of SXFILT records following this record.

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

    IsCacheBased

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

    IsColumnArea

    Indicates whether current field is in column area.

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

    IsDataArea

    Indicates whether current field is in data area.

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

    IsGrandColSav

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

    IsGrandColumn

    Indicates whether column grand total is selected.

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

    IsGrandRow

    Indicates whether row grand total is selected.

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

    IsGrandRowSav

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

    IsNoData

    Indicates whether data is not selected.

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

    IsNoHeader

    Indicates whether header is not selected.

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

    IsPageArea

    Indicates whether current field is in page area.

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

    IsRowArea

    Indicates whether current field is in row area.

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

    Options

    Option flags. Read-only.

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

    Reserved

    Reserved, must be zero.

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

    RuleType

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

    Methods

    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. Convert 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