Class FormatRecord

Record contains information about a number format.

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

Constructors

FormatRecord()

Default constructor

Declaration
public FormatRecord()

FormatRecord(Int32)

Reserved for record's internal data array.

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

FormatRecord(Stream, out Int32)

Read / initialize constructor.

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

FormatString

Length of format string:

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

Index

Format index used in other records:

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

MinimumRecordSize

Read-only. Minimum possible size of record.

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

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