Function Class Reference

Represents a function supported by built-in expression parser. More...

Collaboration diagram for Function:
Collaboration graph

Public Member Functions

string get_Alias (int aliasIndex)
 Gets the alias of the function. More...
 
string get_ParameterDescription (int parameterIndex)
 Gets the description of the specified parameter of the function. More...
 
string get_ParameterName (int parameterIndex)
 Gets the name of the specified parameter. More...
 

Properties

string Description [get]
 Gets the description of the function. More...
 
tkFunctionGroup Group [get]
 Gets the group to which this function belongs. More...
 
string Name [get]
 Gets the name of the function. More...
 
int NumAliases [get]
 Gets the number of aliases that the function has. More...
 
int NumParameters [get]
 Gets the number of parameters of the function. More...
 
string Signature [get]
 Gets the signature of the function. More...
 

Detailed Description

Represents a function supported by built-in expression parser.

New API 4.9.4:
Added in version 4.9.4

Member Function Documentation

◆ get_Alias()

string Function.get_Alias ( int  aliasIndex)

Gets the alias of the function.

Parameters
aliasIndexIndex of the alias.

◆ get_ParameterDescription()

string Function.get_ParameterDescription ( int  parameterIndex)

Gets the description of the specified parameter of the function.

Parameters
parameterIndexIndex of the parameter.
Returns
The description of the parameter.

◆ get_ParameterName()

string Function.get_ParameterName ( int  parameterIndex)

Gets the name of the specified parameter.

Parameters
parameterIndexIndex of the parameter.
Returns
The name of the parameter.

Property Documentation

◆ Description

string Function.Description
get

Gets the description of the function.

◆ Group

tkFunctionGroup Function.Group
get

Gets the group to which this function belongs.

◆ Name

string Function.Name
get

Gets the name of the function.

◆ NumAliases

int Function.NumAliases
get

Gets the number of aliases that the function has.

◆ NumParameters

int Function.NumParameters
get

Gets the number of parameters of the function.

◆ Signature

string Function.Signature
get

Gets the signature of the function.