Class ExternalParameterAttribute

Decorates properties that may be used as bindable external parameters. Provides methods for extraction of parameter names, values and binding of external object values into public read/write properties decorated by this attribute

Inheritance
System.Object
System.Attribute
ExternalParameterAttribute
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)
System.Object.ToString()
Namespace: NFX
Assembly: NFX.dll
Syntax
[AttributeUsage(AttributeTargets.Property, Inherited = true, AllowMultiple = false)]
public sealed class ExternalParameterAttribute : Attribute

Constructors

ExternalParameterAttribute()

Declaration
public ExternalParameterAttribute()

ExternalParameterAttribute(String, ExternalParameterSecurityCheck, String[])

Provides a name override with list of groups names where this parameter applies

Declaration
public ExternalParameterAttribute(string name, ExternalParameterSecurityCheck security, params string[] groups)
Parameters
Type Name Description
System.String name
ExternalParameterSecurityCheck security
System.String[] groups

ExternalParameterAttribute(String[])

Provides a list of group names where this parameter applies

Declaration
public ExternalParameterAttribute(params string[] groups)
Parameters
Type Name Description
System.String[] groups

Fields

Groups

Returns null or a set of group names where parameter is applicable. This is needed to disregard parameters that do not belong to things being managed, for example, some parameters may be only set for isntrumentation, not for glue etc.

Declaration
public readonly IEnumerable<string> Groups
Field Value
Type Description
System.Collections.Generic.IEnumerable<System.String>

Name

Provides name override for external parameter. When this value is not set the name is taken from the decorated member name

Declaration
public readonly string Name
Field Value
Type Description
System.String

SecurityCheck

Specifies what security check must be done on get/set

Declaration
public readonly ExternalParameterSecurityCheck SecurityCheck
Field Value
Type Description
ExternalParameterSecurityCheck

Methods

GetParameter(Object, String, out Object, String[])

Gets instrumentation parameter value returning true if parameter was found. Parameter names are case-insensitive. If groups is null then all parameters are searched, else parameters must intersect in their group sets with the supplied value

Declaration
public static bool GetParameter(object target, string name, out object value, params string[] groups)
Parameters
Type Name Description
System.Object target
System.String name
System.Object value
System.String[] groups
Returns
Type Description
System.Boolean

GetParameters(Object, String[])

Returns external parameter names and type - names for read/write public properties decorated with this attribute. If groups is null then all parameters returned, else parameters must intersect in their group sets with the supplied value

Declaration
public static IEnumerable<KeyValuePair<string, Type>> GetParameters(object target, params string[] groups)
Parameters
Type Name Description
System.Object target
System.String[] groups
Returns
Type Description
System.Collections.Generic.IEnumerable<System.Collections.Generic.KeyValuePair<System.String, System.Type>>

GetParameters(Type, String[])

Returns external parameter names and type - names for read/write public properties decorated with this attribute. If groups is null then all parameters returned, else parameters must intersect in their group sets with the supplied value

Declaration
public static IEnumerable<KeyValuePair<string, Type>> GetParameters(Type target, params string[] groups)
Parameters
Type Name Description
System.Type target
System.String[] groups
Returns
Type Description
System.Collections.Generic.IEnumerable<System.Collections.Generic.KeyValuePair<System.String, System.Type>>

GetParametersWithAttrs(Type, String[])

Returns external parameter names, type and attributes - names for read/write public properties decorated with this attribute. If groups is null then all parameters returned, else parameters must intersect in their group sets with the supplied value

Declaration
public static IEnumerable<Tuple<string, Type, ExternalParameterAttribute>> GetParametersWithAttrs(Type target, params string[] groups)
Parameters
Type Name Description
System.Type target
System.String[] groups
Returns
Type Description
System.Collections.Generic.IEnumerable<System.Tuple<System.String, System.Type, ExternalParameterAttribute>>

SetParameter(Object, String, Object, String[])

Sets instrumentation parameter value, true if parameter name was found and set succeeded. The property is tried to be set directly to the supplied value first, then, in case of assignment error, the value is converted into string then tried to be re-converted to target type. Returns true for successful set. Parameter names are case-insensitive. If groups is null then all parameters are searched, else parameters must intersect in their group sets with the supplied value

Declaration
public static bool SetParameter(object target, string name, object value, params string[] groups)
Parameters
Type Name Description
System.Object target
System.String name
System.Object value
System.String[] groups
Returns
Type Description
System.Boolean

Extension Methods