Class BiffReader

Class for extracting Biff records from the stream.

Inheritance

System.Object

BiffReader

Implements

System.IDisposable

Inherited Members

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Syncfusion.XlsIO.Parser

Assembly: Syncfusion.XlsIO.Base.dll

Syntax

[CLSCompliant(false)]
public class BiffReader : IDisposable

Constructors

BiffReader(Stream)

Open stream for reading.

Declaration

public BiffReader(Stream stream)

Parameters

Type	Name	Description
System.IO.Stream	stream	Input stream which contains data.

BiffReader(Stream, Boolean)

Open stream for reading and control stream live time.

Declaration

public BiffReader(Stream stream, bool bControlStream)

Parameters

Type	Name	Description
System.IO.Stream	stream	Input stream which contains data
System.Boolean	bControlStream	TRUE - reader will dispose stream on own destroy, otherwise FALSE

Properties

BaseReader

Returns base BinaryReader. Read-only.

Declaration

public BinaryReader BaseReader { get; }

Property Value

Type
System.IO.BinaryReader

BaseStream

Base stream.

Declaration

public Stream BaseStream { get; }

Property Value

Type
System.IO.Stream

Buffer

Returns reference to the internal buffer. Read-only.

Declaration

public byte[] Buffer { get; }

Property Value

Type
System.Byte[]

DataProvider

Returns object that provides access to the data. Read-only.

Declaration

public DataProvider DataProvider { get; }

Property Value

Type
DataProvider

IsEOF

Read-only. Property return TRUE when reader cannot extract no more records from stream.

Declaration

public bool IsEOF { get; }

Property Value

Type
System.Boolean

MinimalVersion

Get / Set minimal version accepted by the reader

Declaration

public int MinimalVersion { get; set; }

Property Value

Type
System.Int32

Methods

Dispose()

Free all resources used by this class

Declaration

public void Dispose()

GetRecord()

Gets next record from the stream.

Declaration

public BiffRecordRaw GetRecord()

Returns

Type	Description
Syncfusion.XlsIO.Parser.Biff_Records.BiffRecordRaw	Extracted biff record.

GetRecord(IDecryptor)

Gets next record from the stream.

Declaration

public BiffRecordRaw GetRecord(IDecryptor decryptor)

Parameters

Type	Name	Description
IDecryptor	decryptor	Decryptor used to decrypt encrypted records.

Returns

Type	Description
Syncfusion.XlsIO.Parser.Biff_Records.BiffRecordRaw	Extracted biff record.

PeekRecord()

Gets record from the stream without changing stream position.

Declaration

public BiffRecordRaw PeekRecord()

Returns

Type	Description
Syncfusion.XlsIO.Parser.Biff_Records.BiffRecordRaw	Extracted biff record.

PeekRecordType()

Gets record type from the stream without changing stream position.

Declaration

public TBIFFRecord PeekRecordType()

Returns

Type	Description
TBIFFRecord	Extracted record type.

SeekOnBOFRecord()

Searches for the next BOFRecord in the stream.

Declaration

public BiffRecordRaw SeekOnBOFRecord()

Returns

Type	Description
Syncfusion.XlsIO.Parser.Biff_Records.BiffRecordRaw	Found BOFRecord or null if was not found.

SeekOnRecord(TBIFFRecord)

Seeks for the specified record.

Declaration

public BiffRecordRaw SeekOnRecord(TBIFFRecord recordCode)

Parameters

Type	Name	Description
TBIFFRecord	recordCode	Record to search.

Returns

Type	Description
Syncfusion.XlsIO.Parser.Biff_Records.BiffRecordRaw	Found record, or NULL if record was not found.

TestPeekRecord()

Extract Record from stream. This method used by IsEOF property to optimize its performance.

Declaration

protected BiffRecordRaw TestPeekRecord()

Returns

Type	Description
Syncfusion.XlsIO.Parser.Biff_Records.BiffRecordRaw	Extracted record.

Implements

System.IDisposable