ExternalParameterAttribute MembersNFX Class Library

[This is preliminary documentation and is subject to change.]

The ExternalParameterAttribute type exposes the following members.
Constructors
  NameDescription
Public methodExternalParameterAttribute 
Initializes a new instance of the ExternalParameterAttribute class
Public methodExternalParameterAttribute( String )
Provides a list of group names where this parameter applies
Public methodExternalParameterAttribute(String, ExternalParameterSecurityCheck,  String )
Provides a name override with list of groups names where this parameter applies
Back to Top
Methods
  NameDescription
Public methodOnlineEquals
Returns a value that indicates whether this instance is equal to a specified object.
(Inherited from OnlineAttribute.)
Protected methodOnlineFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from OnlineObject.)
Public methodOnlineGetHashCode
Returns the hash code for this instance.
(Inherited from OnlineAttribute.)
Public methodStatic memberGetParameter
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
Public methodStatic memberGetParameters(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
Public methodStatic memberGetParameters(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
Public methodStatic memberGetParametersWithAttrs
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
Public methodOnlineGetType
Gets the OnlineType of the current instance.
(Inherited from OnlineObject.)
Public methodOnlineIsDefaultAttribute
When overridden in a derived class, indicates whether the value of this instance is the default value for the derived class.
(Inherited from OnlineAttribute.)
Public methodOnlineMatch
When overridden in a derived class, returns a value that indicates whether this instance equals a specified object.
(Inherited from OnlineAttribute.)
Protected methodOnlineMemberwiseClone
Creates a shallow copy of the current OnlineObject.
(Inherited from OnlineObject.)
Public methodStatic memberSetParameter
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
Public methodOnlineToString
Returns a string that represents the current object.
(Inherited from OnlineObject.)
Back to Top
Extension Methods
  NameDescription
Public Extension MethodAsBool (Defined by ObjectValueConversion.)
Public Extension MethodAsByte (Defined by ObjectValueConversion.)
Public Extension MethodAsChar (Defined by ObjectValueConversion.)
Public Extension MethodAsDateTime Overloaded. (Defined by ObjectValueConversion.)
Public Extension MethodAsDateTime(DateTime, ConvertErrorHandling)Overloaded. (Defined by ObjectValueConversion.)
Public Extension MethodAsDecimal (Defined by ObjectValueConversion.)
Public Extension MethodAsDouble (Defined by ObjectValueConversion.)
Public Extension MethodAsEnum TEnum  (Defined by ObjectValueConversion.)
Public Extension MethodAsFloat (Defined by ObjectValueConversion.)
Public Extension MethodAsGDID Overloaded. (Defined by ObjectValueConversion.)
Public Extension MethodAsGDID(GDID, ConvertErrorHandling)Overloaded. (Defined by ObjectValueConversion.)
Public Extension MethodAsGDIDSymbol Overloaded. (Defined by ObjectValueConversion.)
Public Extension MethodAsGDIDSymbol(GDIDSymbol, ConvertErrorHandling)Overloaded. (Defined by ObjectValueConversion.)
Public Extension MethodAsGUID (Defined by ObjectValueConversion.)
Public Extension MethodAsInt (Defined by ObjectValueConversion.)
Public Extension MethodAsJSONConfig (Defined by ObjectValueConversion.)
Public Extension MethodAsLaconicConfig (Defined by ObjectValueConversion.)
Public Extension MethodAsLong (Defined by ObjectValueConversion.)
Public Extension MethodAsNonNullOrEmptyString (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableBool (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableByte (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableChar (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableDateTime (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableDecimal (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableDouble (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableEnum TEnum  (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableFloat (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableGDID (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableGDIDSymbol (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableGUID (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableInt (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableLong (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableSByte (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableShort (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableTimeSpan (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableUInt (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableULong (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableUShort (Defined by ObjectValueConversion.)
Public Extension MethodAsSByte (Defined by ObjectValueConversion.)
Public Extension MethodAsShort (Defined by ObjectValueConversion.)
Public Extension MethodAsString (Defined by ObjectValueConversion.)
Public Extension MethodAsTimeSpan Overloaded. (Defined by ObjectValueConversion.)
Public Extension MethodAsTimeSpan(TimeSpan, ConvertErrorHandling)Overloaded. (Defined by ObjectValueConversion.)
Public Extension MethodAsUInt (Defined by ObjectValueConversion.)
Public Extension MethodAsULong (Defined by ObjectValueConversion.)
Public Extension MethodAsUri (Defined by ObjectValueConversion.)
Public Extension MethodAsUShort (Defined by ObjectValueConversion.)
Public Extension MethodAsXMLConfig (Defined by ObjectValueConversion.)
Public Extension MethodToErlObject Overloaded.
Try to convert .NET native object type to corresponding Erlang term. Throw exception if conversion is not possible
(Defined by ErlObject.)
Public Extension MethodToErlObject(ErlTypeOrder, Boolean)Overloaded.
Try to convert .NET native object type to corresponding Erlang term of given type. Throw exception if conversion is not possible
(Defined by ErlObject.)
Public Extension MethodToJSON(JSONWritingOptions)Overloaded.
Serializes object into JSON string
(Defined by JSONExtensions.)
Public Extension MethodToJSON(TextWriter, JSONWritingOptions)Overloaded.
Serializes object into JSON format using provided TextWriter
(Defined by JSONExtensions.)
Public Extension MethodToJSON(Stream, JSONWritingOptions, Encoding)Overloaded.
Serializes object into JSON format using provided stream and optional encoding
(Defined by JSONExtensions.)
Back to Top
Fields
  NameDescription
Public fieldGroups
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.
Public fieldName
Provides name override for external parameter. When this value is not set the name is taken from the decorated member name
Public fieldSecurityCheck
Specifies what security check must be done on get/set
Back to Top
Properties
  NameDescription
Public propertyOnlineTypeId
When implemented in a derived class, gets a unique identifier for this OnlineAttribute.
(Inherited from OnlineAttribute.)
Back to Top
See Also
ExternalParameterAttribute Class
NFX Namespace