[This is preliminary documentation and is subject to change.]
The Configuration type exposes the following members.Constructors
Name | Description | |
---|---|---|
![]() | Configuration | Initializes a new instance of the Configuration class |
Methods
Name | Description | |
---|---|---|
![]() | AdjustNodeName |
Override to perform transforms on node names so they become suitable for particular configuration type
|
![]() | CheckAndAdjustNodeName |
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
|
![]() | Clone |
Implements IClonable by returning new MemoryConfiguration clone
|
![]() | Clone(Configuration) |
Creates a deep copy of this configuration into newInstance which was allocated externally
|
![]() | Clone T |
Creates a deep copy of this configuration into new instance of T
|
![]() | Create |
Creates new configuration - creates new configuration root with optional name parameter
|
![]() | CreateFromMerge |
Creates new configuration from ordered merge result of two other nodes - base and override which can be from different configurations
|
![]() | CreateFromNode |
Creates new configuration from other node, which may belong to a different configuration instance
|
![]() | Destroy |
Erases all config data
|
![]() | ![]() | Determines whether the specified object is equal to the current object. (Inherited from ![]() |
![]() | ![]() | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from ![]() |
![]() | ![]() | Serves as the default hash function. (Inherited from ![]() |
![]() | ![]() | Gets the (Inherited from ![]() ![]() |
![]() | Include |
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
|
![]() | ![]() | Creates a shallow copy of the current (Inherited from ![]() ![]() |
![]() ![]() | NewEmptyRoot |
Creates a new empty config root based on laconic format
|
![]() ![]() | ProviderLoadFromAnySupportedFormatFile |
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
|
![]() ![]() | ProviderLoadFromFile |
Loads the contents of the supplied file name in an appropriate configuration provider implementation for the supplied extension format
|
![]() ![]() | ProviderLoadFromString |
Loads the supplied string content in the specified format, which may be format name like "xml" or "laconfig" with or without extension period
|
![]() | Refresh |
Re-reads configuration from source
|
![]() | ResolveEnvironmentVar |
Resolves variable name into its value
|
![]() | RunMacro |
Runs macro and returns its value
|
![]() | Save |
Saves configuration to source
|
![]() | ToConfigurationJSONDataMap |
Returns this config as JSON data map suitable for making JSONConfiguration
|
![]() | ToLaconicFile |
Serializes configuration tree into Laconic format and writes it into a file
|
![]() | ToLaconicStream |
Serializes configuration tree into Laconic format and writes it into stream
|
![]() | ToLaconicString |
Serializes configuration tree into Laconic format and returns it as a string
|
![]() | ![]() | Returns a string that represents the current object. (Inherited from ![]() |
Extension Methods
Fields
Name | Description | |
---|---|---|
![]() ![]() | CONFIG_INCLUDE_PRAGMA_FILE_ATTR | |
![]() ![]() | CONFIG_INCLUDE_PRAGMA_FS_SECTION | |
![]() ![]() | CONFIG_INCLUDE_PRAGMA_PROVIDER_SECTION | |
![]() ![]() | CONFIG_INCLUDE_PRAGMA_REQUIRED_ATTR | |
![]() ![]() | CONFIG_INCLUDE_PRAGMA_SESSION_SECTION | |
![]() ![]() | CONFIG_LACONIC_FORMAT | |
![]() ![]() | CONFIG_NAME_ATTR | |
![]() ![]() | CONFIG_ORDER_ATTR | |
![]() ![]() | DEFAULT_CONFIG_INCLUDE_PRAGMA | |
![]() ![]() | DEFAULT_VAR_END | |
![]() ![]() | DEFAULT_VAR_ENV_MOD | |
![]() ![]() | DEFAULT_VAR_ESCAPE | |
![]() ![]() | DEFAULT_VAR_MACRO_START | |
![]() ![]() | DEFAULT_VAR_PATH_MOD | |
![]() ![]() | DEFAULT_VAR_START | |
![]() | m_EmptyAttrNode | |
![]() | m_EmptySectionNode | |
![]() | m_Root | |
![]() ![]() | ProcesswideConfigNodeProviderType |
Gets/sets global implementor of IConfigNodeProvider that is used by all configurations in this process instance
when type is not specified
|
![]() ![]() | ProcesswideEnvironmentVarResolver |
Gets/sets global Environment variable resolver that is used by all configurations in this process instance
|
Properties
Name | Description | |
---|---|---|
![]() ![]() | AllSupportedFormats |
Returns all configuration file formats (file extensions without '.') supported
by ProviderLoadFromFile/ProviderLoadFromAnySupportedFormatFile/ProviderLoadFromString
|
![]() | ContentView |
Primarily used for debugging - returns the content of the configuration as text in the pretty-printed Laconic format
|
![]() | EmptyAttr |
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
|
![]() | EmptySection |
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
|
![]() | EnvironmentVarResolver |
References variable resolver. If this property is not set then default Windows environment var resolver is used
|
![]() | IsReadOnly |
Indicates whether configuration is read-only
|
![]() | MacroRunner |
References macro runner. If this property is not set then default macro runner is used
|
![]() | MacroRunnerContext |
Gets/sets an object passed by the framework into MacroRunner.Run() method.
This property is auto-set for classes decorated with [ConfigMacroContext] attribute
|
![]() | Root |
Accesses root section configuration node
|
![]() | StrictNames |
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).
|
![]() | Variable_END |
Variable end tag
|
![]() | Variable_ENV_MOD |
Variable environment modifier
|
![]() | Variable_ESCAPE |
Variable escape tag
|
![]() | Variable_MACRO_START |
Variable get clause modifier
|
![]() | Variable_PATH_MOD |
Variable path modifier
|
![]() | Variable_START |
Variable start tag
|
See Also