alexa
menu

MAUI

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

    Show / Hide Table of Contents

    Class RuleFilterRecord

    This record stores PivotTable Rule Filter options.

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

    Constructors

    RuleFilterRecord()

    Default constructor.

    Declaration
    public RuleFilterRecord()

    RuleFilterRecord(Stream, out int)

    Read / initialize constructor.

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

    RuleFilterRecord(int)

    Reserved for record's internal data array.

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

    Dim

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

    Function

    Declaration
    public RuleFilterRecord.FunctionType Function { get; set; }
    Property Value
    Type
    RuleFilterRecord.FunctionType

    IsColumnField

    Indicates whether field is in column area.

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

    IsDataField

    Indicates whether field is in data area.

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

    IsPageField

    Indicates whether field is in page area.

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

    IsRowField

    Indicates whether field is in row area.

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

    Options1

    Options flags.

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

    Options2

    Options flags. Read-only.

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

    SXVD

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

    ViewItemCount

    Number of ViewItemRecord records.

    Declaration
    public ushort ViewItemCount { 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