Class BiffRecordFactory
This class contains information about all known biff records. Used for registering the biff record type, creating new biff records and extracting them from a stream.
Inheritance
Namespace: Syncfusion.XlsIO.Parser
Assembly: Syncfusion.XlsIO.UWP.dll
Syntax
public class BiffRecordFactory : ObjectConstructors
BiffRecordFactory()
Declaration
public BiffRecordFactory()Methods
ExtractRecordType(BinaryReader)
Extracts from the BinaryReader type of the next record.
Declaration
public static int ExtractRecordType(BinaryReader reader)Parameters
| Type | Name | Description |
|---|---|---|
| System.IO.BinaryReader | reader | BinaryReader that contains record to extract. |
Returns
| Type | Description |
|---|---|
| System.Int32 | Type of the next record in the BinaryReader. |
Exceptions
| Type | Condition |
|---|---|
| System.ArgumentNullException | When reader is null. |
| System.ApplicationException | When code of the extracted record is zero. |
ExtractRecordType(Stream)
Extract from stream Next Record type.
Declaration
public static int ExtractRecordType(Stream stream)Parameters
| Type | Name | Description |
|---|---|---|
| System.IO.Stream | stream | Stream that contains record to extract. |
Returns
| Type | Description |
|---|---|
| System.Int32 | Extracted record. |
GetRecord(DataProvider, Int32, ExcelVersion)
Extracts record from array of bytes.
Declaration
public static BiffRecordRaw GetRecord(DataProvider provider, int iOffset, ExcelVersion version)Parameters
| Type | Name | Description |
|---|---|---|
| DataProvider | provider | Object that provides access to the data. |
| System.Int32 | iOffset | Offset to the record's start. |
| ExcelVersion | version | Excel version used for infill. |
Returns
| Type | Description |
|---|---|
| Syncfusion.XlsIO.Parser.Biff_Records.BiffRecordRaw | Extracted record. |
GetRecord(TBIFFRecord)
Create empty record by specified type.
Declaration
public static BiffRecordRaw GetRecord(TBIFFRecord type)Parameters
| Type | Name | Description |
|---|---|---|
| TBIFFRecord | type | Type of the record that should be created. |
Returns
| Type | Description |
|---|---|
| Syncfusion.XlsIO.Parser.Biff_Records.BiffRecordRaw | Created record if succeeded, null otherwise. |
GetRecord(TBIFFRecord, BinaryReader, Byte[])
Extracts specified record from the reader.
Declaration
public static BiffRecordRaw GetRecord(TBIFFRecord type, BinaryReader reader, byte[] arrBuffer)Parameters
| Type | Name | Description |
|---|---|---|
| TBIFFRecord | type | Type of the record to be extracted. |
| System.IO.BinaryReader | reader | Reader that contains record. |
| System.Byte[] | arrBuffer | Temporary buffer needed for some operations. |
Returns
| Type | Description |
|---|---|
| Syncfusion.XlsIO.Parser.Biff_Records.BiffRecordRaw | Extracted record. |
Exceptions
| Type | Condition |
|---|---|
| System.ArgumentNullException | When specified reader is null. |
GetRecord(Int32)
Create empty record by specified type.
Declaration
public static BiffRecordRaw GetRecord(int type)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | type | Type of the record that should be created. |
Returns
| Type | Description |
|---|---|
| Syncfusion.XlsIO.Parser.Biff_Records.BiffRecordRaw | Created record if succeeded, null otherwise. |
GetRecord(Int32, BinaryReader, DataProvider, IDecryptor, Byte[])
Extracts specified record from the reader
Declaration
public static BiffRecordRaw GetRecord(int type, BinaryReader reader, DataProvider provider, IDecryptor decryptor, byte[] arrBuffer)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | type | Type of the record to be extracted |
| System.IO.BinaryReader | reader | Reader that contains record |
| DataProvider | provider | Object that provider access to the record data. |
| IDecryptor | decryptor | Decryptor used to parse encrypted records. This argument can be null when no decryption is required. |
| System.Byte[] | arrBuffer | Temporary buffer needed for some operations. |
Returns
| Type | Description |
|---|---|
| Syncfusion.XlsIO.Parser.Biff_Records.BiffRecordRaw | Extracted record |
Exceptions
| Type | Condition |
|---|---|
| System.ArgumentNullException | When specified reader is null |
GetRecord(Int32, BinaryReader, Byte[])
Extracts specified record from the reader.
Declaration
public static BiffRecordRaw GetRecord(int type, BinaryReader reader, byte[] arrBuffer)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | type | Type of the record to be extracted. |
| System.IO.BinaryReader | reader | Reader that contains record. |
| System.Byte[] | arrBuffer | Temporary buffer needed for some operations. |
Returns
| Type | Description |
|---|---|
| Syncfusion.XlsIO.Parser.Biff_Records.BiffRecordRaw | Extracted record. |
Exceptions
| Type | Condition |
|---|---|
| System.ArgumentNullException | When specified reader is null. |
GetRecord(BinaryReader, DataProvider, IDecryptor, Byte[])
Extracts record from the BinaryReader.
Declaration
public static BiffRecordRaw GetRecord(BinaryReader reader, DataProvider provider, IDecryptor decryptor, byte[] arrBuffer)Parameters
| Type | Name | Description |
|---|---|---|
| System.IO.BinaryReader | reader | BinaryReader that contains record to extract. |
| DataProvider | provider | Object that provides access to the data. |
| IDecryptor | decryptor | Object used to decrypt encrypted records. |
| System.Byte[] | arrBuffer | Temporary buffer needed for some operations. |
Returns
| Type | Description |
|---|---|
| Syncfusion.XlsIO.Parser.Biff_Records.BiffRecordRaw | Extracted record. |
GetRecord(BinaryReader, DataProvider, Byte[])
Extracts record from the BinaryReader.
Declaration
public static BiffRecordRaw GetRecord(BinaryReader reader, DataProvider provider, byte[] arrBuffer)Parameters
| Type | Name | Description |
|---|---|---|
| System.IO.BinaryReader | reader | BinaryReader that contains record to extract. |
| DataProvider | provider | Object that provides access to the data. |
| System.Byte[] | arrBuffer | Temporary buffer needed for some operations. |
Returns
| Type | Description |
|---|---|
| Syncfusion.XlsIO.Parser.Biff_Records.BiffRecordRaw | Extracted record. |
GetUntypedRecord(BinaryReader)
Extracts unknown record from the stream
Declaration
public static BiffRecordRaw GetUntypedRecord(BinaryReader reader)Parameters
| Type | Name | Description |
|---|---|---|
| System.IO.BinaryReader | reader | Reader that contains record |
Returns
| Type | Description |
|---|---|
| Syncfusion.XlsIO.Parser.Biff_Records.BiffRecordRaw | Extracted unknown record |
GetUntypedRecord(Stream)
Extracts unknown record from the stream
Declaration
public static BiffRecordRaw GetUntypedRecord(Stream stream)Parameters
| Type | Name | Description |
|---|---|---|
| System.IO.Stream | stream | Stream that contains needed record |
Returns
| Type | Description |
|---|---|
| Syncfusion.XlsIO.Parser.Biff_Records.BiffRecordRaw | Extracted unknown record |