Add information about parameters to functions callable via the "C# Function" feature.

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

Syntax

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

Examples

Here is an example of how to use FunctionParameterDescriptionAttribute
CopyC#
[FunctionParameterDescription("searchTerm", "Search term", "One or more keywords to search for")]
[FunctionParameterDescription("filter", "Filter", "Filter to apply to data before searching for search term", null)]
public static int GetItemCount( string searchTerm, Expression<Func<IMyDataType,bool>> filter ) 
{ 
    if (filter == null ) filter = _defaultFilter;
    // more code here
}

Inheritance Hierarchy

System..::..Object
  System..::..Attribute
    Composite.Functions..::..FunctionParameterDescriptionAttribute

See Also