[This is preliminary documentation and is subject to change.]
The ConfigSectionNode type exposes the following members.Constructors
Name | Description | |
---|---|---|
![]() | ConfigSectionNode(Configuration, ConfigSectionNode) | Initializes a new instance of the ConfigSectionNode class |
![]() | ConfigSectionNode(Configuration, ConfigSectionNode, IConfigSectionNode) |
Performs deep clone copy from another node which can be in this or different configuration
|
![]() | ConfigSectionNode(Configuration, ConfigSectionNode, String, String) | Initializes a new instance of the ConfigSectionNode class |
Methods
Name | Description | |
---|---|---|
![]() | AddAttributeNode(String) | |
![]() | AddAttributeNode(String, Object) | |
![]() | AddAttributeNode(String, String) | |
![]() | AddChildNode(String) | |
![]() | AddChildNode(IConfigSectionNode) |
Adds a new child node into this one deeply cloning nodes data from some other node which may belong to a different conf instance
|
![]() | AddChildNode(String, Object) | |
![]() | AddChildNode(String, String) |
Adds a new child section node to this node
|
![]() | AddChildNodeFromMerge |
Adds a new section node to this configuration which is an ordered merge result of two other nodes - base and override.
|
![]() | AttrByIndex |
Returns attribute node by its index or empty attribute if real attribute with such index does not exist
|
![]() | AttrByName | |
![]() | AttrsToStringMap |
Returns attribute values as string map
|
![]() | checkCanModify | (Inherited from ConfigNode.) |
![]() | Delete |
Deletes this section from its parent
(Overrides ConfigNode Delete .) |
![]() | DeleteAllAttributes |
Deletes all attribute nodes from this node
|
![]() | DeleteAllChildren |
Deletes all child section nodes from this node
|
![]() | ![]() | Determines whether the specified object is equal to the current object. (Inherited from ![]() |
![]() | EvaluateValueVariables |
Evaluates a value string expanding all variables with var-paths relative to this node.
Evaluates configuration variables such as "$(varname)" or "$(@varname)". Varnames are paths
to other config nodes from the same configuration or variable names when prefixed with "~". If varname starts with "@" then it gets combined
with input as path string. "~" is used to qualify environment vars that get resolved through Configuration.EnvironmentVarResolver
Example: `....add key="Schema.$(/A/B/C/$attr)" value="$(@~HOME)bin\Transforms\"...`
|
![]() | ![]() | 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 | |
![]() | IsSameName(String) |
Returns true when another name is the same as this node's name per case-insensitive culture-neutral comparison
(Inherited from ConfigNode.) |
![]() | IsSameName(IConfigNode) |
Returns true when another node has the same name as this one per case-insensitive culture-neutral comparison
(Inherited from ConfigNode.) |
![]() | IsSameNameAttr(String) |
Returns true when another name is the same as this section "name" attribute per case-insensitive culture-neutral comparison
|
![]() | IsSameNameAttr(IConfigSectionNode) |
Returns true when another node has the attribute called 'name' and its value is the same as in this one per case-insensitive culture-neutral comparison
|
![]() | ![]() | Creates a shallow copy of the current (Inherited from ![]() ![]() |
![]() | MergeAttributes |
Merges attributes from another node into this one. Another node may belong to a different configuration instance
|
![]() | MergeSections |
Merges child sections from another node into this one. Another node may belong to a different configuration instance.
This method ignores override flags and merges nodes regardless
|
![]() | Navigate |
Navigates the path and return the appropriate node. Example: '!/nfx/logger/destination/$file-name'
|
![]() | NavigateSection |
Navigates the path and return the appropriate section node. Example '!/nfx/logger/destination'
|
![]() | OverrideBy |
Merges another node data by overriding this node's value/attributes/sub nodes according to rules.
|
![]() | ProcessIncludePragmas |
Replaces all include pragmas - sections with specified names ('_include' by default), with pointed to configuration file content
as obtained via the call to file system specified in every pragma.
If no FS specified then LocalFileSystem is used. If no file name specified when try to allocate config node provider.
Returns true if include pragmas were found.
Note: this method does not process new include pragmas that may have fetched during this call.
Caution: the file system used in the operation may rely on the App container that may need to be set-up for the call to succeed,
therefore calling this method before app has activated may fail, in such cases a temp app container may be set to get the config file
with processed includes, then the result may be passed to the primary app container ctor.
This call is not logically thread-safe, it must be called from the main thread in the app
|
![]() | ReplaceBy |
Completely replaces this node's attributes, value and children with data from another node
|
![]() | ResetModified |
Resets modification of this an all child nodes
(Overrides ConfigNode ResetModified .) |
![]() | ToConfigurationJSONDataMap |
Returns this config node as JSON data map suitable for making JSONConfiguration.
Contrast with ToJSONDataMap
|
![]() | ToJSONDataMap |
Converts this ConfigSectionNode to JSONDataMap. Contrast with ToConfigurationJSONDataMap
Be carefull: that this operation can "lose" data from ConfigSectionNode.
In other words some ConfigSectionNode information can not be reflected in corresponding JSONDataMap, for example
this method overwrites duplicate key names and does not support section values
|
![]() | ToJSONString |
Serializes configuration tree rooted at this node into JSON configuration format and returns it as a string
|
![]() | ToLaconicString |
Serializes configuration tree rooted at this node into Laconic format and returns it as a string
|
![]() | ToString | (Inherited from ConfigNode.) |
![]() | ValueAsBool | (Inherited from ConfigNode.) |
![]() | ValueAsByte | (Inherited from ConfigNode.) |
![]() | ValueAsByteArray | (Inherited from ConfigNode.) |
![]() | ValueAsDateTime | (Inherited from ConfigNode.) |
![]() | ValueAsDecimal | (Inherited from ConfigNode.) |
![]() | ValueAsDouble | (Inherited from ConfigNode.) |
![]() | ValueAsEnum TEnum | (Inherited from ConfigNode.) |
![]() | ValueAsFloat | (Inherited from ConfigNode.) |
![]() | ValueAsGDID | (Inherited from ConfigNode.) |
![]() | ValueAsGUID | (Inherited from ConfigNode.) |
![]() | ValueAsInt | (Inherited from ConfigNode.) |
![]() | ValueAsLong | (Inherited from ConfigNode.) |
![]() | ValueAsNullableBool | (Inherited from ConfigNode.) |
![]() | ValueAsNullableByte | (Inherited from ConfigNode.) |
![]() | ValueAsNullableDateTime | (Inherited from ConfigNode.) |
![]() | ValueAsNullableDecimal | (Inherited from ConfigNode.) |
![]() | ValueAsNullableDouble | (Inherited from ConfigNode.) |
![]() | ValueAsNullableEnum TEnum | (Inherited from ConfigNode.) |
![]() | ValueAsNullableFloat | (Inherited from ConfigNode.) |
![]() | ValueAsNullableGDID | (Inherited from ConfigNode.) |
![]() | ValueAsNullableGUID | (Inherited from ConfigNode.) |
![]() | ValueAsNullableInt | (Inherited from ConfigNode.) |
![]() | ValueAsNullableLong | (Inherited from ConfigNode.) |
![]() | ValueAsNullableSByte | (Inherited from ConfigNode.) |
![]() | ValueAsNullableShort | (Inherited from ConfigNode.) |
![]() | ValueAsNullableTimeSpan | (Inherited from ConfigNode.) |
![]() | ValueAsNullableUInt | (Inherited from ConfigNode.) |
![]() | ValueAsNullableULong | (Inherited from ConfigNode.) |
![]() | ValueAsNullableUShort | (Inherited from ConfigNode.) |
![]() | ValueAsSByte | (Inherited from ConfigNode.) |
![]() | ValueAsShort | (Inherited from ConfigNode.) |
![]() | ValueAsString | (Inherited from ConfigNode.) |
![]() | ValueAsTimeSpan | (Inherited from ConfigNode.) |
![]() | ValueAsType |
Tries to get value as specified type or throws if it can not be converted
(Inherited from ConfigNode.) |
![]() | ValueAsUInt | (Inherited from ConfigNode.) |
![]() | ValueAsULong | (Inherited from ConfigNode.) |
![]() | ValueAsUShort | (Inherited from ConfigNode.) |
Extension Methods
Fields
Name | Description | |
---|---|---|
![]() | __Empty | (Inherited from ConfigNode.) |
![]() | m_Attributes | |
![]() | m_Children | |
![]() | m_Configuration | (Inherited from ConfigNode.) |
![]() | m_Modified | (Inherited from ConfigNode.) |
![]() | m_Script_Bool_Condition_Result |
Internal field used for attaching temporary script state. do not use
|
![]() | m_Script_Statement |
Internal field used for attaching temporary script state. do not use
|
Properties
Name | Description | |
---|---|---|
![]() | AttrCount |
Returns number of child attribute nodes
|
![]() | Attributes |
Enumerates all attribute nodes
|
![]() | ChildCount |
Returns number of child section nodes
|
![]() | Children |
Enumerates all child nodes
|
![]() | Configuration |
References configuration this node is under
(Inherited from ConfigNode.) |
![]() | EvaluatedValue |
Returns null or value of this node with all variables evaluated
(Inherited from ConfigNode.) |
![]() | Exists |
Determines whether this node really exists in configuration or is just a sentinel empty node
(Inherited from ConfigNode.) |
![]() | HasAttributes |
Indicates whether this node has any associated attributes
|
![]() | HasChildren |
Indicates whether this node has any child section nodes
|
![]() | Item Int32 |
Retrieves section node by index or empty node instance if section node with such index could not be found
|
![]() | Item String |
Retrieves section node by names, from left to right until existing node is found.
If no existing node could be found then empty node instance is returned
|
![]() | Modified |
Indicates whether this or any child nodes or attributes were modified
(Overrides ConfigNode Modified.) |
![]() | Name |
Retrieves node name
(Inherited from ConfigNode.) |
![]() | Parent |
References parent node or Empty if this node has no parent
(Inherited from ConfigNode.) |
![]() | RootPath |
Returns path from root to this node
(Inherited from ConfigNode.) |
![]() | Value |
Retrieves node value or null. The value getter performs evaluation of variables, while setter sets the value verbatim
(Inherited from ConfigNode.) |
![]() | VerbatimValue |
Returns verbatim (without variable evaluation) node value or null
(Inherited from ConfigNode.) |
Explicit Interface Implementations
Name | Description | |
---|---|---|
![]() ![]() | IConfigNode Parent |
References parent node
(Inherited from ConfigNode.) |
![]() ![]() | IConfigNode RootPath | (Inherited from ConfigNode.) |
![]() ![]() | IConfigSectionNode AttrByIndex | |
![]() ![]() | IConfigSectionNode AttrByName | |
![]() ![]() | IConfigSectionNode Attributes | |
![]() ![]() | IConfigSectionNode Children | |
![]() ![]() | IConfigSectionNode Item Int32 | |
![]() ![]() | IConfigSectionNode Item String | |
![]() ![]() | IConfigSectionNode Navigate | |
![]() ![]() | IConfigSectionNode NavigateSection |
See Also