[]
        
(Showing Draft Content)

GrapeCity.Documents.Excel.CustomFunction.-ctor

CustomFunction Constructor

CustomFunction(string, FunctionValueType)

Initializes an instance of a custom function.

Declaration
public CustomFunction(string name, FunctionValueType result)
Public Sub New(name As String, result As FunctionValueType)
Parameters
Type Name Description
string name

The name of the custom function.

FunctionValueType result

Specifies the return type for the custom function.

CustomFunction(string, FunctionValueType, Parameter[])

Initializes an instance of a custom function.

This constructor passes null as the description to CustomFunction(string, string, FunctionValueType, Parameter[]).

Declaration
public CustomFunction(string name, FunctionValueType result, Parameter[] parameters)
Public Sub New(name As String, result As FunctionValueType, parameters As Parameter())
Parameters
Type Name Description
string name

The name of the custom function. Must not be null or empty.

FunctionValueType result

Specifies the return type for the custom function.

Parameter[] parameters

Specifies the parameters for the custom function. Can be null.

Exceptions
Type Condition
ArgumentNullException

if name is null or empty.

CustomFunction(string, string, FunctionValueType, Parameter[])

Initializes an instance of a custom function.

Declaration
public CustomFunction(string name, string description, FunctionValueType result, Parameter[] parameters)
Public Sub New(name As String, description As String, result As FunctionValueType, parameters As Parameter())
Parameters
Type Name Description
string name

The name of the custom function.

string description

The description of the custom function.

FunctionValueType result

Specifies the return type for the custom function.

Parameter[] parameters

Specifies the parmeters for the custom function.