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

System.Object

System.Attribute

FormulaFunctionAttribute

Inherited Members

System.Attribute.Equals(System.Object)

System.Attribute.GetCustomAttribute(System.Reflection.Assembly, System.Type)

System.Attribute.GetCustomAttribute(System.Reflection.Assembly, System.Type, System.Boolean)

System.Attribute.GetCustomAttribute(System.Reflection.MemberInfo, System.Type)

System.Attribute.GetCustomAttribute(System.Reflection.MemberInfo, System.Type, System.Boolean)

System.Attribute.GetCustomAttribute(System.Reflection.Module, System.Type)

System.Attribute.GetCustomAttribute(System.Reflection.Module, System.Type, System.Boolean)

System.Attribute.GetCustomAttribute(System.Reflection.ParameterInfo, System.Type)

System.Attribute.GetCustomAttribute(System.Reflection.ParameterInfo, System.Type, System.Boolean)

System.Attribute.GetCustomAttributes(System.Reflection.Assembly)

System.Attribute.GetCustomAttributes(System.Reflection.Assembly, System.Boolean)

System.Attribute.GetCustomAttributes(System.Reflection.Assembly, System.Type)

System.Attribute.GetCustomAttributes(System.Reflection.Assembly, System.Type, System.Boolean)

System.Attribute.GetCustomAttributes(System.Reflection.MemberInfo)

System.Attribute.GetCustomAttributes(System.Reflection.MemberInfo, System.Boolean)

System.Attribute.GetCustomAttributes(System.Reflection.MemberInfo, System.Type)

System.Attribute.GetCustomAttributes(System.Reflection.MemberInfo, System.Type, System.Boolean)

System.Attribute.GetCustomAttributes(System.Reflection.Module)

System.Attribute.GetCustomAttributes(System.Reflection.Module, System.Boolean)

System.Attribute.GetCustomAttributes(System.Reflection.Module, System.Type)

System.Attribute.GetCustomAttributes(System.Reflection.Module, System.Type, System.Boolean)

System.Attribute.GetCustomAttributes(System.Reflection.ParameterInfo)

System.Attribute.GetCustomAttributes(System.Reflection.ParameterInfo, System.Boolean)

System.Attribute.GetCustomAttributes(System.Reflection.ParameterInfo, System.Type)

System.Attribute.GetCustomAttributes(System.Reflection.ParameterInfo, System.Type, System.Boolean)

System.Attribute.GetHashCode()

System.Attribute.IsDefaultAttribute()

System.Attribute.IsDefined(System.Reflection.Assembly, System.Type)

System.Attribute.IsDefined(System.Reflection.Assembly, System.Type, System.Boolean)

System.Attribute.IsDefined(System.Reflection.MemberInfo, System.Type)

System.Attribute.IsDefined(System.Reflection.MemberInfo, System.Type, System.Boolean)

System.Attribute.IsDefined(System.Reflection.Module, System.Type)

System.Attribute.IsDefined(System.Reflection.Module, System.Type, System.Boolean)

System.Attribute.IsDefined(System.Reflection.ParameterInfo, System.Type)

System.Attribute.IsDefined(System.Reflection.ParameterInfo, System.Type, System.Boolean)

System.Attribute.Match(System.Object)

System.Attribute.TypeId

System.Object.Equals(System.Object, System.Object)

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

Namespace: LemonEdge.Utils

Assembly: Utils.dll

Syntax

public class FormulaFunctionAttribute : Attribute

Properties

Description

A description of what this function does

Declaration

public string Description { get; set; }

Property Value

Type	Description
System.String

IsAsync

Indicates if calling this function requires awaiting a task result

Declaration

public bool IsAsync { get; set; }

Property Value

Type	Description
System.Boolean

Name

The name of this function

Declaration

public string Name { get; set; }

Property Value

Type	Description
System.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
System.Int32

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
System.String

Type

A grouping category for this function

Declaration

public string Type { get; set; }

Property Value

Type	Description
System.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
System.Type	type	The type to find all functions that have the FormulaFunctionAttribute marked against them. This includes base types

Returns

Type	Description
System.Collections.Generic.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
System.String

Overrides

System.Object.ToString()

Extension Methods

MiscExtensions.SetIfNotEqual<T, P>(T, Expression<Func<T, P>>, P)

ReflectionExtensions.ClearEventInvocations(Object, String)

StringExtensions.ToCSVFormatString(Object, Type)

SQLExtensions.ToSQLValue(Object, Boolean)