Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Introducedin
09.1

Description

Excerpt

The FunctionValue class is used to pass arguments in and get results from custom functions.

...

Example
Code Block
csharp
csharp
titleC#
//public CreateFunctionValue a FunctionValue for a string
FunctionValue CustomFunction(IList<FunctionValue> args, Cell currentCell)
{
    StringBuilder result = new FunctionValueStringBuilder("Hello");
    
    // Iterate over the list of FunctionValues passed in
    foreach (FunctionValue arg in args)
        if (arg.Type != FunctionValueType.RANGE)
            result.Append(arg.Value);
    
    // Create a new FunctionValue to return as the result
    return new FunctionValue(result.ToString());
}
Code Block
vbnet
vbnet
titlevb.net
Public Function CustomFunction(args As IList(Of FunctionValue), currentCell As Cell) As FunctionValue
	Dim result As New StringBuilder("")

    ' Iterate over the list of FunctionValues passed in
	For Each arg As FunctionValue In args
		If arg.Type <> FunctionValueType.RANGE Then
			result.Append(arg.Value)
		End If
	Next

    ' Create a new FunctionValue forto areturn stringas Dimthe result
as	Return New FunctionValue("Hello")result.ToString())
End Function

Properties

Name

Description

Value

Excerpt Include
FunctionValue.Value
FunctionValue.Value
nopaneltrue

Type

Excerpt Include
FunctionValue.Type
FunctionValue.Type
nopaneltrue

Constructors

Creates a new FunctionValue with the Type set to RANGE

Name

Description

FunctionValue(stringString)

Creates a new FunctionValue with the Type set to STRING

FunctionValue(bool)

Creates a new FunctionValue with the Type set to BOOLEAN
FunctionValue(double)Creates a new FunctionValue with the Type set to NUMBER
FunctionValue(Range)
Excerpt Include
FunctionValue.FunctionValue(String)
FunctionValue.FunctionValue(String)
nopaneltrue

FunctionValue(Boolean)

Excerpt Include
FunctionValue.FunctionValue(Boolean)
FunctionValue.FunctionValue(Boolean)
nopaneltrue
FunctionValue(Double)
Excerpt Include
FunctionValue.FunctionValue(Double)
FunctionValue.FunctionValue(Double)
nopaneltrue
FunctionValue(Range)
Excerpt Include
FunctionValue.FunctionValue(Range)
FunctionValue.FunctionValue(Range)
nopaneltrue

Values

Name

Description

FunctionValue.Null

A static FunctionValue representing null.
FunctionValue.TrueA static FunctionValue representing true.
FunctionValue.FalseA static FunctionValue representing false.
FunctionValue.Div0ErrorOccurs when a number is divided either by zero (0) or by a cell that contains no value.
FunctionValue.ValueErrorOccurs when incorrect value type was passed into a function.
FunctionValue.NameErrorOccurs when text in a formula is not recognized.
FunctionValue.NumErrorOccurs with invalid numeric values in a formula or function.
FunctionValue.NullErrorOccurs when you specify an intersection of two areas that do not intersect.
FunctionValue.RefErrorOccurs when a cell reference is not valid.
FunctionValue.NAErrorOccurs when a value is not available to a function or formula.