Class BOFRecord
Summary description for BOFRecord. It is used for the beginning of a set of records that have a particular purpose or subject. Used in sheets and workbooks.
Inheritance
Namespace: Syncfusion.XlsIO.Parser.Biff_Records
Assembly: Syncfusion.XlsIO.UWP.dll
Syntax
[Biff]
public class BOFRecord : BiffRecordWithStreamPos, ICloneable, IBiffStorage
Constructors
BOFRecord()
Default Constructor
Declaration
public BOFRecord()
BOFRecord(Int32)
Reserved for the record's internal data array.
Declaration
public BOFRecord(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. |
BOFRecord(Stream, out Int32)
Read / initialize Constructor.
Declaration
public BOFRecord(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 | When stream is not specified. |
System.ApplicationException | When stream does not support read or seek operations. |
Properties
Build
Build identifier:
Declaration
public ushort Build { get; set; }
Property Value
Type |
---|
System.UInt16 |
History
File history flag:
Declaration
public int History { get; set; }
Property Value
Type |
---|
System.Int32 |
IsAllowShortData
Indicates whether record allows shorter data. Read-only.
Declaration
public override bool IsAllowShortData { get; }
Property Value
Type |
---|
System.Boolean |
Overrides
IsNested
Declaration
public bool IsNested { get; set; }
Property Value
Type |
---|
System.Boolean |
MaximumRecordSize
Read-only. Returns maximum possible size of record.
Declaration
public override int MaximumRecordSize { get; }
Property Value
Type |
---|
System.Int32 |
Overrides
MinimumRecordSize
Read-only. Returns minimum possible size of record.
Declaration
public override int MinimumRecordSize { get; }
Property Value
Type |
---|
System.Int32 |
Overrides
NeedDecoding
Indicates whether record need decoding when file is encoded or not. Read-only.
Declaration
public override bool NeedDecoding { get; }
Property Value
Type |
---|
System.Boolean |
Overrides
RequeredVersion
Lowest Excel version that can read all records in this file.
Declaration
public int RequeredVersion { get; set; }
Property Value
Type |
---|
System.Int32 |
Type
Type of the following data:
Declaration
public BOFRecord.TType Type { get; set; }
Property Value
Type |
---|
BOFRecord.TType |
Version
Version:
Declaration
public ushort Version { get; set; }
Property Value
Type |
---|
System.UInt16 |
Year
Build year:
Declaration
public ushort Year { get; set; }
Property Value
Type |
---|
System.UInt16 |
Methods
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. |