CommandArgsConfiguration MembersNFX Class Library

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

The CommandArgsConfiguration type exposes the following members.
Constructors

  NameDescription
Public methodCommandArgsConfiguration( String )
Creates an instance of the new configuration parsed from command line arguments
Public methodCommandArgsConfiguration( String , Boolean)
Creates an instance of the new configuration parsed from command line arguments
Back to Top
Methods

  NameDescription
Protected methodAdjustNodeName
Override to perform transforms on node names so they become suitable for particular configuration type
(Inherited from Configuration.)
Public methodCheckAndAdjustNodeName
Checks node name for aptitude for particular configuration type. For example, XML configuration does not allow nodes with spaces or separator chars. When StrictNames is set to true and value is not appropriate then exception is thrown
(Inherited from Configuration.)
Public methodClone(Configuration)
Creates a deep copy of this configuration into newInstance which was allocated externally
(Inherited from Configuration.)
Public methodClone T  
Creates a deep copy of this configuration into new instance of T
(Inherited from Configuration.)
Public methodCreate
Creates new configuration - creates new configuration root with optional name parameter
(Inherited from Configuration.)
Public methodCreateFromMerge
Creates new configuration from ordered merge result of two other nodes - base and override which can be from different configurations
(Inherited from Configuration.)
Public methodCreateFromNode
Creates new configuration from other node, which may belong to a different configuration instance
(Inherited from Configuration.)
Public methodDestroy
Erases all config data
(Inherited from Configuration.)
Public methodOnlineEquals
Determines whether the specified object is equal to the current object.
(Inherited from OnlineObject.)
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
Serves as the default hash function.
(Inherited from OnlineObject.)
Public methodOnlineGetType
Gets the OnlineType of the current instance.
(Inherited from OnlineObject.)
Public methodInclude
Completely replaces this node with another node tree, positioning the new tree in the place of local node. Existing node is deleted after this operation completes, in its place child nodes from other node are inserted preserving their existing order. Attributes of other node get merged into parent of existing node
(Inherited from Configuration.)
Protected methodOnlineMemberwiseClone
Creates a shallow copy of the current OnlineObject.
(Inherited from OnlineObject.)
Public methodRefresh
Re-reads configuration from source
(Inherited from Configuration.)
Public methodResolveEnvironmentVar
Resolves variable name into its value
(Inherited from Configuration.)
Public methodRunMacro
Runs macro and returns its value
(Inherited from Configuration.)
Public methodSave
Saves configuration to source
(Inherited from Configuration.)
Public methodToConfigurationJSONDataMap
Returns this config as JSON data map suitable for making JSONConfiguration
(Inherited from Configuration.)
Public methodToLaconicFile
Serializes configuration tree into Laconic format and writes it into a file
(Inherited from Configuration.)
Public methodToLaconicStream
Serializes configuration tree into Laconic format and writes it into stream
(Inherited from Configuration.)
Public methodToLaconicString
Serializes configuration tree into Laconic format and returns it as a string
(Inherited from Configuration.)
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 fieldStatic memberARG_PREFIX_DASH
Public fieldStatic memberARG_PREFIX_SLASH
Protected fieldm_EmptyAttrNode (Inherited from Configuration.)
Protected fieldm_EmptySectionNode (Inherited from Configuration.)
Protected fieldm_Root (Inherited from Configuration.)
Public fieldStatic memberOPTION_EQ
Public fieldStatic memberROOT_NODE_NAME
Back to Top
Properties

  NameDescription
Public propertyArguments
Returns arguments array that this configuration was parsed from
Public propertyContentView
Primarily used for debugging - returns the content of the configuration as text in the pretty-printed Laconic format
(Inherited from Configuration.)
Public propertyEmptyAttr
References a special instance of an empty attribute node (one per configuration). Empty nodes are returned by indexers when a real node with specified name does not exist
(Inherited from Configuration.)
Public propertyEmptySection
References a special instance of an empty section node (one per configuration). Empty nodes are returned by indexers when a real node with specified name does not exist
(Inherited from Configuration.)
Public propertyEnvironmentVarResolver
References variable resolver. If this property is not set then default Windows environment var resolver is used
(Inherited from Configuration.)
Public propertyInhibitSlashArg
When true, disregards '/' as an argument delimiter
Public propertyIsReadOnly
Indicates whether configuration is readonly or may be modified and saved
(Overrides Configuration IsReadOnly.)
Public propertyMacroRunner
References macro runner. If this property is not set then default macro runner is used
(Inherited from Configuration.)
Public propertyMacroRunnerContext
Gets/sets an object passed by the framework into MacroRunner.Run() method. This property is auto-set for classes decorated with [ConfigMacroContext] attribute
(Inherited from Configuration.)
Public propertyRoot
Accesses root section configuration node
(Inherited from Configuration.)
Public propertyStrictNames
Determines whether exception is thrown when configuration node name contains inappropriate chars for particular configuration type. For example, for XMLConfiguration node names may not have spaces and other separator chars. When StrictNames is false then particular configurations may replace incompatible chars in node names with neutral ones (i.e. "my value"->"my-value" in case of XMLConfiguration).
(Inherited from Configuration.)
Public propertyVariable_END
Variable end tag
(Inherited from Configuration.)
Public propertyVariable_ENV_MOD
Variable environment modifier
(Inherited from Configuration.)
Public propertyVariable_ESCAPE
Variable escape tag
(Inherited from Configuration.)
Public propertyVariable_MACRO_START
Variable get clause modifier
(Inherited from Configuration.)
Public propertyVariable_PATH_MOD
Variable path modifier
(Inherited from Configuration.)
Public propertyVariable_START
Variable start tag
(Inherited from Configuration.)
Back to Top
See Also