Class BiffContinueRecordRaw
BifRecords container.
Inheritance
Inherited Members
Namespace: Syncfusion.XlsIO.Parser.Biff_Records
Assembly: Syncfusion.XlsIO.UWP.dll
Syntax
public abstract class BiffContinueRecordRaw : BiffRecordRawWithArray, ICloneable, IBiffStorage, IDisposable
Constructors
BiffContinueRecordRaw()
Default constructor fills all data with default values.
Declaration
protected BiffContinueRecordRaw()
BiffContinueRecordRaw(Int32)
Reserved for record's internal data array iReserve bytes.
Declaration
protected BiffContinueRecordRaw(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. |
BiffContinueRecordRaw(Stream, out Int32)
Read / Initialize constructor.
Declaration
protected BiffContinueRecordRaw(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 | If stream is not specified. |
System.ApplicationException | If stream does not support read or seek operations. |
Fields
m_arrContinuePos
Array that contains positions of data of the continue records in the m_data array.
Declaration
protected List<int> m_arrContinuePos
Field Value
Type |
---|
System.Collections.Generic.List<System.Int32> |
m_extractor
Declaration
protected ContinueRecordExtractor m_extractor
Field Value
Type |
---|
ContinueRecordExtractor |
Properties
Builder
Declaration
protected ContinueRecordBuilder Builder { get; }
Property Value
Type |
---|
Syncfusion.XlsIO.Parser.Biff_Records.ContinueRecordBuilder |
Methods
AddContinueRecordType(TBIFFRecord)
Declaration
protected void AddContinueRecordType(TBIFFRecord recordType)
Parameters
Type | Name | Description |
---|---|---|
TBIFFRecord | recordType |
AddRecordData(List<Byte[]>, BiffRecordRaw)
Adds record data from single record to the List.
Declaration
protected virtual int AddRecordData(List<byte[]> arrRecords, BiffRecordRaw record)
Parameters
Type | Name | Description |
---|---|---|
System.Collections.Generic.List<System.Byte[]> | arrRecords | List to add data to. |
Syncfusion.XlsIO.Parser.Biff_Records.BiffRecordRaw | record | Record to add data from. |
Returns
Type | Description |
---|---|
System.Int32 | Size of the added data. |
builder_OnFirstContinue(Object, EventArgs)
OnFirstContinue event handler.
Declaration
protected virtual void builder_OnFirstContinue(object sender, EventArgs e)
Parameters
Type | Name | Description |
---|---|---|
System.Object | sender | Event sender. |
System.EventArgs | e | Event arguments. |
Clone()
Creates copy of the current object.
Declaration
public override object Clone()
Returns
Type | Description |
---|---|
System.Object | A copy of the current object. |
Overrides
CollectRecordsData(out Int32, ref Int32)
Returns List with byte arrays with continue record's data.
Declaration
protected List<byte[]> CollectRecordsData(out int iFullLength, ref int iLastPos)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | iFullLength | Full length of the additional data. |
System.Int32 | iLastPos | Last position in the stream. |
Returns
Type | Description |
---|---|
System.Collections.Generic.List<System.Byte[]> | List with byte arrays with continue record's data. |
CreateBuilder()
Creates continue record builder.
Declaration
protected virtual ContinueRecordBuilder CreateBuilder()
Returns
Type | Description |
---|---|
Syncfusion.XlsIO.Parser.Biff_Records.ContinueRecordBuilder | Created builder. |
ExtractContinueRecords()
Extracts all continue records from the stream if needed and updates internal data array.
Declaration
protected virtual bool ExtractContinueRecords()
Returns
Type | Description |
---|---|
System.Boolean | True if there was extracted any continue record. |
FillRecord(BinaryReader, DataProvider, IDecryptor, Byte[])
Read from stream record data.
Declaration
public override int FillRecord(BinaryReader reader, DataProvider provider, IDecryptor decryptor, byte[] arrBuffer)
Parameters
Type | Name | Description |
---|---|---|
System.IO.BinaryReader | reader | Stream with record data. |
DataProvider | provider | Object that provides access to the data. |
IDecryptor | decryptor | Object that should be used to parse encrypted records. |
System.Byte[] | arrBuffer | Temporary buffer needed for some operations. |
Returns
Type | Description |
---|---|
System.Int32 | Size of the record data. |
Overrides
Exceptions
Type | Condition |
---|---|
System.ArgumentNullException | If reader is NULL. |
System.ApplicationException | If stream is not big enough for data (end of stream reached and all data were not read). |
System.ApplicationException | If record code is zero. |
FillStream(BinaryWriter, IEncryptor, Int32)
Save record data to stream.
Declaration
public override int FillStream(BinaryWriter writer, IEncryptor encryptor, int streamPosition)
Parameters
Type | Name | Description |
---|---|---|
System.IO.BinaryWriter | writer | Writer that will receive record data. |
IEncryptor | encryptor | Object to encrypt data. |
System.Int32 | streamPosition | Position in the output stream, used to reduce Flush calls of the writer.BaseStream. |
Returns
Type | Description |
---|---|
System.Int32 | Size of the record in the stream. |
Overrides
Exceptions
Type | Condition |
---|---|
System.ArgumentNullException | If writer is NULL. |
System.ApplicationException | If m_iLength of internal record data array is less than zero. |
ParseStructure()
This method constitutes the main part of parsing with continue records. For inheritors this method must be called to get Continue records which is placed after this record in the input stream.
Declaration
public override void ParseStructure()