Class RuleFilterRecord

This record stores PivotTable Rule Filter options.

Inheritance
System.Object
Syncfusion.XlsIO.Parser.Biff_Records.BiffRecordRaw
RuleFilterRecord
Implements
System.ICloneable
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
[Biff(TBIFFRecord.RuleFilter)]
[CLSCompliant(false)]
public class RuleFilterRecord : BiffRecordRaw, ICloneable, IBiffStorage

Constructors

RuleFilterRecord()

Default constructor.

Declaration
public RuleFilterRecord()

RuleFilterRecord(Int32)

Reserved for record's internal data array.

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

RuleFilterRecord(Stream, out Int32)

Read / initialize constructor.

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

Dim

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

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
System.Boolean

IsDataField

Indicates whether field is in data area.

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

IsPageField

Indicates whether field is in page area.

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

IsRowField

Indicates whether field is in row area.

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

Options1

Options flags.

Declaration
public ushort Options1 { get; }
Property Value
Type
System.UInt16

Options2

Options flags. Read-only.

Declaration
public ushort Options2 { get; }
Property Value
Type
System.UInt16

SXVD

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

ViewItemCount

Number of ViewItemRecord records.

Declaration
public ushort ViewItemCount { get; set; }
Property Value
Type
System.UInt16

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