Class BiffRecordRawWithDataProvider
Summary description for BiffRecordRawWithDataProvider.
Inheritance
Namespace: Syncfusion.XlsIO.Parser.Biff_Records
Assembly: Syncfusion.XlsIO.UWP.dll
Syntax
public abstract class BiffRecordRawWithDataProvider : BiffRecordWithStreamPos, ICloneable, IBiffStorage, IDisposable
Constructors
BiffRecordRawWithDataProvider()
Default constructor.
Declaration
public BiffRecordRawWithDataProvider()
Fields
m_provider
Object that gives access to the record's data.
Declaration
protected DataProvider m_provider
Field Value
Type |
---|
DataProvider |
Methods
Clone()
Declaration
public override object Clone()
Returns
Type |
---|
System.Object |
Overrides
Dispose()
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
Declaration
public void Dispose()
Finalize()
Declaration
protected override void Finalize()
GetString(Int32, Int32)
Gets string from internal record data using GetBytes.
Declaration
protected string GetString(int offset, int iStrLen)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | offset | Offset of starting byte. |
System.Int32 | iStrLen | Length of the string. |
Returns
Type | Description |
---|---|
System.String | Retrieved string. |
Exceptions
Type | Condition |
---|---|
System.ArgumentOutOfRangeException | if Offset + iStrLen is out of data array |
GetString(Int32, Int32, out Int32)
Gets string from internal record data using GetBytes.
Declaration
protected string GetString(int offset, int iStrLen, out int iBytesInString)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | offset | Offset of starting byte. |
System.Int32 | iStrLen | Length of the string. |
System.Int32 | iBytesInString | Gets bytes count that this string occupies in the data array. |
Returns
Type | Description |
---|---|
System.String | Retrieved string. |
GetString(Int32, Int32, out Int32, Boolean)
Gets string from internal record data using GetBytes.
Declaration
protected string GetString(int offset, int iStrLen, out int iBytesInString, bool isByteCounted)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | offset | Offset of starting byte. |
System.Int32 | iStrLen | Length of the string. |
System.Int32 | iBytesInString | Gets bytes count that this string occupies in the data array. |
System.Boolean | isByteCounted | Flag for is bytes count available. |
Returns
Type | Description |
---|---|
System.String | Retrieved string. |
GetUnkTypeString(Int32, IList<Int32>, Int32, ref Int32, out Int32, out Byte[], out Byte[])
Detect type of string and extracts it.
Declaration
protected string GetUnkTypeString(int offset, IList<int> continuePos, int continueCount, ref int iBreakIndex, out int length, out byte[] rich, out byte[] extended)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | offset | Record data offset. |
System.Collections.Generic.IList<System.Int32> | continuePos | Contain next position. |
System.Int32 | continueCount | Number of elements in the continuePos collection. |
System.Int32 | iBreakIndex | Current index in the continuePos array. |
System.Int32 | length | Length of string record. |
System.Byte[] | rich | Array of rich formatting values. |
System.Byte[] | extended | Array of unknown FarEast data. |
Returns
Type | Description |
---|---|
System.String | Extracted string. |
ParseStructure()
Parse structure of record. Convert Data buffer to special values according to record specification.
Declaration
public abstract void ParseStructure()
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
SetByte(Int32, Byte)
Sets byte in internal record data array values.
Declaration
protected void SetByte(int offset, byte value)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | offset | Offset in internal record data array to start from. |
System.Byte | value | Byte value to set. |
SetBytes(Int32, Byte[])
Sets bytes in internal record data array values.
Declaration
protected void SetBytes(int offset, byte[] value)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | offset | Offset in internal record data array to start from. |
System.Byte[] | value | Array of bytes to set. |
Exceptions
Type | Condition |
---|---|
System.ArgumentOutOfRangeException | If value array is NULL. |
System.ArgumentOutOfRangeException | If pos or length would be less than zero or their sum would be more than size of value array. |
System.ArgumentOutOfRangeException | If internal record data array is too small for receiving value array and AutoGrowData is False. |
SetBytes(Int32, Byte[], Int32, Int32)
Sets bytes in internal record data array values.
Declaration
protected void SetBytes(int offset, byte[] value, int pos, int length)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | offset | Offset in internal record data array to start from. |
System.Byte[] | value | Array of bytes to set. |
System.Int32 | pos | Position in value array to the data that will be set. |
System.Int32 | length | Length of the data. |
Exceptions
Type | Condition |
---|---|
System.ArgumentOutOfRangeException | If value array is NULL. |
System.ArgumentOutOfRangeException | If pos or length would be less than zero or their sum would be more than size of value array. |
System.ArgumentOutOfRangeException | If internal record data array is too small for receiving value array and AutoGrowData is False. |
SetStringNoLen(Int32, String)
Sets string in internal record data array using SetBytes method without string length.
Declaration
protected int SetStringNoLen(int offset, string value)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | offset | Offset to the string. |
System.String | value | Value of the string. |
Returns
Type | Description |
---|---|
System.Int32 | Size of the string in bytes. |
SetStringNoLen(Int32, String, Boolean)
Sets string in internal record data array using SetBytes method without string length.
Declaration
protected int SetStringNoLen(int offset, string value, bool bEmptyCompressed)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | offset | Offset to the string. |
System.String | value | Value of the string. |
System.Boolean | bEmptyCompressed | Indicates whether write compressed attribute for empty strings. |
Returns
Type | Description |
---|---|
System.Int32 | Size of the string in bytes. |
SetUInt16(Int32, UInt16)
Sets ushort in internal record data array values.
Declaration
protected void SetUInt16(int offset, ushort value)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | offset | Offset in internal record data array to start from. |
System.UInt16 | value | Value to set. |