[This is preliminary documentation and is subject to change.]
The FileConfiguration type exposes the following members.Constructors
Name | Description | |
---|---|---|
![]() | FileConfiguration |
Creates an instance of a new configuration not bound to any file
|
![]() | FileConfiguration(String) |
Creates an isntance of configuration and reads contents from the file
|
Methods
Name | Description | |
---|---|---|
![]() | AdjustNodeName |
Override to perform transforms on node names so they become suitable for particular configuration type
(Inherited from Configuration.) |
![]() | 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
(Inherited from Configuration.) |
![]() | Clone(Configuration) |
Creates a deep copy of this configuration into newInstance which was allocated externally
(Inherited from Configuration.) |
![]() | Clone T |
Creates a deep copy of this configuration into new instance of T
(Inherited from Configuration.) |
![]() | Create |
Creates new configuration - creates new configuration root with optional name parameter
(Inherited from Configuration.) |
![]() | CreateFromMerge |
Creates new configuration from ordered merge result of two other nodes - base and override which can be from different configurations
(Inherited from Configuration.) |
![]() | CreateFromNode |
Creates new configuration from other node, which may belong to a different configuration instance
(Inherited from Configuration.) |
![]() | Destroy |
Erases all config data
(Inherited from Configuration.) |
![]() | ![]() | 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
(Inherited from Configuration.) |
![]() | ![]() | Creates a shallow copy of the current (Inherited from ![]() ![]() |
![]() | Refresh |
Re-reads configuration from source
(Inherited from Configuration.) |
![]() | ResolveEnvironmentVar |
Resolves variable name into its value
(Inherited from Configuration.) |
![]() | RunMacro |
Runs macro and returns its value
(Inherited from Configuration.) |
![]() | Save |
Saves configuration to source
(Inherited from Configuration.) |
![]() | SaveAs |
Saves configuration into specified file
|
![]() | SetReadOnly | |
![]() | ToConfigurationJSONDataMap |
Returns this config as JSON data map suitable for making JSONConfiguration
(Inherited from Configuration.) |
![]() | ToLaconicFile |
Serializes configuration tree into Laconic format and writes it into a file
(Inherited from Configuration.) |
![]() | ToLaconicStream |
Serializes configuration tree into Laconic format and writes it into stream
(Inherited from Configuration.) |
![]() | ToLaconicString |
Serializes configuration tree into Laconic format and returns it as a string
(Inherited from Configuration.) |
![]() | ![]() | Returns a string that represents the current object. (Inherited from ![]() |
Extension Methods
Fields
Name | Description | |
---|---|---|
![]() | m_EmptyAttrNode | (Inherited from Configuration.) |
![]() | m_EmptySectionNode | (Inherited from Configuration.) |
![]() | m_FileName | |
![]() | m_Root | (Inherited from Configuration.) |
Properties
Name | Description | |
---|---|---|
![]() | ContentView |
Primarily used for debugging - returns the content of the configuration as text in the pretty-printed Laconic format
(Inherited from Configuration.) |
![]() | 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
(Inherited from Configuration.) |
![]() | 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
(Inherited from Configuration.) |
![]() | EnvironmentVarResolver |
References variable resolver. If this property is not set then default Windows environment var resolver is used
(Inherited from Configuration.) |
![]() | FileName | |
![]() | IsReadOnly |
Indicates whether configuration is readonly or may be modified and saved
(Overrides Configuration IsReadOnly.) |
![]() | MacroRunner |
References macro runner. If this property is not set then default macro runner is used
(Inherited from Configuration.) |
![]() | MacroRunnerContext |
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.) |
![]() | Root |
Accesses root section configuration node
(Inherited from Configuration.) |
![]() | 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).
(Inherited from Configuration.) |
![]() | Variable_END |
Variable end tag
(Inherited from Configuration.) |
![]() | Variable_ENV_MOD |
Variable environment modifier
(Inherited from Configuration.) |
![]() | Variable_ESCAPE |
Variable escape tag
(Inherited from Configuration.) |
![]() | Variable_MACRO_START |
Variable get clause modifier
(Inherited from Configuration.) |
![]() | Variable_PATH_MOD |
Variable path modifier
(Inherited from Configuration.) |
![]() | Variable_START |
Variable start tag
(Inherited from Configuration.) |
See Also