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

System.Object

Syncfusion.XlsIO.Parser.Biff_Records.BiffRecordRaw

BiffRecordWithStreamPos

BOFRecord

Implements

System.ICloneable

IBiffStorage

Inherited Members

BiffRecordWithStreamPos.m_lStreamPosition

BiffRecordWithStreamPos.StreamPos

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.BOF)]
[CLSCompliant(false)]
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	Description
System.UInt16

History

File history flag:

Declaration

public int History { get; set; }

Property Value

Type	Description
System.Int32

IsAllowShortData

Indicates whether record allows shorter data. Read-only.

Declaration

public override bool IsAllowShortData { get; }

Property Value

Type	Description
System.Boolean

Overrides

Syncfusion.XlsIO.Parser.Biff_Records.BiffRecordRaw.IsAllowShortData

IsNested

Declaration

public bool IsNested { get; set; }

Property Value

Type	Description
System.Boolean

MaximumRecordSize

Read-only. Returns maximum possible size of record.

Declaration

public override int MaximumRecordSize { get; }

Property Value

Type	Description
System.Int32

Overrides

Syncfusion.XlsIO.Parser.Biff_Records.BiffRecordRaw.MaximumRecordSize

MinimumRecordSize

Read-only. Returns 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

NeedDecoding

Indicates whether record need decoding when file is encoded or not. Read-only.

Declaration

public override bool NeedDecoding { get; }

Property Value

Type	Description
System.Boolean

Overrides

Syncfusion.XlsIO.Parser.Biff_Records.BiffRecordRaw.NeedDecoding

RequeredVersion

Lowest Excel version that can read all records in this file.

Declaration

public int RequeredVersion { get; set; }

Property Value

Type	Description
System.Int32

Type

Type of the following data:

Declaration

public BOFRecord.TType Type { get; set; }

Property Value

Type	Description
BOFRecord.TType

Version

Version:

Declaration

public ushort Version { get; set; }

Property Value

Type	Description
System.UInt16

Year

Build year:

Declaration

public ushort Year { get; set; }

Property Value

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

Overrides

Syncfusion.XlsIO.Parser.Biff_Records.BiffRecordRaw.ParseStructure(Syncfusion.XlsIO.Parser.Biff_Records.DataProvider, System.Int32, System.Int32, Syncfusion.XlsIO.ExcelVersion)

Implements

System.ICloneable

IBiffStorage