Class BeginRecord
The begin record defines the start of a block of records for a (Graphing) data object. This record is matched with a corresponding EndRecord.
Inheritance
Inherited Members
Namespace: Syncfusion.XlsIO.Parser.Biff_Records
Assembly: Syncfusion.XlsIO.Base.dll
Syntax
[Biff(TBIFFRecord.Begin)]
[CLSCompliant(false)]
public class BeginRecord : BiffRecordRawWithArray, ICloneable, IBiffStorage, IDisposable
Constructors
BeginRecord()
Default constructor.
Declaration
public BeginRecord()
BeginRecord(Int32)
Reserved for record's internal data array.
Declaration
public BeginRecord(int iReserve)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | iReserve | Amount of bytes for the data array. |
Exceptions
Type | Condition |
---|---|
System.ArgumentOutOfRangeException | If amount of bytes requested is less than zero. |
BeginRecord(Stream, out Int32)
Read / initialize constructor.
Declaration
public BeginRecord(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
MaximumRecordSize
Read-only. Maximum possible size of the record.
Declaration
public override int MaximumRecordSize { get; }
Property Value
Type | Description |
---|---|
System.Int32 |
Overrides
Methods
ParseStructure()
Parse structure of record. Converts data buffer to special values according to record specification.
Declaration
public override void ParseStructure()
Overrides
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. |