GrapeCity.Documents.Excel.Parameter.-ctor

Parameter Constructor

Parameter(FunctionValueType)

Initializes an instance of a parameter.

This overload forwards null as the default value to Parameter(FunctionValueType, object).

Declaration

public Parameter(FunctionValueType valueType)

Public Sub New(valueType As FunctionValueType)

Parameters

Type	Name	Description
FunctionValueType	valueType	The value type of the parameter.

Parameter(FunctionValueType, bool)

Initializes an instance of a parameter.

Declaration

public Parameter(FunctionValueType valueType, bool acceptReference)

Public Sub New(valueType As FunctionValueType, acceptReference As Boolean)

Parameters

Type	Name	Description
FunctionValueType	valueType	The value type of the parameter.
bool	acceptReference	If this parameter can accept reference.

Parameter(FunctionValueType, bool, bool)

Initializes an instance of a parameter.

This overload creates a parameter without a name or description and configures whether it accepts references and custom objects.

Declaration

public Parameter(FunctionValueType valueType, bool acceptReference, bool acceptCustomObjects)

Public Sub New(valueType As FunctionValueType, acceptReference As Boolean, acceptCustomObjects As Boolean)

Parameters

Type	Name	Description
FunctionValueType	valueType	The value type of the parameter.
bool	acceptReference	If this parameter can accept reference.
bool	acceptCustomObjects	Accepts custom objects if value type is Object.

Parameter(FunctionValueType, object)

Initializes an instance of a parameter.

This overload creates a parameter without a name or description and forwards null for both values.

Declaration

public Parameter(FunctionValueType valueType, object defaultValue)

Public Sub New(valueType As FunctionValueType, defaultValue As Object)

Parameters

Type	Name	Description
FunctionValueType	valueType	The value type of the parameter.
object	defaultValue	The default value of the parameter. This value can be `null`.

Parameter(FunctionValueType, object, bool)

Initializes an instance of a parameter.

Declaration

public Parameter(FunctionValueType valueType, object defaultValue, bool acceptReference)

Public Sub New(valueType As FunctionValueType, defaultValue As Object, acceptReference As Boolean)

Parameters

Type	Name	Description
FunctionValueType	valueType	The value type of the parameter.
object	defaultValue	The default value of the parameter.
bool	acceptReference	If this parameter can accept reference.

Parameter(string, string, FunctionValueType, object)

Initializes an instance of a parameter.

Creates a parameter definition with the specified name, description, value type, and default value. This overload forwards false for the acceptReference argument.

Declaration

public Parameter(string name, string description, FunctionValueType valueType, object defaultValue)

Public Sub New(name As String, description As String, valueType As FunctionValueType, defaultValue As Object)

Parameters

Type	Name	Description
string	name	The name of the parameter. This value can be `null`.
string	description	The description of the parameter. This value can be `null`.
FunctionValueType	valueType	The value type of the parameter.
object	defaultValue	The default value of the parameter. This value can be `null`.

Parameter(string, string, FunctionValueType, object, bool)

Initializes an instance of a parameter.

Declaration

public Parameter(string name, string description, FunctionValueType valueType, object defaultValue, bool acceptReference)

Public Sub New(name As String, description As String, valueType As FunctionValueType, defaultValue As Object, acceptReference As Boolean)

Parameters

Type	Name	Description
string	name	The name of the function.
string	description	The description of the parameter.
FunctionValueType	valueType	The value type of the parameter.
object	defaultValue	The default value of the parameter.
bool	acceptReference	If this parameter can accept reference.

Parameter(string, string, FunctionValueType, object, bool, bool)

Initializes an instance of a parameter.

Declaration

public Parameter(string name, string description, FunctionValueType valueType, object defaultValue, bool acceptReference, bool acceptCustomObjects)

Public Sub New(name As String, description As String, valueType As FunctionValueType, defaultValue As Object, acceptReference As Boolean, acceptCustomObjects As Boolean)

Parameters

Type	Name	Description
string	name	The name of the function.
string	description	The description of the parameter.
FunctionValueType	valueType	The value type of the parameter.
object	defaultValue	The default value of the parameter.
bool	acceptReference	If this parameter can accept reference.
bool	acceptCustomObjects	Accepts custom objects if value type is Object.