Class ExtendedXFRecord

Represents Extended XF Record

Inheritance

System.Object

Syncfusion.XlsIO.Parser.Biff_Records.BiffRecordRaw

ExtendedXFRecord

Implements

System.ICloneable

IBiffStorage

Namespace: Syncfusion.XlsIO.Parser.Biff_Records

Assembly: Syncfusion.XlsIO.NET.dll

Syntax

[Biff]
public class ExtendedXFRecord : BiffRecordRaw, ICloneable, IBiffStorage

Constructors

ExtendedXFRecord()

Default constructor

Declaration

public ExtendedXFRecord()

ExtendedXFRecord(Int32)

Reserved for the record's internal data array.

Declaration

public ExtendedXFRecord(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.

ExtendedXFRecord(Stream, out Int32)

Read / initialize constructor.

Declaration

public ExtendedXFRecord(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.

Fields

StartLength

Start length of Extended XF Record

Declaration

public const int StartLength = 20

Field Value

Type
System.Int32

Properties

Properties

Set of properties applied to the XF format

Declaration

public List<ExtendedProperty> Properties { get; set; }

Property Value

Type
System.Collections.Generic.List<ExtendedProperty>

PropertyCount

Properties count

Declaration

public ushort PropertyCount { get; set; }

Property Value

Type
System.UInt16

XFIndex

Specifies the index of XF record which is extended

Declaration

public ushort XFIndex { get; set; }

Property Value

Type
System.UInt16

Methods

Clone()

Clone current Record.

Declaration

public override object Clone()

Returns

Type	Description
System.Object	Returns memberwise clone on current object.

Overrides

Syncfusion.XlsIO.Parser.Biff_Records.BiffRecordRaw.Clone()

CloneObject()

Declaration

public ExtendedXFRecord CloneObject()

Returns

Type
ExtendedXFRecord

CompareTo(ExtendedXFRecord)

Compares with Extended XF format record.

Declaration

public int CompareTo(ExtendedXFRecord twin)

Parameters

Type	Name	Description
ExtendedXFRecord	twin	Param to compare.

Returns

Type	Description
System.Int32	Returns compare results.

CopyTo(BiffRecordRaw)

Copies data from the current Biff record to the specified Biff record.

Declaration

public override void CopyTo(BiffRecordRaw raw)

Parameters

Type	Name	Description
Syncfusion.XlsIO.Parser.Biff_Records.BiffRecordRaw	raw	Biff record that will receive data from the current record.

Overrides

Syncfusion.XlsIO.Parser.Biff_Records.BiffRecordRaw.CopyTo(Syncfusion.XlsIO.Parser.Biff_Records.BiffRecordRaw)

CopyTo(ExtendedXFRecord)

Copies data from the current ExtendedXF record to the specified ExtendedXF record.

Declaration

public void CopyTo(ExtendedXFRecord twin)

Parameters

Type	Name	Description
ExtendedXFRecord	twin	ExtendedXF record that will receive data from the current record.

GetHashCode()

Serves as a hash function for a particular type, suitable for use in hashing algorithms and data structures like a hash table.

Declaration

public override int GetHashCode()

Returns

Type	Description
System.Int32	A hash code for the current Object.

GetStoreSize(ExcelVersion)

Get the size

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)

Exceptions

Type	Condition
WrongBiffRecordDataException	If there is any internal error.

Implements

System.ICloneable

IBiffStorage