Class SortRecord

This record stores the last settings from the "Sort" dialog for each sheet. These settings are not attached to a cell range in the sheet, so it is not possible to determine the cell range sorted with the settings of this record.

Inheritance
System.Object
Syncfusion.XlsIO.Parser.Biff_Records.BiffRecordRaw
SortRecord
Implements
System.ICloneable
Namespace: Syncfusion.XlsIO.Parser.Biff_Records
Assembly: Syncfusion.XlsIO.UWP.dll
Syntax
[Biff]
public class SortRecord : BiffRecordRaw, ICloneable, IBiffStorage

Constructors

SortRecord()

Default constructor

Declaration
public SortRecord()

SortRecord(Int32)

Reserved for record's internal data array.

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

SortRecord(Stream, out Int32)

Read / initialize constructor.

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

FirstKey

First sort key.

Declaration
public string FirstKey { get; set; }
Property Value
Type
System.String

FirstKeyLen

Read-only. Length of first sort key.

Declaration
public byte FirstKeyLen { get; }
Property Value
Type
System.Byte

IsCaseSensitive

False to sort case-insensitive; True to sort case-sensitive.

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

IsFirstDesc

False to sort first key in ascending order; True to sort first key in descending order.

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

IsSecondDesc

False to sort second key in ascending order; True to sort second key in descending order.

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

IsSortColumns

False to sort rows (top to bottom); True to sort columns (left to right).

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

IsThirdDesc

False to sort third key in ascending order; True to sort third key in descending order.

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

MinimumRecordSize

Read-only. Minimum possible size of the record.

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

SecondKey

Second sort key.

Declaration
public string SecondKey { get; set; }
Property Value
Type
System.String

SecondKeyLen

Read-only. Length of second sort key.

Declaration
public byte SecondKeyLen { get; }
Property Value
Type
System.Byte

TableIndex

One-based index into the table of defined sort lists, or 0 for sorting without a list. This property changes some bits of m_usOptions.

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

ThirdKey

Third sort key.

Declaration
public string ThirdKey { get; set; }
Property Value
Type
System.String

ThirdKeyLen

Read-only. Length of third sort key.

Declaration
public byte ThirdKeyLen { get; }
Property Value
Type
System.Byte

Methods

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
System.Int32
Overrides
Syncfusion.XlsIO.Parser.Biff_Records.BiffRecordRaw.GetStoreSize(Syncfusion.XlsIO.ExcelVersion)

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

Extension Methods