Class FormulaFunctionAttribute

Describes a function that can be used by the formula engine. The description is used in the formula engine editor for information about all possible callable functions

Inheritance
object
Attribute
FormulaFunctionAttribute
Inherited Members
Namespace: LemonEdge.Utils
Assembly: LemonEdge.Utils.dll
Syntax
public class FormulaFunctionAttribute : Attribute

Constructors

FormulaFunctionAttribute()

Declaration
public FormulaFunctionAttribute()

Properties

Description

A description of what this function does

Declaration
public string Description { get; set; }
Property Value
Type Description
string

IsAsync

Indicates if calling this function requires awaiting a task result

Declaration
public bool IsAsync { get; set; }
Property Value
Type Description
bool

Name

The name of this function

Declaration
public string Name { get; set; }
Property Value
Type Description
string

ParamCount

The total count of parameters. Should match the number of bullet point parameters specified in Params

Declaration
public int ParamCount { get; set; }
Property Value
Type Description
int

Params

A numbered list of all the parameters to this function along with their explanation

Declaration
public string Params { get; set; }
Property Value
Type Description
string

Type

A grouping category for this function

Declaration
public string Type { get; set; }
Property Value
Type Description
string

Methods

GetFunctions(Type)

Returns all functions that have the FormulaFunctionAttribute marked against them for a given type

Declaration
public static IEnumerable<FormulaFunctionAttribute> GetFunctions(Type type)
Parameters
Type Name Description
Type type

The type to find all functions that have the FormulaFunctionAttribute marked against them. This includes base types
Returns
Type Description
IEnumerable<FormulaFunctionAttribute>

A list of all functions against the specified type that have the FormulaFunctionAttribute marked against them

ToString()

Declaration
public override string ToString()
Returns
Type Description
string
Overrides

Extension Methods