ConfigurationDomainNode Class |
Namespace: MFiles.VAF.Configuration.AdminConfigurations
The ConfigurationDomainNode type exposes the following members.
Name | Description | |
---|---|---|
![]() | ConfigurationDomainNode | Initializes a new instance of the ConfigurationDomainNode class |
Name | Description | |
---|---|---|
![]() | GetCapabilities |
Describes the capabilities this node has.
The capabilities returned correspond to which
interface methods are implemented/ok to call.
|
![]() | GetCommands |
Provides the commands that can be shown and/or run for this node.
Only safe to call if GetCapabilities returns the
Commands flag.
|
![]() | GetConfiguration |
Gets the current/stored configuration value for the node.
Only safe to call if GetCapabilities returns the
Configuration flag.
|
![]() | GetConfigurationSchema |
Gets the schema describing the structure of the configuration.
Only safe to call if GetCapabilities returns the
Schema flag.
|
![]() | GetDashboardContent |
Provides the html for a custom dashboard to display for the node.
Only safe to call if GetCapabilities returns the
StatusDashboard flag.
|
![]() | GetDescription |
Provides a description of the domain.
Currently displayed in the domain header area, and in some
default dashboards.
|
![]() | GetID |
Provides the static id for the node.
This value should at least be unique amongst siblings.
IDs cannot have spaces, newlines or periods.
|
![]() | GetName |
Gets the human readable name for the domain.
Can be localized.
|
![]() | GetSortPriority |
Controls the order in which the node appears amongst siblings.
|
![]() | GetStatusSummary |
Provides a status summary for the node.
Only safe to call if GetCapabilities returns the
StatusSummary flag.
|
![]() | GetSubDomainNodes |
Provides a list of sub domain nodes to appear as children of this node.
Only safe to call if GetCapabilities returns the
SubDomains flag.
|
![]() | SaveConfiguration |
Saves a new configuration value for the node.
Only safe to call if GetCapabilities returns the
Configuration flag.
|
![]() | Validate |
Validates the node along with the current, or passed configuration text.
Only safe to call if GetCapabilities returns the
Validation flag.
|
Name | Description | |
---|---|---|
![]() | AssertCapable |
Throws an exception if a node does not support a certain capability.
(Defined by ConfigurationDomainNodeExtensionMethods.) |
![]() | IsCapable |
Determines whether a node supports a certain capability.
Capabilities correspond to interface methods that are
valid to call on a node.
(Defined by ConfigurationDomainNodeExtensionMethods.) |