alexa
menu

MAUI

  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Search Results for

    Show / Hide Table of Contents

    Class BiffRecordRawWithDataProvider

    Summary description for BiffRecordRawWithDataProvider.

    Inheritance
    object
    BiffRecordRaw
    BiffRecordWithStreamPos
    BiffRecordRawWithDataProvider
    BiffRecordWithContinue
    Implements
    ICloneable
    IBiffStorage
    IDisposable
    Inherited Members
    BiffRecordWithStreamPos.m_lStreamPosition
    BiffRecordWithStreamPos.StreamPos
    object.Equals(object)
    object.Equals(object, object)
    object.GetHashCode()
    object.GetType()
    object.MemberwiseClone()
    object.ReferenceEquals(object, object)
    object.ToString()
    Namespace: Syncfusion.XlsIO.Parser.Biff_Records
    Assembly: Syncfusion.XlsIO.NET.dll
    Syntax
    [CLSCompliant(false)]
    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
    object
    Overrides
    Syncfusion.XlsIO.Parser.Biff_Records.BiffRecordRaw.Clone()

    Dispose()

    Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

    Declaration
    public void Dispose()

    ~BiffRecordRawWithDataProvider()

    Declaration
    protected ~BiffRecordRawWithDataProvider()

    GetString(int, int)

    Gets string from internal record data using GetBytes.

    Declaration
    protected string GetString(int offset, int iStrLen)
    Parameters
    Type Name Description
    int offset

    Offset of starting byte.

    int iStrLen

    Length of the string.

    Returns
    Type Description
    string

    Retrieved string.

    Exceptions
    Type Condition
    ArgumentOutOfRangeException

    if Offset + iStrLen is out of data array

    GetString(int, int, out int)

    Gets string from internal record data using GetBytes.

    Declaration
    protected string GetString(int offset, int iStrLen, out int iBytesInString)
    Parameters
    Type Name Description
    int offset

    Offset of starting byte.

    int iStrLen

    Length of the string.

    int iBytesInString

    Gets bytes count that this string occupies in the data array.

    Returns
    Type Description
    string

    Retrieved string.

    GetString(int, int, out int, bool)

    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
    int offset

    Offset of starting byte.

    int iStrLen

    Length of the string.

    int iBytesInString

    Gets bytes count that this string occupies in the data array.

    bool isByteCounted

    Flag for is bytes count available.

    Returns
    Type Description
    string

    Retrieved string.

    GetUnkTypeString(int, IList<int>, int, ref int, out int, 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
    int offset

    Record data offset.

    IList<int> continuePos

    Contain next position.

    int continueCount

    Number of elements in the continuePos collection.

    int iBreakIndex

    Current index in the continuePos array.

    int length

    Length of string record.

    byte[] rich

    Array of rich formatting values.

    byte[] extended

    Array of unknown FarEast data.

    Returns
    Type Description
    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, int, int, 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.

    int iOffset

    Offset to the record's data.

    int iLength

    Length of the record's data.

    ExcelVersion version

    Excel version used for infill.

    Overrides
    BiffRecordRaw.ParseStructure(DataProvider, int, int, ExcelVersion)

    SetByte(int, byte)

    Sets byte in internal record data array values.

    Declaration
    protected void SetByte(int offset, byte value)
    Parameters
    Type Name Description
    int offset

    Offset in internal record data array to start from.

    byte value

    Byte value to set.

    SetBytes(int, byte[])

    Sets bytes in internal record data array values.

    Declaration
    protected void SetBytes(int offset, byte[] value)
    Parameters
    Type Name Description
    int offset

    Offset in internal record data array to start from.

    byte[] value

    Array of bytes to set.

    Exceptions
    Type Condition
    ArgumentOutOfRangeException

    If value array is NULL.

    ArgumentOutOfRangeException

    If pos or length would be less than zero or their sum would be more than size of value array.

    ArgumentOutOfRangeException

    If internal record data array is too small for receiving value array and AutoGrowData is False.

    SetBytes(int, byte[], int, int)

    Sets bytes in internal record data array values.

    Declaration
    protected void SetBytes(int offset, byte[] value, int pos, int length)
    Parameters
    Type Name Description
    int offset

    Offset in internal record data array to start from.

    byte[] value

    Array of bytes to set.

    int pos

    Position in value array to the data that will be set.

    int length

    Length of the data.

    Exceptions
    Type Condition
    ArgumentOutOfRangeException

    If value array is NULL.

    ArgumentOutOfRangeException

    If pos or length would be less than zero or their sum would be more than size of value array.

    ArgumentOutOfRangeException

    If internal record data array is too small for receiving value array and AutoGrowData is False.

    SetStringNoLen(int, 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
    int offset

    Offset to the string.

    string value

    Value of the string.

    Returns
    Type Description
    int

    Size of the string in bytes.

    SetStringNoLen(int, string, bool)

    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
    int offset

    Offset to the string.

    string value

    Value of the string.

    bool bEmptyCompressed

    Indicates whether write compressed attribute for empty strings.

    Returns
    Type Description
    int

    Size of the string in bytes.

    SetUInt16(int, ushort)

    Sets ushort in internal record data array values.

    Declaration
    protected void SetUInt16(int offset, ushort value)
    Parameters
    Type Name Description
    int offset

    Offset in internal record data array to start from.

    ushort value

    Value to set.

    Implements

    ICloneable
    IBiffStorage
    IDisposable
    In this article
    Back to top Generated by DocFX
    Copyright © 2001 - 2026 Syncfusion Inc. All Rights Reserved