Adds information about C1 Function parameters like label, help text, default value and custom widget markup. Different C1 Function providers let developers create new C1 Functions by creating artifacts like static funtions in C#, Razor Web Pages, User Controls etc. These C1 Functions can have parameters, typically defined as actual parameters (for static functions) or as public get/set propeties. This attribute signal that a C1 Function parameter is being defined and add label, help etc. The use of this attribute is relative to the C1 Function provider being used.

Namespace: Composite.Functions
Assembly: Composite (in Composite.dll) Version: 6.1.6325.31818

Syntax

C#
public sealed class FunctionParameterAttribute : Attribute
Visual Basic
Public NotInheritable Class FunctionParameterAttribute _
	Inherits Attribute
Visual C++
public ref class FunctionParameterAttribute sealed : public Attribute

Examples

Here is an example of how to use FunctionParameterAttribute to annotate multiple parameters of a function:
CopyC#
[FunctionParameter(Name="searchTerm", Label="Search term", Help="One or more keywords to search for")]
[FunctionParameter(Name="filter", Label="Filter", Help="Filter to apply to data before searching for search term", DefaultValue=null)]    
public static int GetItemCount( string searchTerm, Expression<Func<IMyDataType,bool>> filter ) 
{ 
    if (filter == null ) filter = _defaultFilter;
    // more code here
}
Note that Name is required when FunctionParameterAttribute is used this way.

Examples

Here is an example of how to use FunctionParameterAttribute to annotate a property:
CopyC#
[FunctionParameter(Label="Item count", DefaultValue=10)]
public int ItemCount { get; set; }
Note that Name is not expected when FunctionParameterAttribute is used this way.

Inheritance Hierarchy

System..::..Object
  System..::..Attribute
    Composite.Functions..::..FunctionParameterAttribute

See Also