Class FormatRecord
Record contains information about a number format.
Inheritance
Namespace: Syncfusion.XlsIO.Parser.Biff_Records
Assembly: Syncfusion.XlsIO.UWP.dll
Syntax
[Biff]
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 |
---|
System.String |
Index
Format index used in other records:
Declaration
public int Index { get; set; }
Property Value
Type |
---|
System.Int32 |
MinimumRecordSize
Read-only. Minimum possible size of record.
Declaration
public override int MinimumRecordSize { get; }
Property Value
Type |
---|
System.Int32 |
Overrides
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
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
Exceptions
Type | Condition |
---|---|
WrongBiffRecordDataException | If there is any internal error. |