Class AutoFilterRecord

Summary description for AutoFilterInfoRecord.

Inheritance
System.Object
Syncfusion.XlsIO.Parser.Biff_Records.BiffRecordRaw
AutoFilterRecord
Implements
System.ICloneable
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Syncfusion.XlsIO.Parser.Biff_Records
Assembly: Syncfusion.XlsIO.Base.dll
Syntax
[CLSCompliant(false)]
[Biff(TBIFFRecord.AutoFilter)]
public class AutoFilterRecord : BiffRecordRaw, IBiffStorage, ICloneable

Constructors

AutoFilterRecord()

Default constructor fills all data with default values.

Declaration
public AutoFilterRecord()

AutoFilterRecord(Int32)

Reserved for record's internal data array.

Declaration
public AutoFilterRecord(int iReserve)
Parameters
Type Name Description
System.Int32 iReserve

Amount of bytes for data array.
Exceptions
Type Condition
System.ArgumentOutOfRangeException

If amount of bytes requested is less than zero.

AutoFilterRecord(Stream, out Int32)

Read / initialize Constructor.

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

If stream is not specified.
System.ApplicationException

If stream does not support read or seek operations.

Properties

FirstCondition

First condition.

Declaration
public AutoFilterRecord.DOPER FirstCondition { get; }
Property Value
Type Description
AutoFilterRecord.DOPER

Index

Number of AutoFilter drop-down arrows on the sheet.

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

IsAnd

True if the custom filter conditions are ANDed; False if the custom filter conditions are ORed.

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

IsBlank

If filtered to blanks - true. Read-only.

Declaration
public bool IsBlank { get; }
Property Value
Type Description
System.Boolean

IsNonBlank

If filtered to nonblanks - true. Read-only.

Declaration
public bool IsNonBlank { get; }
Property Value
Type Description
System.Boolean

IsPercent

True if the Top 10 AutoFilter shows percentage; False if it shows items.

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

IsSimple1

True if the first condition is a simple equality.

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

IsSimple2

True if the second condition is a simple equality.

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

IsTop

True if the Top 10 AutoFilter shows the top items; False if it shows the bottom items.

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

IsTop10

True if the condition is a Top 10 AutoFilter.

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

MinimumRecordSize

Read-only. Minimum possible size of the record.

Declaration
public override int MinimumRecordSize { get; }
Property Value
Type Description
System.Int32
Overrides
Syncfusion.XlsIO.Parser.Biff_Records.BiffRecordRaw.MinimumRecordSize

NeedDataArray

Declaration
public override bool NeedDataArray { get; }
Property Value
Type Description
System.Boolean
Overrides
Syncfusion.XlsIO.Parser.Biff_Records.BiffRecordRaw.NeedDataArray

Options

Option flags. Read-only.

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

SecondCondition

Second condition.

Declaration
public AutoFilterRecord.DOPER SecondCondition { get; }
Property Value
Type Description
AutoFilterRecord.DOPER

Top10Number

Number of elements to show in Top10 mode.

Declaration
public int Top10Number { get; set; }
Property Value
Type Description
System.Int32

Methods

Clone()

Creates a new object that is a copy of the current instance.

Declaration
public object Clone()
Returns
Type Description
System.Object

A new object that is a copy of this instance.

GetStoreSize(ExcelVersion)

Size of the required storage space. Read-only.

Declaration
public override int GetStoreSize(ExcelVersion version)
Parameters
Type Name Description
ExcelVersion version
Returns
Type Description
System.Int32
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