Spread Windows Forms 17
GrapeCity.Spreadsheet Assembly / GrapeCity.Spreadsheet Namespace / SpreadsheetHelper Class / CollectValues Method
The evaluation context.
The GrapeCity.CalcEngine.IValue object indicates the source of numeric values.
The value is used when the cell is empty.
A boolean value indicating whether the value hidden cells are skipped.
Used if skipHiddenCells is true to fill emptyValue as replacement for hidden cells.
A boolean value indicating whether the first column will be collected.
A boolean value indicating whether the first row will be collected.
The value to fill if cell's value is text.


In This Topic
    CollectValues Method
    In This Topic
    Gets an array of numeric values from the specified GrapeCity.CalcEngine.IValue object.
    Syntax
    'Declaration
     
    
    Public Shared Function CollectValues( _
       ByVal context As IEvaluationContext, _
       ByVal dataRangeValue As IValue, _
       Optional ByVal emptyValue As Double, _
       Optional ByVal skipHiddenCells As Boolean, _
       Optional ByVal fillHiddenAsEmpty As Boolean, _
       Optional ByVal collectFirstColumn As Boolean, _
       Optional ByVal collectFirstRow As Boolean, _
       Optional ByVal defaultTextValue As Double _
    ) As Double()
    'Usage
     
    
    Dim context As IEvaluationContext
    Dim dataRangeValue As IValue
    Dim emptyValue As Double
    Dim skipHiddenCells As Boolean
    Dim fillHiddenAsEmpty As Boolean
    Dim collectFirstColumn As Boolean
    Dim collectFirstRow As Boolean
    Dim defaultTextValue As Double
    Dim value() As Double
     
    value = SpreadsheetHelper.CollectValues(context, dataRangeValue, emptyValue, skipHiddenCells, fillHiddenAsEmpty, collectFirstColumn, collectFirstRow, defaultTextValue)

    Parameters

    context
    The evaluation context.
    dataRangeValue
    The GrapeCity.CalcEngine.IValue object indicates the source of numeric values.
    emptyValue
    The value is used when the cell is empty.
    skipHiddenCells
    A boolean value indicating whether the value hidden cells are skipped.
    fillHiddenAsEmpty
    Used if skipHiddenCells is true to fill emptyValue as replacement for hidden cells.
    collectFirstColumn
    A boolean value indicating whether the first column will be collected.
    collectFirstRow
    A boolean value indicating whether the first row will be collected.
    defaultTextValue
    The value to fill if cell's value is text.

    Return Value

    An array of numeric values from the specified dataRangeValue object.
    See Also