Class BiffRecordRawWithArray
Summary description for BiffRecordRawWithArray.
Inheritance
Namespace: Syncfusion.XlsIO.Parser.Biff_Records
Assembly: Syncfusion.XlsIO.UWP.dll
Syntax
public abstract class BiffRecordRawWithArray : BiffRecordRaw, ICloneable, IBiffStorage, IDisposable
Constructors
BiffRecordRawWithArray()
Default constructor, gets code value using reflection and attributes.
Declaration
protected BiffRecordRawWithArray()
BiffRecordRawWithArray(Int32)
Reserved for record's internal data array iReserve bytes.
Declaration
protected BiffRecordRawWithArray(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. |
BiffRecordRawWithArray(BinaryReader, out Int32)
Read / initialize constructor.
Declaration
protected BiffRecordRawWithArray(BinaryReader reader, out int itemSize)
Parameters
| Type | Name | Description |
|---|---|---|
| System.IO.BinaryReader | reader | BinaryReader from which record data should be read. |
| System.Int32 | itemSize | Size of the read item. |
Exceptions
| Type | Condition |
|---|---|
| System.ArgumentNullException | When specified reader is NULL. |
BiffRecordRawWithArray(Stream, out Int32)
Read / initialize constructor.
Declaration
protected BiffRecordRawWithArray(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_data
Array that contains record data.
Declaration
protected byte[] m_data
Field Value
| Type |
|---|
| System.Byte[] |
Properties
AutoGrowData
If True, the array will automatically grow when the offset limit is reached. This is required when the real record size is not known for an Infill operation. Will throw exception on buffer offset overrun when set to False. Default value is False.
Declaration
public override bool AutoGrowData { get; set; }
Property Value
| Type |
|---|
| System.Boolean |
Overrides
Data
Read-only. Returns record data.
Declaration
public override byte[] Data { get; set; }
Property Value
| Type |
|---|
| System.Byte[] |
Overrides
Methods
AutoExtractFields()
Algorithm extracts field values from internal data storage.
Declaration
protected void AutoExtractFields()
AutoInfillFromFields()
Method tries by metadata information fill internal array of record.
Declaration
protected int AutoInfillFromFields()
Returns
| Type | Description |
|---|---|
| System.Int32 | Size of the filled data. |
CheckOffsetAndLength(Int32, Int32)
Declaration
protected void CheckOffsetAndLength(int offset, int length)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | offset | |
| System.Int32 | length |
ClearData()
Clears internal data array.
Declaration
public override void ClearData()
Overrides
CopyTo(BiffRecordRaw)
Copies data from the current Biff record to the specified Biff record.
Declaration
public override void CopyTo(BiffRecordRaw raw)
Parameters
| Type | Name | Description |
|---|---|---|
| Syncfusion.XlsIO.Parser.Biff_Records.BiffRecordRaw | raw | Biff record that will receive data from the current record. |
Overrides
Exceptions
| Type | Condition |
|---|---|
| System.ArgumentException | When this record and parameter have different types. |
Dispose()
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
Declaration
public virtual void Dispose()
EnlargeDataStorageIfNeeded(Int32, Int32)
Enlarges the internal record data array to facilitate at least offset + length of data to be placed.
Declaration
protected void EnlargeDataStorageIfNeeded(int offset, int length)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | offset | Offset to the accessed data. |
| System.Int32 | length | Length of the needed data. |
FillStream(BinaryWriter, IEncryptor, Int32)
Save record data to stream.
Declaration
public virtual 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. |
Exceptions
| Type | Condition |
|---|---|
| System.ArgumentNullException | If writer is NULL. |
| System.ApplicationException | If m_iLength of internal record data array is less than zero. |
FillStream(BinaryWriter, DataProvider, IEncryptor, Int32)
Save record data to stream.
Declaration
public override int FillStream(BinaryWriter writer, DataProvider provider, IEncryptor encryptor, int streamPosition)
Parameters
| Type | Name | Description |
|---|---|---|
| System.IO.BinaryWriter | writer | Writer that will receive record data. |
| DataProvider | provider | Object that provides access to the data. |
| IEncryptor | encryptor | Object to encrypt data. |
| System.Int32 | streamPosition | Position in the output stream. Used to increase performance. |
Returns
| Type | Description |
|---|---|
| System.Int32 | Size of the record. |
Overrides
Exceptions
| Type | Condition |
|---|---|
| System.ArgumentNullException | If writer is NULL. |
| System.ApplicationException | If m_iLength of internal record data array is less than zero. |
Finalize()
Declaration
protected override void Finalize()
GetAddr(Int32)
Gets TAddr structure from internal record data.
Declaration
protected TAddr GetAddr(int offset)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | offset | Offset in bytes of TAddr structure to get. |
Returns
| Type | Description |
|---|---|
| TAddr | Retrieved TAddr structure. |
GetAddrAsRectangle(Int32)
Gets TAddr structure from internal record data.
Declaration
protected Rectangle GetAddrAsRectangle(int offset)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | offset | Offset in bytes of TAddr structure to get. |
Returns
| Type | Description |
|---|---|
| Rectangle | Retrieved TAddr structure. |
GetBit(Int32, Int32)
Gets single bit from internal record data using GetBytes.
Declaration
protected bool GetBit(int offset, int bitPos)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | offset | Offset of the byte that contains needed bit. |
| System.Int32 | bitPos | Position of bit in the byte. |
Returns
| Type | Description |
|---|---|
| System.Boolean | True if specified bit is set to 1; otherwise False. |
Exceptions
| Type | Condition |
|---|---|
| System.ArgumentOutOfRangeException | bitPos argument should be not less than zero and not more than 7. |
GetByte(Int32)
Gets single byte from internal record data using GetBytes.
Declaration
protected byte GetByte(int offset)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | offset | Offset of byte to get. |
Returns
| Type | Description |
|---|---|
| System.Byte | Single byte from internal record data. |
GetBytes(Int32, Int32)
Get array of bytes from internal record data.
Declaration
protected byte[] GetBytes(int offset, int length)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | offset | Offset of first byte of data to get. |
| System.Int32 | length | Length of required array. |
Returns
| Type | Description |
|---|---|
| System.Byte[] | Array of bytes from internal record data. |
Exceptions
| Type | Condition |
|---|---|
| System.ArgumentOutOfRangeException | If offset is less than zero or more than internal record data array size or length is less than zero or more than internal record data array size or length plus offset is more than internal record data array size. |
GetDouble(Int32)
Gets double from internal record data using GetBytes.
Declaration
protected double GetDouble(int offset)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | offset | Offset in bytes of double to get. |
Returns
| Type | Description |
|---|---|
| System.Double | Double from internal record data. |
GetFloat(Int32)
Gets float from internal record data using GetBytes.
Declaration
protected float GetFloat(int offset)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | offset | Offset in bytes of float to get. |
Returns
| Type | Description |
|---|---|
| System.Single | Float from internal record data. |
GetInt16(Int32)
Gets short from internal record data using GetBytes.
Declaration
protected short GetInt16(int offset)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | offset | Offset in bytes of short to get. |
Returns
| Type | Description |
|---|---|
| System.Int16 | Short from internal record. |
GetInt32(Int32)
Gets int from internal record data using GetBytes.
Declaration
protected int GetInt32(int offset)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | offset | Offset in bytes of int to get. |
Returns
| Type | Description |
|---|---|
| System.Int32 | Int from internal record. |
GetInt64(Int32)
Gets long from internal record data using GetBytes.
Declaration
protected long GetInt64(int offset)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | offset | Offset in bytes of long to get. |
Returns
| Type | Description |
|---|---|
| System.Int64 | Long from internal record data. |
GetSortedFields()
Method extracts from class its fields which have the custom attribute: BiffRecordPosAttribute. Method returns two arrays sorted in special order, the order of extraction and saving from/to stream.
Declaration
public SortedList<BiffRecordPosAttribute, FieldInfo> GetSortedFields()
Returns
| Type | Description |
|---|---|
| System.Collections.Generic.SortedList<BiffRecordPosAttribute, System.Reflection.FieldInfo> | Returns Sorted Fields. |
GetStoreSize(ExcelVersion)
Size of the required storage space. Read-only.
Declaration
public override int GetStoreSize(ExcelVersion version)
Parameters
| Type | Name | Description |
|---|---|---|
| ExcelVersion | version |
Returns
| Type |
|---|
| System.Int32 |
Overrides
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. |
GetString16BitUpdateOffset(ref Int32)
Gets string from internal record data using GetBytes, and it increases the offset by string size in bytes.
Declaration
protected string GetString16BitUpdateOffset(ref int offset)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | offset | Offset of starting byte. |
Returns
| Type | Description |
|---|---|
| System.String | Retrieved string. |
Exceptions
| Type | Condition |
|---|---|
| System.ArgumentOutOfRangeException | if Offset + iStrLen is out of data array |
GetString16BitUpdateOffset(ref Int32, out Boolean)
Gets string from internal record data using GetBytes, and it increases the offset by string size in bytes.
Declaration
protected string GetString16BitUpdateOffset(ref int offset, out bool asciiString)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | offset | Offset of starting byte. |
| System.Boolean | asciiString | Indicates whether extracted string is ascii string (not unicode). |
Returns
| Type | Description |
|---|---|
| System.String | Retrieved string. |
Exceptions
| Type | Condition |
|---|---|
| System.ArgumentOutOfRangeException | if Offset + iStrLen is out of data array |
GetStringByteLen(Int32)
Gets string from internal record data using GetBytes.
Declaration
protected string GetStringByteLen(int offset)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | offset | Offset of starting byte. |
Returns
| Type | Description |
|---|---|
| System.String | Retrieved string. |
Exceptions
| Type | Condition |
|---|---|
| System.ArgumentOutOfRangeException | if Offset + iStrLen is out of data array |
GetStringByteLen(Int32, out Int32)
Gets string from internal record data using GetBytes.
Declaration
protected string GetStringByteLen(int offset, out int iBytes)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | offset | Offset of starting byte. |
| System.Int32 | iBytes | Returns size of the read data. |
Returns
| Type | Description |
|---|---|
| System.String | Retrieved string. |
Exceptions
| Type | Condition |
|---|---|
| System.ArgumentOutOfRangeException | if Offset + iStrLen is out of data array |
GetStringUpdateOffset(ref Int32, Int32)
Gets string from internal record data using GetBytes and it increases offset by string size in bytes.
Declaration
protected string GetStringUpdateOffset(ref 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 |
GetUInt16(Int32)
Gets ushort from internal record data using GetBytes.
Declaration
protected ushort GetUInt16(int offset)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | offset | Offset in bytes of ushort to get. |
Returns
| Type | Description |
|---|---|
| System.UInt16 | Ushort from internal record data. |
GetUInt32(Int32)
Gets uint from internal record data using GetBytes.
Declaration
protected uint GetUInt32(int offset)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | offset | Offset in bytes of uint to get. |
Returns
| Type | Description |
|---|---|
| System.UInt32 | Uint from internal record data. |
GetUInt64(Int32)
Gets ulong from internal record data using GetBytes.
Declaration
protected ulong GetUInt64(int offset)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | offset | Offset in bytes of ulong to get. |
Returns
| Type | Description |
|---|---|
| System.UInt64 | Ulong from internal record data. |
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. |
GetValueByAttributeType(BiffRecordPosAttribute)
Gets value of the field by BiffRecordPosAttribute.
Declaration
protected object GetValueByAttributeType(BiffRecordPosAttribute attr)
Parameters
| Type | Name | Description |
|---|---|---|
| BiffRecordPosAttribute | attr | BiffRecordPosAttribute that describes required field. |
Returns
| Type | Description |
|---|---|
| System.Object | Value of the field. |
IsAsciiString(String)
Detects whether specified string contains only characters supported by ASCII encoding.
Declaration
public static bool IsAsciiString(string strTextPart)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | strTextPart | String to check. |
Returns
| Type | Description |
|---|---|
| System.Boolean | True if this string is fully supported by ASCII encoding. |
IsEqual(BiffRecordRaw)
Compares two Biff records.
Declaration
public override bool IsEqual(BiffRecordRaw raw)
Parameters
| Type | Name | Description |
|---|---|---|
| Syncfusion.XlsIO.Parser.Biff_Records.BiffRecordRaw | raw | Biff record that should be compared with this Biff record. |
Returns
| Type | Description |
|---|---|
| System.Boolean | True if this instance and extFormat contain the same data. |
Overrides
OnDispose()
Declaration
protected virtual void OnDispose()
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
Reserve(Int32)
Reserve memory for internal array.
Declaration
protected void Reserve(int length)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | length | Number of bytes that should be reserved. |
SetAddr(Int32, Rectangle)
Sets TAddr structure in internal record data.
Declaration
protected void SetAddr(int offset, Rectangle addr)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | offset | Offset in bytes of TAddr structure to set. |
| Rectangle | addr | New value of the Rectangle at the specified position. |
SetAddr(Int32, TAddr)
Sets TAddr structure in internal record data.
Declaration
protected void SetAddr(int offset, TAddr addr)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | offset | Offset in bytes of TAddr structure to set. |
| TAddr | addr | New value of the TAddr at the specified position. |
SetBit(Int32, Boolean, Int32)
Sets one bit in specified byte in internal record data array.
Declaration
protected void SetBit(int offset, bool value, int bitPos)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | offset | Offset of the byte in the internal record data array. |
| System.Boolean | value | Value of bit. |
| System.Int32 | bitPos | Bit position in the byte. |
Exceptions
| Type | Condition |
|---|---|
| System.ArgumentOutOfRangeException | If bitPos is less than zero or more than 7. |
SetByte(Int32, Byte)
Sets single byte in internal record data array using SetBytes method.
Declaration
protected void SetByte(int offset, byte value)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | offset | Offset to the required byte. |
| System.Byte | value | New value for the byte. |
SetByte(Int32, Byte, Int32)
Declaration
protected void SetByte(int offset, byte value, int count)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | offset | |
| System.Byte | value | |
| System.Int32 | count |
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. |
SetDouble(Int32, Double)
Sets double in internal record data array using SetBytes method.
Declaration
protected void SetDouble(int offset, double value)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | offset | Offset to the required value. |
| System.Double | value | New value for the specified double. |
SetFloat(Int32, Single)
Sets float in internal record data array using SetBytes method.
Declaration
protected void SetFloat(int offset, float value)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | offset | Offset to the required value. |
| System.Single | value | New value for the specified float. |
SetInt16(Int32, Int16)
Sets short in internal record data array using SetBytes method.
Declaration
protected void SetInt16(int offset, short value)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | offset | Offset to the required value. |
| System.Int16 | value | New value for the specified short. |
SetInt32(Int32, Int32)
Sets int in internal record data array using SetBytes method.
Declaration
protected void SetInt32(int offset, int value)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | offset | Offset to the required value. |
| System.Int32 | value | New value for the specified int. |
SetInt64(Int32, Int64)
Sets long in internal record data array using SetBytes method.
Declaration
protected void SetInt64(int offset, long value)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | offset | Offset to the required value. |
| System.Int64 | value | New value for the specified long. |
SetString16BitLen(Int32, String)
Sets string in internal record data array using SetBytes method. The String length is saved in two bytes.
Declaration
protected int SetString16BitLen(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. |
SetString16BitLen(Int32, String, Boolean, Boolean)
Sets string in internal record data array using SetBytes method. The String length is saved in two bytes.
Declaration
protected int SetString16BitLen(int offset, string value, bool bEmptyCompressed, bool isCompressed)
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. |
| System.Boolean | isCompressed | Indicates whether string should be compressed or not. |
Returns
| Type | Description |
|---|---|
| System.Int32 | Size of the string in bytes. |
SetString16BitUpdateOffset(ref Int32, String)
Sets string in internal record data array using SetBytes method. The String length is saved in two bytes
Declaration
protected void SetString16BitUpdateOffset(ref int offset, string value)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | offset | Offset to the string. |
| System.String | value | Value of the string. |
SetString16BitUpdateOffset(ref Int32, String, Boolean)
Sets string in internal record data array using SetBytes method. The String length is saved in two bytes
Declaration
protected void SetString16BitUpdateOffset(ref int offset, string value, bool isCompressed)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | offset | Offset to the string. |
| System.String | value | Value of the string. |
| System.Boolean | isCompressed | Indicates whether string should be compressed or not. |
SetStringByteLen(Int32, String)
Sets string in internal record data array using SetBytes method. The String length is saved in one byte.
Declaration
protected int SetStringByteLen(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 data. |
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, Boolean)
Sets string in internal record data array using SetBytes method without string length.
Declaration
protected int SetStringNoLen(int offset, string value, bool bEmptyCompressed, bool bCompressed)
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. |
| System.Boolean | bCompressed | Indicates whether to write compressed (ascii) string or not. |
Returns
| Type | Description |
|---|---|
| System.Int32 | Size of the string in bytes. |
SetStringNoLenDetectEncoding(Int32, String)
Sets string in internal record data array using SetBytes method without string length.
Declaration
protected int SetStringNoLenDetectEncoding(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. |
SetStringNoLenUpdateOffset(ref Int32, String, Boolean)
Sets string in internal record data array using SetBytes method without string length, updates offset parameter (adds string length).
Declaration
protected void SetStringNoLenUpdateOffset(ref int offset, string value, bool isCompression)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | offset | Offset to the string. |
| System.String | value | Value of the string. |
| System.Boolean | isCompression | Indicates whether string should be compressed or not. |
SetUInt16(Int32, UInt16)
Sets ushort in internal record data array using SetBytes method.
Declaration
protected void SetUInt16(int offset, ushort value)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | offset | Offset to the required value. |
| System.UInt16 | value | New value for the specified ushort. |
SetUInt32(Int32, UInt32)
Sets uint in internal record data array using SetBytes method.
Declaration
protected void SetUInt32(int offset, uint value)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | offset | Offset to the required value. |
| System.UInt32 | value | New value for the specified uint. |
SetUInt64(Int32, UInt64)
Sets ulong in internal record data array using SetBytes method.
Declaration
protected void SetUInt64(int offset, ulong value)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | offset | Offset to the required value. |
| System.UInt64 | value | New value for the specified ulong. |
SetValueByAttributeType(BiffRecordPosAttribute, Object)
Sets value of the specified field.
Declaration
protected int SetValueByAttributeType(BiffRecordPosAttribute attr, object data)
Parameters
| Type | Name | Description |
|---|---|---|
| BiffRecordPosAttribute | attr | BiffRecordPosAttribute that describes required field. |
| System.Object | data | New field value. |
Returns
| Type | Description |
|---|---|
| System.Int32 | Size of the used data. |