Configuration MembersNFX Class Library

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

The Configuration type exposes the following members.
Constructors

  NameDescription
Protected methodConfiguration
Initializes a new instance of the Configuration class
Back to Top
Methods

  NameDescription
Protected methodAdjustNodeName
Override to perform transforms on node names so they become suitable for particular configuration type
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
Public methodClone 
Implements IClonable by returning new MemoryConfiguration clone
Public methodClone(Configuration)
Creates a deep copy of this configuration into newInstance which was allocated externally
Public methodClone T  
Creates a deep copy of this configuration into new instance of T
Public methodCreate
Creates new configuration - creates new configuration root with optional name parameter
Public methodCreateFromMerge
Creates new configuration from ordered merge result of two other nodes - base and override which can be from different configurations
Public methodCreateFromNode
Creates new configuration from other node, which may belong to a different configuration instance
Public methodDestroy
Erases all config data
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
Protected methodOnlineMemberwiseClone
Creates a shallow copy of the current OnlineObject.
(Inherited from OnlineObject.)
Public methodStatic memberNewEmptyRoot
Creates a new empty config root based on laconic format
Public methodStatic memberProviderLoadFromAnySupportedFormatFile
Loads the contents of the supplied file name without format extension trying to match any of the supported format extensions. When match is found the file is loaded via an appropriate configuration provider
Public methodStatic memberProviderLoadFromFile
Loads the contents of the supplied file name in an appropriate configuration provider implementation for the supplied extension format
Public methodStatic memberProviderLoadFromString
Loads the supplied string content in the specified format, which may be format name like "xml" or "laconfig" with or without extension period
Public methodRefresh
Re-reads configuration from source
Public methodResolveEnvironmentVar
Resolves variable name into its value
Public methodRunMacro
Runs macro and returns its value
Public methodSave
Saves configuration to source
Public methodToConfigurationJSONDataMap
Returns this config as JSON data map suitable for making JSONConfiguration
Public methodToLaconicFile
Serializes configuration tree into Laconic format and writes it into a file
Public methodToLaconicStream
Serializes configuration tree into Laconic format and writes it into stream
Public methodToLaconicString
Serializes configuration tree into Laconic format and returns it as a string
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 memberCONFIG_INCLUDE_PRAGMA_FILE_ATTR
Public fieldStatic memberCONFIG_INCLUDE_PRAGMA_FS_SECTION
Public fieldStatic memberCONFIG_INCLUDE_PRAGMA_PROVIDER_SECTION
Public fieldStatic memberCONFIG_INCLUDE_PRAGMA_REQUIRED_ATTR
Public fieldStatic memberCONFIG_INCLUDE_PRAGMA_SESSION_SECTION
Public fieldStatic memberCONFIG_LACONIC_FORMAT
Public fieldStatic memberCONFIG_NAME_ATTR
Public fieldStatic memberCONFIG_ORDER_ATTR
Public fieldStatic memberDEFAULT_CONFIG_INCLUDE_PRAGMA
Public fieldStatic memberDEFAULT_VAR_END
Public fieldStatic memberDEFAULT_VAR_ENV_MOD
Public fieldStatic memberDEFAULT_VAR_ESCAPE
Public fieldStatic memberDEFAULT_VAR_MACRO_START
Public fieldStatic memberDEFAULT_VAR_PATH_MOD
Public fieldStatic memberDEFAULT_VAR_START
Protected fieldm_EmptyAttrNode
Protected fieldm_EmptySectionNode
Protected fieldm_Root
Public fieldStatic memberProcesswideConfigNodeProviderType
Gets/sets global implementor of IConfigNodeProvider that is used by all configurations in this process instance when type is not specified
Public fieldStatic memberProcesswideEnvironmentVarResolver
Gets/sets global Environment variable resolver that is used by all configurations in this process instance
Back to Top
Properties

  NameDescription
Public propertyStatic memberAllSupportedFormats
Returns all configuration file formats (file extensions without '.') supported by ProviderLoadFromFile/ProviderLoadFromAnySupportedFormatFile/ProviderLoadFromString
Public propertyContentView
Primarily used for debugging - returns the content of the configuration as text in the pretty-printed Laconic format
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
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
Public propertyEnvironmentVarResolver
References variable resolver. If this property is not set then default Windows environment var resolver is used
Public propertyIsReadOnly
Indicates whether configuration is read-only
Public propertyMacroRunner
References macro runner. If this property is not set then default macro runner is used
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
Public propertyRoot
Accesses root section configuration node
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).
Public propertyVariable_END
Variable end tag
Public propertyVariable_ENV_MOD
Variable environment modifier
Public propertyVariable_ESCAPE
Variable escape tag
Public propertyVariable_MACRO_START
Variable get clause modifier
Public propertyVariable_PATH_MOD
Variable path modifier
Public propertyVariable_START
Variable start tag
Back to Top
See Also