Spread Windows Forms 17
GrapeCity.Spreadsheet Assembly / GrapeCity.Spreadsheet.UI Namespace / UIHelper Class / ParseInput(IWorksheet,String,Int32,Int32,IPrimitiveValue,Expression,Int32,ParseInputMode) Method
The GrapeCity.Spreadsheet.IWorksheet object which is using formula.
A string value indicates the input value.
An integer value indicates the context row index.
An integer value indicates the context column index.
The GrapeCity.CalcEngine.IPrimitiveValue object which stores primitive value.
The GrapeCity.CalcEngine.Expression which stores inputted formula.
The number format which is parsed from inputted value.
A ParseInputMode value indicates how the text will be parsed.


In This Topic
    ParseInput(IWorksheet,String,Int32,Int32,IPrimitiveValue,Expression,Int32,ParseInputMode) Method
    In This Topic
    Parsers the input value which accepts both of primitive value and formula.
    Syntax
    'Declaration
     
    
    Public Shared Function ParseInput( _
       ByVal worksheet As IWorksheet, _
       ByVal value As String, _
       ByVal contextRow As Integer, _
       ByVal contextColumn As Integer, _
       ByRef primitiveValue As IPrimitiveValue, _
       ByRef expression As Expression, _
       ByRef builtInNumFmt As Integer, _
       Optional ByVal mode As ParseInputMode _
    ) As Boolean
    'Usage
     
    
    Dim worksheet As IWorksheet
    Dim value As String
    Dim contextRow As Integer
    Dim contextColumn As Integer
    Dim primitiveValue As IPrimitiveValue
    Dim expression As Expression
    Dim builtInNumFmt As Integer
    Dim mode As ParseInputMode
    Dim value As Boolean
     
    value = UIHelper.ParseInput(worksheet, value, contextRow, contextColumn, primitiveValue, expression, builtInNumFmt, mode)

    Parameters

    worksheet
    The GrapeCity.Spreadsheet.IWorksheet object which is using formula.
    value
    A string value indicates the input value.
    contextRow
    An integer value indicates the context row index.
    contextColumn
    An integer value indicates the context column index.
    primitiveValue
    The GrapeCity.CalcEngine.IPrimitiveValue object which stores primitive value.
    expression
    The GrapeCity.CalcEngine.Expression which stores inputted formula.
    builtInNumFmt
    The number format which is parsed from inputted value.
    mode
    A ParseInputMode value indicates how the text will be parsed.

    Return Value

    true if the formula can be parsed successful; otherwise, false.
    Remarks
    This function doesn't accepts empty formula. It must be checked by the caller.
    See Also