alexa
menu

MAUI

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

    Show / Hide Table of Contents

    Class CellRecordCollection

    Represents the collection of CellRecord.

    Inheritance
    object
    CommonObject
    CellRecordCollection
    Implements
    IParentApplication
    IDisposable
    IDictionary
    ICollection
    IEnumerable
    Inherited Members
    CommonObject.AddReference()
    CommonObject.AppImplementation
    CommonObject.Application
    CommonObject.CheckDisposed()
    CommonObject.Dispose()
    CommonObject.FindParent(object, Type)
    CommonObject.FindParent(object, Type, bool)
    CommonObject.FindParent(Type)
    CommonObject.FindParent(Type, bool)
    CommonObject.FindParent(Type[])
    CommonObject.FindParents(Type[])
    CommonObject.m_bIsDisposed
    CommonObject.Parent
    CommonObject.ReferenceCount
    CommonObject.ReleaseReference()
    CommonObject.SetParent(object)
    object.Equals(object)
    object.Equals(object, object)
    object.GetHashCode()
    object.GetType()
    object.MemberwiseClone()
    object.ReferenceEquals(object, object)
    object.ToString()
    Namespace: Syncfusion.XlsIO.Implementation.Collections
    Assembly: Syncfusion.XlsIO.NET.dll
    Syntax
    public class CellRecordCollection : CommonObject, IParentApplication, IDisposable, IDictionary, ICollection, IEnumerable

    Constructors

    CellRecordCollection(IApplication, object)

    Initializes new instance of the collection.

    Declaration
    public CellRecordCollection(IApplication application, object parent)
    Parameters
    Type Name Description
    IApplication application

    Application object for the collection.

    object parent

    Parent object for the collection.

    Properties

    Count

    Gets number of elements in the collection. Read-only.

    Declaration
    public int Count { get; }
    Property Value
    Type
    int

    FirstColumn

    Gets first used column. Read-only.

    Declaration
    public int FirstColumn { get; }
    Property Value
    Type
    int

    FirstRow

    Gets first used row. Read-only.

    Declaration
    public int FirstRow { get; }
    Property Value
    Type
    int

    IsFixedSize

    Gets a value indicating whether the IDictionary has a fixed size. Read-only.

    Declaration
    public bool IsFixedSize { get; }
    Property Value
    Type
    bool

    IsReadOnly

    Gets a value indicating whether the IDictionary is read-only. Read-only.

    Declaration
    public bool IsReadOnly { get; }
    Property Value
    Type
    bool

    IsSynchronized

    Gets a value indicating whether access to the ICollection is synchronized. Read-only.

    Declaration
    public bool IsSynchronized { get; }
    Property Value
    Type
    bool

    this[int, int]

    Gets or sets the element with the specified one-based row and column indexes.

    Declaration
    [CLSCompliant(false)]
    public ICellPositionFormat this[int iRow, int iColumn] { get; set; }
    Parameters
    Type Name Description
    int iRow
    int iColumn
    Property Value
    Type
    ICellPositionFormat

    this[long]

    Gets or sets the element with the specified key of long type.

    Declaration
    [CLSCompliant(false)]
    public ICellPositionFormat this[long key] { get; set; }
    Parameters
    Type Name Description
    long key
    Property Value
    Type
    ICellPositionFormat

    this[object]

    Gets or sets the element with the specified key of object type.

    Declaration
    public object this[object key] { get; set; }
    Parameters
    Type Name Description
    object key
    Property Value
    Type
    object

    Keys

    Gets an ICollection containing the keys of the IDictionary. Read-only.

    Declaration
    public ICollection Keys { get; }
    Property Value
    Type
    ICollection

    LastColumn

    Gets last used column. Read-only.

    Declaration
    public int LastColumn { get; }
    Property Value
    Type
    int

    LastRow

    Gets last used row. Read-only.

    Declaration
    public int LastRow { get; }
    Property Value
    Type
    int

    RecordExtractor

    Gets the record extractor of the cell record collection.

    Declaration
    public RecordExtractor RecordExtractor { get; }
    Property Value
    Type
    RecordExtractor

    SyncRoot

    Gets an object that can be used to synchronize access to the ICollection. Read-only.

    Declaration
    public object SyncRoot { get; }
    Property Value
    Type
    object

    Table

    Gets or sets table with cell records. Read-only.

    Declaration
    public RecordTable Table { get; set; }
    Property Value
    Type
    RecordTable

    UseCache

    Indicates whether we should use ranges cache or not. Default value if false.

    Declaration
    public bool UseCache { get; set; }
    Property Value
    Type
    bool

    Values

    Gets an ICollection containing the values in the IDictionary. Read-only.

    Declaration
    public ICollection Values { get; }
    Property Value
    Type
    ICollection

    Version

    Gets or sets ExcelVersion of the collection.

    Declaration
    public ExcelVersion Version { get; set; }
    Property Value
    Type
    ExcelVersion

    Methods

    Add(ICellPositionFormat)

    Adds an specified cell to the IDictionary.

    Declaration
    [CLSCompliant(false)]
    public void Add(ICellPositionFormat value)
    Parameters
    Type Name Description
    ICellPositionFormat value

    The Object to use as the value of the element to add.

    Add(long, ICellPositionFormat)

    Adds an element with the provided key and value to the IDictionary.

    Declaration
    [CLSCompliant(false)]
    public void Add(long key, ICellPositionFormat value)
    Parameters
    Type Name Description
    long key

    The Object to use as the key of the element to add.

    ICellPositionFormat value

    The Object to use as the value of the element to add.

    Add(object, object)

    Adds an element with the provided key and value to the IDictionary.

    Declaration
    public void Add(object key, object value)
    Parameters
    Type Name Description
    object key

    The Object to use as the key of the element to add.

    object value

    The Object to use as the value of the element to add.

    AddRecord(BiffRecordRaw, bool)

    Adds record to the collection from BiffRecord with ignore style options.

    Declaration
    [CLSCompliant(false)]
    public void AddRecord(BiffRecordRaw recordToAdd, bool bIgnoreStyles)
    Parameters
    Type Name Description
    BiffRecordRaw recordToAdd

    Record to add.

    bool bIgnoreStyles

    Indicates whether to ignore styles.

    AddRecord(ICellPositionFormat, bool)

    Adds record to the collection from cell postion format with ignore style options.

    Declaration
    [CLSCompliant(false)]
    public void AddRecord(ICellPositionFormat cell, bool bIgnoreStyles)
    Parameters
    Type Name Description
    ICellPositionFormat cell

    Record to add.

    bool bIgnoreStyles

    Indicates whether to ignore styles.

    CacheAndRemove(RangeImpl, int, int, ref int, ref int, bool)

    Caches and removes specified rectangle from the table.

    Declaration
    public RecordTable CacheAndRemove(RangeImpl sourceRange, int iDeltaRow, int iDeltaColumn, ref int iMaxRow, ref int iMaxColumn, bool bInsert)
    Parameters
    Type Name Description
    RangeImpl sourceRange

    Source range.

    int iDeltaRow

    Row delta to add to the resulting table.

    int iDeltaColumn

    Column delta to add to the resulting table.

    int iMaxRow

    Output maximum zero-based row index.

    int iMaxColumn

    Output maximum zero-based column index.

    bool bInsert

    Boolean flag to indicate if a row is moved or inserted.

    Returns
    Type Description
    RecordTable

    Cached table.

    CacheIntersection(IRange, IRange, out Rectangle)

    Caches intersection of the two ranges.

    Declaration
    public RecordTable CacheIntersection(IRange destination, IRange source, out Rectangle rectIntersection)
    Parameters
    Type Name Description
    IRange destination

    The first range to intersect.

    IRange source

    The second range to intersect.

    Rectangle rectIntersection

    Output intersection rectangle.

    Returns
    Type Description
    RecordTable

    RecordTable with intersection.

    Clear()

    Removes all elements from the IDictionary.

    Declaration
    public void Clear()

    ClearData()

    Removes all data saving cells formatting.

    Declaration
    public void ClearData()

    ClearRange(Rectangle)

    Clears range in the dictionary that corresponds to the specified range.

    Declaration
    public void ClearRange(Rectangle rect)
    Parameters
    Type Name Description
    Rectangle rect

    Rectangle to clear.

    Clone(object)

    Creates a new object that is a copy of the current instance.

    Declaration
    public CellRecordCollection Clone(object parent)
    Parameters
    Type Name Description
    object parent

    Parent object for a copy of this instance.

    Returns
    Type Description
    CellRecordCollection

    A new object that is a copy of this instance.

    ContainBoolOrError(long)

    Indicates if collection by index contain bool or error.

    Declaration
    public bool ContainBoolOrError(long cellIndex)
    Parameters
    Type Name Description
    long cellIndex

    Index of record.

    Returns
    Type Description
    bool

    Returns true if contain bool or error; otherwise - false.

    ContainFormulaBoolOrError(long)

    Indicates if collection by index contain bool or error as formula value.

    Declaration
    public bool ContainFormulaBoolOrError(long cellIndex)
    Parameters
    Type Name Description
    long cellIndex

    Index of record.

    Returns
    Type Description
    bool

    Returns true if contain number; otherwise - false.

    ContainFormulaNumber(long)

    Indicates if collection by index contain number as formula value.

    Declaration
    public bool ContainFormulaNumber(long cellIndex)
    Parameters
    Type Name Description
    long cellIndex

    Index of record.

    Returns
    Type Description
    bool

    Returns true if contain number; otherwise - false.

    ContainNumber(long)

    Indicates if collection by index contain number.

    Declaration
    public bool ContainNumber(long cellIndex)
    Parameters
    Type Name Description
    long cellIndex

    Index of record.

    Returns
    Type Description
    bool

    Returns true if contain number; otherwise - false.

    Contains(int, int)

    Determines whether the RecordTable contains an element with row and column.

    Declaration
    public bool Contains(int iRow, int iColumn)
    Parameters
    Type Name Description
    int iRow

    One-based row index of the cell to locate.

    int iColumn

    One-based column index of the cell to locate.

    Returns
    Type Description
    bool

    True if the IDictionary contains an element with the key; otherwise, False.

    Contains(long)

    Determines whether the RecordTable contains an element with the specified key of long type.

    Declaration
    public bool Contains(long key)
    Parameters
    Type Name Description
    long key

    The key to locate in the IDictionary.

    Returns
    Type Description
    bool

    True if the IDictionary contains an element with the key; otherwise, False.

    Contains(object)

    Determines whether the RecordTable contains an element with the specified key of object type.

    Declaration
    public bool Contains(object key)
    Parameters
    Type Name Description
    object key

    The key to locate in the IDictionary.

    Returns
    Type Description
    bool

    True if the IDictionary contains an element with the key; otherwise, False.

    ContainsRow(int)

    Determines whether collection contains row.

    Declaration
    public bool ContainsRow(int iRowIndex)
    Parameters
    Type Name Description
    int iRowIndex

    Zero-based row index.

    Returns
    Type Description
    bool

    True if the collection contains at least one element with specified row index; otherwise, False.

    CopyCell(ICellPositionFormat, string, IDictionary, long, WorkbookImpl, Dictionary<int, int>, ExcelCopyRangeOptions, int)

    Copies cell into another worksheet.

    Declaration
    [CLSCompliant(false)]
    public bool CopyCell(ICellPositionFormat cell, string strFormulaValue, IDictionary dicXFIndexes, long lNewIndex, WorkbookImpl book, Dictionary<int, int> dicFontIndexes, ExcelCopyRangeOptions options, int destXFIndex)
    Parameters
    Type Name Description
    ICellPositionFormat cell

    Cell to copy.

    string strFormulaValue

    Formula string value of the cell.

    IDictionary dicXFIndexes

    Dictionary with updated extended format indexes, or Null if indexes were not updated.

    long lNewIndex

    New cell index

    WorkbookImpl book

    Source workbook.

    Dictionary<int, int> dicFontIndexes

    Dictionary with updated font indexes or Null if indexes were not updated.

    ExcelCopyRangeOptions options

    Copy options.

    int destXFIndex
    Returns
    Type Description
    bool

    True if the cell is copied else false.

    CopyCells(CellRecordCollection, Dictionary<string, string>, Dictionary<string, string>, Dictionary<int, int>, Dictionary<int, int>, Dictionary<int, int>, Dictionary<int, int>)

    Copies cells from another worksheet.

    Declaration
    public void CopyCells(CellRecordCollection sourceCells, Dictionary<string, string> hashStyleNames, Dictionary<string, string> hashWorksheetNames, Dictionary<int, int> hashExtFormatIndexes, Dictionary<int, int> dicNewNameIndexes, Dictionary<int, int> dicFontIndexes, Dictionary<int, int> dictExternSheet)
    Parameters
    Type Name Description
    CellRecordCollection sourceCells

    Source cells collection to copy cells from.

    Dictionary<string, string> hashStyleNames

    Dictionary with changes in style indexes, key - old style index, value - new style index.

    Dictionary<string, string> hashWorksheetNames

    Dictionary with changes in worksheet names.

    Dictionary<int, int> hashExtFormatIndexes

    Dictionary with new extended format indexes.

    Dictionary<int, int> dicNewNameIndexes

    Dictionary with new name indexes.

    Dictionary<int, int> dicFontIndexes

    Dictionary with new font indexes.

    Dictionary<int, int> dictExternSheet

    External sheet dictionary.

    CopyStyle(int, int, int, int)

    Copies style from one cell into another.

    Declaration
    public void CopyStyle(int iSourceRow, int iSourceColumn, int iDestRow, int iDestColumn)
    Parameters
    Type Name Description
    int iSourceRow

    One-based row index of the source cell.

    int iSourceColumn

    One-based column index of the source cell.

    int iDestRow

    One-based row index of the destination cell.

    int iDestColumn

    One-based column index of the destination cell.

    CopyTo(Array, int)

    Copies the elements of the ICollection to an Array, starting at a particular Array index.

    Declaration
    public void CopyTo(Array array, int index)
    Parameters
    Type Name Description
    Array array

    The one-dimensional Array that is the destination of the elements copied from ICollection. The Array must have zero-based indexing.

    int index

    The zero-based index in array at which copying begins.

    CreateCell(int, int, TBIFFRecord)

    Creates new cell.

    Declaration
    [CLSCompliant(false)]
    public ICellPositionFormat CreateCell(int iRow, int iColumn, TBIFFRecord recordType)
    Parameters
    Type Name Description
    int iRow

    One-based row index of the cell to create.

    int iColumn

    One-based column index of the cell to create.

    TBIFFRecord recordType

    Record type.

    Returns
    Type Description
    ICellPositionFormat

    Created cell.

    CreateCellNoAdd(int, int, TBIFFRecord)

    Creates new cell without adding it to the collection..

    Declaration
    [CLSCompliant(false)]
    public ICellPositionFormat CreateCellNoAdd(int iRow, int iColumn, TBIFFRecord recordType)
    Parameters
    Type Name Description
    int iRow

    One-based row index of the cell to create.

    int iColumn

    One-based column index of the cell to create.

    TBIFFRecord recordType

    Record type.

    Returns
    Type Description
    ICellPositionFormat

    Created cell.

    ExtractRanges(BiffReader, bool, Dictionary<int, int>, IDecryptor)

    Extracts ranges from the reader.

    Declaration
    [CLSCompliant(false)]
    public void ExtractRanges(BiffReader reader, bool bIgnoreStyles, Dictionary<int, int> hashNewXFIndexes, IDecryptor decryptor)
    Parameters
    Type Name Description
    BiffReader reader

    Reader to extract ranges from.

    bool bIgnoreStyles

    Indicates whether to ignore styles.

    Dictionary<int, int> hashNewXFIndexes

    Dictionary with new XF indexes when bIgnoreStyles is set to true.

    IDecryptor decryptor

    Decryptor used to decrypt data if necessary.

    ExtractRangesFast(IndexRecord, BiffReader, bool, Dictionary<int, int>)

    Extracts ranges from the reader.

    Declaration
    [CLSCompliant(false)]
    public bool ExtractRangesFast(IndexRecord index, BiffReader reader, bool bIgnoreStyles, Dictionary<int, int> hashNewXFIndexes)
    Parameters
    Type Name Description
    IndexRecord index

    IndexRecord that contains all required information.

    BiffReader reader

    Reader to extract ranges from.

    bool bIgnoreStyles

    Indicates whether to ignore styles.

    Dictionary<int, int> hashNewXFIndexes

    Dictionary with new XF indexes when bIgnoreStyles is set to true.

    Returns
    Type Description
    bool

    True if parsing succeeded.

    FillLabelSSTRTFString(LabelSSTRecord, bool, RichTextString)

    Fills rich text string object with string data.

    Declaration
    [CLSCompliant(false)]
    public void FillLabelSSTRTFString(LabelSSTRecord labelSST, bool bAutofitRows, RichTextString richText)
    Parameters
    Type Name Description
    LabelSSTRecord labelSST

    Record to get data from.

    bool bAutofitRows

    Indicates whether we are interested in correct height or width.

    RichTextString richText

    String to fill.

    FillRTFString(long, bool, RichTextString)

    Returns string value associated with specified cell index.

    Declaration
    public void FillRTFString(long cellIndex, bool bAutofitRows, RichTextString richText)
    Parameters
    Type Name Description
    long cellIndex

    Index to cell.

    bool bAutofitRows

    Indicates whether we are interested in correct height or width.

    RichTextString richText

    String object to fill.

    Find(IRange, byte, bool, bool)

    Finds the cell positions based on find value of byte type.

    Declaration
    public List<long> Find(IRange range, byte findValue, bool bIsError, bool bIsFindFirst)
    Parameters
    Type Name Description
    IRange range

    Storage range.

    byte findValue

    Value to find.

    bool bIsError

    Indicates whether we should look for error code or boolean value.

    bool bIsFindFirst

    If findfirst - true then returns range; otherwise - array with all found values.

    Returns
    Type Description
    List<long>

    List with cell indexes that contains specified value.

    Find(IRange, double, ExcelFindType, bool)

    Finds the cell positions based on find value of double type.

    Declaration
    public List<long> Find(IRange range, double findValue, ExcelFindType flags, bool bIsFindFirst)
    Parameters
    Type Name Description
    IRange range

    Storage range.

    double findValue

    Value to find.

    ExcelFindType flags

    If true - finds first value; otherwise - all values.

    bool bIsFindFirst

    If findfirst - true then returns range; otherwise - array with all found values.

    Returns
    Type Description
    List<long>

    List with cell indexes that contains specified value.

    Find(IRange, string, ExcelFindType, ExcelFindOptions, bool)

    Finds the cell positions based on find value of string type with find option.

    Declaration
    public List<long> Find(IRange range, string findValue, ExcelFindType flags, ExcelFindOptions findOptions, bool bIsFindFirst)
    Parameters
    Type Name Description
    IRange range

    Storage range.

    string findValue

    Value to find.

    ExcelFindType flags

    If true - finds first value; otherwise - all values.

    ExcelFindOptions findOptions

    Way to find

    bool bIsFindFirst

    If findfirst - true then returns range; otherwise - array with all found values.

    Returns
    Type Description
    List<long>

    List with cell indexes that contains specified value.

    Find(IRange, string, ExcelFindType, bool)

    Finds the cell positions based on find value of byte type.

    Declaration
    public List<long> Find(IRange range, string findValue, ExcelFindType flags, bool bIsFindFirst)
    Parameters
    Type Name Description
    IRange range

    Storage range.

    string findValue

    Value to find.

    ExcelFindType flags

    If true - finds first value; otherwise - all values.

    bool bIsFindFirst

    If findfirst - true then returns range; otherwise - array with all found values.

    Returns
    Type Description
    List<long>

    List with cell indexes that contains specified value.

    Find(Dictionary<int, object>)

    Finds the cell positions which has a given dictionary index.

    Declaration
    public List<long> Find(Dictionary<int, object> dictIndexes)
    Parameters
    Type Name Description
    Dictionary<int, object> dictIndexes

    Dictionary index to be found.

    Returns
    Type Description
    List<long>

    List with cell indexes that contains specified value.

    FindRecord(TBIFFRecord, int, int, int)

    Searches for the record of specified type.

    Declaration
    public int FindRecord(TBIFFRecord recordType, int iRow, int iCol, int iLastCol)
    Parameters
    Type Name Description
    TBIFFRecord recordType

    Record type to look for.

    int iRow

    One-based index to the row to look at.

    int iCol

    One-based index of the column to start looking at.

    int iLastCol

    One-based index of the column to end looking at.

    Returns
    Type Description
    int

    Column index that contains record of the specified type or value beyond iLastCol if not found.

    FreeRange(int, int)

    Free's range object.

    Declaration
    public void FreeRange(int iRow, int iColumn)
    Parameters
    Type Name Description
    int iRow

    One-based row index of the range object to remove from internal cache.

    int iColumn

    One-based column index of the range object to remove from internal cache.

    GetArrayRecord(int, int)

    Returns array record corresponding to the cell

    Declaration
    [CLSCompliant(false)]
    public ArrayRecord GetArrayRecord(int iRow, int iColumn)
    Parameters
    Type Name Description
    int iRow

    One-based row index of the cell to get ArrayRecord for.

    int iColumn

    One-based column index of the cell to get ArrayRecord for.

    Returns
    Type Description
    ArrayRecord

    Corresponding array record.

    GetBool(long, out bool)

    Gets bool value by cellindex.

    Declaration
    public bool GetBool(long cellIndex, out bool value)
    Parameters
    Type Name Description
    long cellIndex

    Cell index.

    bool value

    Returns value by cell index.

    Returns
    Type Description
    bool

    If true than value is correct; otherwise incorrect.

    GetCellFont(long)

    Gets font by cell index.

    Declaration
    public IFont GetCellFont(long cellIndex)
    Parameters
    Type Name Description
    long cellIndex

    Cell index.

    Returns
    Type Description
    IFont

    Returns font or null.

    GetCellFormatting(long)

    Returns object containing cell formatting.

    Declaration
    public IExtendedFormat GetCellFormatting(long cellIndex)
    Parameters
    Type Name Description
    long cellIndex

    Cell index to get formatting for.

    Returns
    Type Description
    IExtendedFormat

    An ojbect containing cell formatting.

    GetCellRecord(int, int)

    Returns cell record based on row and column index.

    Declaration
    [CLSCompliant(false)]
    public ICellPositionFormat GetCellRecord(int iRow, int iColumn)
    Parameters
    Type Name Description
    int iRow

    One-based row index.

    int iColumn

    One-based column index.

    Returns
    Type Description
    ICellPositionFormat

    Corresponding cell record.

    GetCellRecord(long)

    Returns cell record based on the key.

    Declaration
    [CLSCompliant(false)]
    public ICellPositionFormat GetCellRecord(long key)
    Parameters
    Type Name Description
    long key

    Cell key.

    Returns
    Type Description
    ICellPositionFormat

    Corresponding cell record.

    GetCellStyle(long)

    Gets cell style by cell index.

    Declaration
    public IStyle GetCellStyle(long cellIndex)
    Parameters
    Type Name Description
    long cellIndex

    Cell index.

    Returns
    Type Description
    IStyle

    Returns cell index.

    GetDateTime(long)

    Gets date time by cell index.

    Declaration
    public DateTime GetDateTime(long cellIndex)
    Parameters
    Type Name Description
    long cellIndex

    Cell index.

    Returns
    Type Description
    DateTime

    Returns date time or null.

    GetEnumerator()

    Returns an IDictionaryEnumerator for the IDictionary.

    Declaration
    public IDictionaryEnumerator GetEnumerator()
    Returns
    Type Description
    IDictionaryEnumerator

    An IDictionaryEnumerator for the IDictionary.

    GetError(long)

    Gets error value by cell index.

    Declaration
    public string GetError(long cellIndex)
    Parameters
    Type Name Description
    long cellIndex

    Cell index.

    Returns
    Type Description
    string

    Returns string that represents error value.

    GetExtendedFormatIndex(int, int)

    Gets extended format index by row and column index.

    Declaration
    public int GetExtendedFormatIndex(int row, int column)
    Parameters
    Type Name Description
    int row

    One-based row index.

    int column

    One-based column index

    Returns
    Type Description
    int

    Returns extended format index or int.MinValue if not found.

    GetExtendedFormatIndex(long)

    Gets extended format index by cell index.

    Declaration
    public int GetExtendedFormatIndex(long cellIndex)
    Parameters
    Type Name Description
    long cellIndex

    Cell index.

    Returns
    Type Description
    int

    Returns extended format index or int.MINVALUE.

    GetExtendedFormatIndexByColumn(int)

    Gets extended format index of the column.

    Declaration
    public int GetExtendedFormatIndexByColumn(int column)
    Parameters
    Type Name Description
    int column

    One-based column index.

    Returns
    Type Description
    int

    Returns extended format index or int.MinValue if not found.

    GetExtendedFormatIndexByRow(int)

    Gets extended format index of the row.

    Declaration
    public int GetExtendedFormatIndexByRow(int row)
    Parameters
    Type Name Description
    int row

    One-based row index.

    Returns
    Type Description
    int

    Returns extended format index or int.MinValue if not found.

    GetFormula(long)

    Gets formula value by cell index.

    Declaration
    public string GetFormula(long cellIndex)
    Parameters
    Type Name Description
    long cellIndex

    Cell index.

    Returns
    Type Description
    string

    Returns formula value or null.

    GetFormula(long, bool)

    Gets formula value by cell index with R1C1 notation.

    Declaration
    public string GetFormula(long cellIndex, bool isR1C1)
    Parameters
    Type Name Description
    long cellIndex

    Cell index.

    bool isR1C1

    If true - returns in R1C1 notations.

    Returns
    Type Description
    string

    Returns formula value or null.

    GetFormula(long, bool, NumberFormatInfo)

    Gets formula value by cell index with number format information.

    Declaration
    public string GetFormula(long cellIndex, bool isR1C1, NumberFormatInfo numberInfo)
    Parameters
    Type Name Description
    long cellIndex

    Cell index.

    bool isR1C1

    If true - returns in R1C1 notations.

    NumberFormatInfo numberInfo

    Represents number info. Can be null.

    Returns
    Type Description
    string

    Returns formula value or null.

    GetFormulaNumberValue(long)

    Returns formula value.

    Declaration
    public double GetFormulaNumberValue(long cellIndex)
    Parameters
    Type Name Description
    long cellIndex

    Cell index.

    Returns
    Type Description
    double

    Formula value if appropriate record was found; otherwise double.MinValue.

    GetFormulaStringValue(long)

    Returns string formula value.

    Declaration
    public string GetFormulaStringValue(long cellIndex)
    Parameters
    Type Name Description
    long cellIndex

    Cell index.

    Returns
    Type Description
    string

    String formula value.

    GetLabelSSTRTFString(long, bool)

    Gets the RTF string in LabelSST of the cell index.

    Declaration
    public RichTextString GetLabelSSTRTFString(long cellIndex, bool bAutofitRows)
    Parameters
    Type Name Description
    long cellIndex

    Cell index.

    bool bAutofitRows

    Indicates whether we are interested in correct height or width.

    Returns
    Type Description
    RichTextString

    RTF in the cell index.

    GetMaximumColumnIndex(int, int)

    Returns maximum used column.

    Declaration
    public int GetMaximumColumnIndex(int iStartRow, int iEndRow)
    Parameters
    Type Name Description
    int iStartRow

    Start row.

    int iEndRow

    End row.

    Returns
    Type Description
    int

    Maximum used column.

    GetMaximumRowIndex(int, int)

    Returns maximum used row.

    Declaration
    public int GetMaximumRowIndex(int iStartColumn, int iEndColumn)
    Parameters
    Type Name Description
    int iStartColumn

    Start column.

    int iEndColumn

    End column.

    Returns
    Type Description
    int

    maximum used row.

    GetMinimumColumnIndex(int, int)

    Returns minimum used column.

    Declaration
    public int GetMinimumColumnIndex(int iStartRow, int iEndRow)
    Parameters
    Type Name Description
    int iStartRow

    One-based index of the start row.

    int iEndRow

    One-based index of the end row.

    Returns
    Type Description
    int

    One-based index of the minimum used column.

    GetMinimumRowIndex(int, int)

    Returns minimum used row.

    Declaration
    public int GetMinimumRowIndex(int iStartColumn, int iEndColumn)
    Parameters
    Type Name Description
    int iStartColumn

    Start column.

    int iEndColumn

    End column.

    Returns
    Type Description
    int

    Minimum used row.

    GetNumber(long)

    Returns cell value by cell index.

    Declaration
    public double GetNumber(long cellIndex)
    Parameters
    Type Name Description
    long cellIndex

    Cell index.

    Returns
    Type Description
    double

    Cell value if appropriate record was found; otherwise returns double.MinValue.

    GetNumberWithoutFormula(long)

    Returns cell value by cell index without formula value.

    Declaration
    public double GetNumberWithoutFormula(long cellIndex)
    Parameters
    Type Name Description
    long cellIndex

    Cell index.

    Returns
    Type Description
    double

    Cell value if appropriate record was found; otherwise returns double.MinValue.

    GetRTFString(long, bool)

    Returns string value associated with specified cell index.

    Declaration
    public RichTextString GetRTFString(long cellIndex, bool bAutofitRows)
    Parameters
    Type Name Description
    long cellIndex

    Index to cell.

    bool bAutofitRows

    Indicates whether we are interested in correct height or width.

    Returns
    Type Description
    RichTextString

    String value associated with specified cell index.

    GetRange(int, int)

    Returns cell range based on row and column index.

    Declaration
    public RangeImpl GetRange(int iRow, int iColumn)
    Parameters
    Type Name Description
    int iRow

    One-based row index.

    int iColumn

    One-based column index.

    Returns
    Type Description
    RangeImpl

    Corresponding cell range.

    GetRange(long)

    Returns cell range based on cell position.

    Declaration
    public RangeImpl GetRange(long key)
    Parameters
    Type Name Description
    long key

    Cell key.

    Returns
    Type Description
    RangeImpl

    Corresponding cell range.

    GetRowData(int, int, int, out int, out int, ExcelVersion)

    Returns array of all cells in the specified row.

    Declaration
    [CLSCompliant(false)]
    protected RowStorage GetRowData(int index, int iFirstColumn, int iLastColumn, out int min, out int max, ExcelVersion version)
    Parameters
    Type Name Description
    int index

    One-based index of row.

    int iFirstColumn

    One-based first column in the parent worksheet.

    int iLastColumn

    One-based last column in the parent worksheet.

    int min

    Variable that receives first used column of the row.

    int max

    Variable that receives last used column of the row.

    ExcelVersion version

    Destination excel version.

    Returns
    Type Description
    RowStorage

    Array of all cells in the specified row.

    Exceptions
    Type Condition
    ArgumentNullException

    When values is null.

    GetText(long)

    Returns text value.

    Declaration
    public string GetText(long cellIndex)
    Parameters
    Type Name Description
    long cellIndex

    Cell index.

    Returns
    Type Description
    string

    Text value if appropriate record was found; otherwise - empty string.

    GetValue(long, int, int, IRange, string)

    Gets string value by cell index.

    Declaration
    public string GetValue(long cellIndex, int row, int column, IRange range, string seperator)
    Parameters
    Type Name Description
    long cellIndex

    Cell Index.

    int row

    Row index

    int column

    Column index

    IRange range

    Range from which value to be returned

    string seperator

    CSV seperator

    Returns
    Type Description
    string

    Returns string value or empty string.

    MarkUsedReferences(bool[])

    Sets items with used reference indexes to true.

    Declaration
    public void MarkUsedReferences(bool[] usedItems)
    Parameters
    Type Name Description
    bool[] usedItems

    Array to mark used references in.

    OnDispose()

    This method is called when object is about to be disposed.

    Declaration
    protected override void OnDispose()
    Overrides
    CommonObject.OnDispose()

    ReAddAllStrings()

    Looks through all records and calls AddIncrease for each LabelSST record.

    Declaration
    public void ReAddAllStrings()

    Remove(int, int)

    Removes the element from the IDictionary based on the row and column index.

    Declaration
    public void Remove(int iRow, int iColumn)
    Parameters
    Type Name Description
    int iRow

    One-based row index of the cell to remove.

    int iColumn

    One-based column index of the cell to remove.

    Remove(long)

    Removes the element from the IDictionary with the specified key of long type.

    Declaration
    public void Remove(long key)
    Parameters
    Type Name Description
    long key

    The key of the element to remove.

    Remove(object)

    Removes the element from the IDictionary with the specified key of object type.

    Declaration
    public void Remove(object key)
    Parameters
    Type Name Description
    object key

    The key of the element to remove.

    RemoveLastColumn(int)

    Removes last column from the worksheet.

    Declaration
    public void RemoveLastColumn(int iColumnIndex)
    Parameters
    Type Name Description
    int iColumnIndex

    One-based column index.

    RemoveRow(int)

    Removes last column from the worksheet.

    Declaration
    public void RemoveRow(int iRowIndex)
    Parameters
    Type Name Description
    int iRowIndex

    One-based column index.

    ReplaceSharedFormula()

    Replaces all shared formula with ordinary formula.

    Declaration
    [CLSCompliant(false)]
    public void ReplaceSharedFormula()

    Serialize(OffsetArrayList, List<DBCellRecord>)

    Saves all rows into specified OffsetArrayList.

    Declaration
    [CLSCompliant(false)]
    public int Serialize(OffsetArrayList records, List<DBCellRecord> arrDBCells)
    Parameters
    Type Name Description
    OffsetArrayList records

    OffsetArrayList that will receive all rows.

    List<DBCellRecord> arrDBCells

    List into which all DBCell record must be placed.

    Returns
    Type Description
    int

    Number of DBCells.

    Exceptions
    Type Condition
    ArgumentNullException

    When records is null.

    SetArrayFormula(ArrayRecord)

    Sets array formula.

    Declaration
    [CLSCompliant(false)]
    public void SetArrayFormula(ArrayRecord record)
    Parameters
    Type Name Description
    ArrayRecord record

    Record to set.

    SetBlank(int, int, int)

    Sets blank value.

    Declaration
    public void SetBlank(int iRow, int iCol, int iXFIndex)
    Parameters
    Type Name Description
    int iRow

    Represents row index. One based.

    int iCol

    Represents column index. One based.

    int iXFIndex

    Represents extended format index.

    SetBooleanValue(int, int, bool)

    Sets boolean value.

    Declaration
    public void SetBooleanValue(int iRow, int iCol, bool bValue)
    Parameters
    Type Name Description
    int iRow

    Represents row index. One based.

    int iCol

    Represents column index. One based

    bool bValue

    Represents boolean value.

    SetBooleanValue(int, int, bool, int)

    Sets boolean value with extended format.

    Declaration
    public void SetBooleanValue(int iRow, int iCol, bool bValue, int iXFIndex)
    Parameters
    Type Name Description
    int iRow

    Represents row index. One-based.

    int iCol

    Represents column index. One-based.

    bool bValue

    Represents boolean value.

    int iXFIndex

    Represents xf index.

    SetBooleanValue(long, bool)

    Sets boolean value in specified cell index.

    Declaration
    public void SetBooleanValue(long cellIndex, bool bValue)
    Parameters
    Type Name Description
    long cellIndex

    Cell index.

    bool bValue

    Represents boolean value.

    SetCellRecord(int, int, ICellPositionFormat)

    Sets cell record based on row and column index.

    Declaration
    [CLSCompliant(false)]
    public void SetCellRecord(int iRow, int iColumn, ICellPositionFormat cell)
    Parameters
    Type Name Description
    int iRow

    One-based row index.

    int iColumn

    One-based column index.

    ICellPositionFormat cell

    Cell to set.

    SetCellRecord(long, ICellPositionFormat)

    Sets cell record based on cell index.

    Declaration
    [CLSCompliant(false)]
    public void SetCellRecord(long key, ICellPositionFormat cell)
    Parameters
    Type Name Description
    long key

    Cell key.

    ICellPositionFormat cell

    Cell to set.

    SetCellStyle(int, int)

    Sets cell style in specified row and column.

    Declaration
    public void SetCellStyle(int iRow, int index)
    Parameters
    Type Name Description
    int iRow

    One-based row index.

    int index

    Index of the extended format to set.

    SetCellStyle(int, int, int)

    Sets cell style with extended format index.

    Declaration
    public void SetCellStyle(int iRow, int iColumn, int iXFIndex)
    Parameters
    Type Name Description
    int iRow

    One-based row index.

    int iColumn

    One-based column index.

    int iXFIndex

    Index of the extended format to set.

    SetErrorValue(int, int, byte, int)

    Sets error value with error code and extended format index.

    Declaration
    public void SetErrorValue(int iRow, int iCol, byte errorCode, int iXFIndex)
    Parameters
    Type Name Description
    int iRow

    Represents row index. One based.

    int iCol

    Represents column index. One based.

    byte errorCode

    Represents error code.

    int iXFIndex

    Represents xf index.

    SetErrorValue(int, int, string)

    Sets error value with a string value and default extended format index.

    Declaration
    public void SetErrorValue(int iRow, int iCol, string strValue)
    Parameters
    Type Name Description
    int iRow

    Represents row index. One based.

    int iCol

    Represents column index. One based.

    string strValue

    Represents error value.

    SetErrorValue(int, int, string, int)

    Sets error value with a string value and extended format index.

    Declaration
    public void SetErrorValue(int iRow, int iCol, string strValue, int iXFIndex)
    Parameters
    Type Name Description
    int iRow

    Represents row index. One based.

    int iCol

    Represents column index. One based.

    string strValue

    Represents error value.

    int iXFIndex

    Represents xf index.

    SetErrorValue(long, string)

    Sets error value with a string value in cell index.

    Declaration
    public void SetErrorValue(long cellIndex, string strValue)
    Parameters
    Type Name Description
    long cellIndex

    Cell index.

    string strValue

    Represents error value.

    SetFormula(int, int, string, int)

    Sets formula value with extended format index.

    Declaration
    public void SetFormula(int iRow, int iCol, string strValue, int iXFIndex)
    Parameters
    Type Name Description
    int iRow

    Represents row index. One based.

    int iCol

    Represents column index. One based.

    string strValue

    Represents formula to set.

    int iXFIndex

    Represents extended format index.

    SetFormula(int, int, string, int, bool)

    Sets formula value with extended format index and R1C1 notation.

    Declaration
    public void SetFormula(int iRow, int iCol, string strValue, int iXFIndex, bool isR1C1)
    Parameters
    Type Name Description
    int iRow

    Represents row index. One based.

    int iCol

    Represents column index. One based.

    string strValue

    Represents formula to set.

    int iXFIndex

    Represents extended format index.

    bool isR1C1

    If true - value in R1C1 notation.

    SetFormula(int, int, string, int, bool, bool, NumberFormatInfo)

    Sets formula value with extended format index, number format information, R1C1 notation and parse formula.

    Declaration
    public void SetFormula(int iRow, int iCol, string strValue, int iXFIndex, bool isR1C1, bool bParse, NumberFormatInfo formatInfo)
    Parameters
    Type Name Description
    int iRow

    Represents row index. One based.

    int iCol

    Represents column index. One based.

    string strValue

    Represents formula to set.

    int iXFIndex

    Represents extended format index.

    bool isR1C1

    If true - value in R1C1 notation.

    bool bParse

    If true - parse formula.

    NumberFormatInfo formatInfo

    Represent number format info, can be null.

    SetFormula(int, int, string, int, bool, NumberFormatInfo)

    Sets formula value with extended format index, number format information and R1C1 notation.

    Declaration
    public void SetFormula(int iRow, int iCol, string strValue, int iXFIndex, bool isR1C1, NumberFormatInfo formatInfo)
    Parameters
    Type Name Description
    int iRow

    Represents row index. One based.

    int iCol

    Represents column index. One based.

    string strValue

    Represents formula to set.

    int iXFIndex

    Represents extended format index.

    bool isR1C1

    If true - value in R1C1 notation.

    NumberFormatInfo formatInfo

    Represent number format info, can be null.

    SetNumberValue(int, int, double)

    Sets number value with default extended format index.

    Declaration
    public void SetNumberValue(int iRow, int iCol, double dValue)
    Parameters
    Type Name Description
    int iRow

    Represents row index. One-based.

    int iCol

    Represents column index. One-based.

    double dValue

    Represents number value.

    SetNumberValue(int, int, double, int)

    Sets number value with specified extended format index.

    Declaration
    public void SetNumberValue(int iRow, int iCol, double dValue, int iXFIndex)
    Parameters
    Type Name Description
    int iRow

    Represents row index. One-based.

    int iCol

    Represents column index. One-based.

    double dValue

    Represents number value.

    int iXFIndex

    Represents xf index.

    SetNumberValue(long, double)

    Sets number value in cell index.

    Declaration
    public void SetNumberValue(long cellIndex, double dValue)
    Parameters
    Type Name Description
    long cellIndex

    Cell index.

    double dValue

    Represents number value.

    SetRTF(int, int, int, TextWithFormat)

    Sets RTF value.

    Declaration
    public void SetRTF(int iRow, int iCol, int iXFIndex, TextWithFormat rtf)
    Parameters
    Type Name Description
    int iRow

    Represents row index. One based.

    int iCol

    Represents column index. One based.

    int iXFIndex

    Represents extended format index.

    TextWithFormat rtf

    Represents rtf to set.

    SetRange(int, int, RangeImpl)

    Sets cell range with row and column index.

    Declaration
    [CLSCompliant(false)]
    public void SetRange(int iRow, int iColumn, RangeImpl range)
    Parameters
    Type Name Description
    int iRow

    One-based row index.

    int iColumn

    One-based column index.

    RangeImpl range

    Range to set.

    SetRange(long, RangeImpl)

    Sets cell range with cell index.

    Declaration
    [CLSCompliant(false)]
    public void SetRange(long key, RangeImpl range)
    Parameters
    Type Name Description
    long key

    Cell key.

    RangeImpl range

    Range to set.

    SetSingleStringValue(int, int, int, int)

    Sets string value from existing SST collection.

    Declaration
    public void SetSingleStringValue(int iRow, int iCol, int iXFIndex, int iSSTIndex)
    Parameters
    Type Name Description
    int iRow

    Represents row index. One based.

    int iCol

    Represents column index. One based.

    int iXFIndex

    Represents extended format index.

    int iSSTIndex

    Represents SST index

    SetStringValue(long, string)

    Sets string formula value.

    Declaration
    public void SetStringValue(long cellIndex, string strValue)
    Parameters
    Type Name Description
    long cellIndex

    Cell index.

    string strValue

    String value to set.

    UpdateExtendedFormatIndex(Dictionary<int, int>)

    This method should be called immediately after extended format removal with IDictionary.

    Declaration
    public void UpdateExtendedFormatIndex(Dictionary<int, int> dictFormats)
    Parameters
    Type Name Description
    Dictionary<int, int> dictFormats

    Dictionary with updated extended formats.

    UpdateExtendedFormatIndex(int)

    This method updates indexes to the extended formats after version change.

    Declaration
    public void UpdateExtendedFormatIndex(int maxCount)
    Parameters
    Type Name Description
    int maxCount

    New restriction for maximum possible XF index.

    UpdateExtendedFormatIndex(int[])

    This method should be called immediately after extended format removal.

    Declaration
    public void UpdateExtendedFormatIndex(int[] arrFormats)
    Parameters
    Type Name Description
    int[] arrFormats

    Array with updated extended formats.

    UpdateFormula(int, int, Rectangle, int, Rectangle)

    Updates formulas after copy operation.

    Declaration
    public void UpdateFormula(int iCurIndex, int iSourceIndex, Rectangle sourceRect, int iDestIndex, Rectangle destRect)
    Parameters
    Type Name Description
    int iCurIndex

    Current worksheet index.

    int iSourceIndex

    Source worksheet index.

    Rectangle sourceRect

    Source rectangle.

    int iDestIndex

    Destination worksheet index.

    Rectangle destRect

    Destination rectangle.

    UpdateNameIndexes(WorkbookImpl, IDictionary<int, int>)

    Updates indexes to named ranges from IDictionary.

    Declaration
    public void UpdateNameIndexes(WorkbookImpl book, IDictionary<int, int> dicNewIndex)
    Parameters
    Type Name Description
    WorkbookImpl book

    Parent workbook.

    IDictionary<int, int> dicNewIndex

    New indexes.

    UpdateNameIndexes(WorkbookImpl, int[])

    Updates indexes to named ranges from array of new index.

    Declaration
    public void UpdateNameIndexes(WorkbookImpl book, int[] arrNewIndex)
    Parameters
    Type Name Description
    WorkbookImpl book

    Parent workbook.

    int[] arrNewIndex

    New indexes.

    UpdateReferenceIndexes(int[])

    Updates reference indexes.

    Declaration
    public void UpdateReferenceIndexes(int[] arrUpdatedIndexes)
    Parameters
    Type Name Description
    int[] arrUpdatedIndexes

    Array with updated indexes.

    UpdateStringIndexes(List<int>)

    Updates string indexes.

    Declaration
    public void UpdateStringIndexes(List<int> arrNewIndexes)
    Parameters
    Type Name Description
    List<int> arrNewIndexes

    List with new indexes.

    Implements

    IParentApplication
    IDisposable
    IDictionary
    ICollection
    IEnumerable
    In this article
    Back to top Generated by DocFX
    Copyright © 2001 - 2026 Syncfusion Inc. All Rights Reserved