Click or drag to resize

DashboardNode Methods

The DashboardNode type exposes the following members.

Methods
  NameDescription
Public methodGetCapabilities
Describes the capabilities this node has. The capabilities returned correspond to which interface methods are implemented/ok to call.
(Overrides ConfigurationDomainNodeGetCapabilities.)
Public methodGetCommands
Provides the commands that can be shown and/or run for this node. Only safe to call if GetCapabilities returns the Commands flag.
(Inherited from ConfigurationDomainNode.)
Public methodGetConfiguration
Gets the current/stored configuration value for the node. Only safe to call if GetCapabilities returns the Configuration flag.
(Inherited from ConfigurationDomainNode.)
Public methodGetConfigurationSchema
Gets the schema describing the structure of the configuration. Only safe to call if GetCapabilities returns the Schema flag.
(Inherited from ConfigurationDomainNode.)
Public methodGetDashboardContent
Provides the html for a custom dashboard to display for the node. Only safe to call if GetCapabilities returns the StatusDashboard flag.
(Overrides ConfigurationDomainNodeGetDashboardContent(IConfigurationRequestContext).)
Public methodGetDescription
Provides a description of the domain. Currently displayed in the domain header area, and in some default dashboards.
(Inherited from ConfigurationDomainNode.)
Public methodGetID
Provides the static id for the node. This value should at least be unique amongst siblings. IDs cannot have spaces, newlines or periods.
(Overrides ConfigurationDomainNodeGetID.)
Public methodGetName
Gets the human readable name for the domain. Can be localized.
(Overrides ConfigurationDomainNodeGetName(IConfigurationRequestContext).)
Public methodGetSortPriority
Controls the order in which the node appears amongst siblings.
(Inherited from ConfigurationDomainNode.)
Public methodGetStatusSummary
Provides a status summary for the node. Only safe to call if GetCapabilities returns the StatusSummary flag.
(Inherited from ConfigurationDomainNode.)
Public methodGetSubDomainNodes
Provides a list of sub domain nodes to appear as children of this node. Only safe to call if GetCapabilities returns the SubDomains flag.
(Overrides ConfigurationDomainNodeGetSubDomainNodes(IConfigurationRequestContext).)
Public methodSaveConfiguration
Saves a new configuration value for the node. Only safe to call if GetCapabilities returns the Configuration flag.
(Inherited from ConfigurationDomainNode.)
Public methodValidate
Validates the node along with the current, or passed configuration text. Only safe to call if GetCapabilities returns the Validation flag.
(Inherited from ConfigurationDomainNode.)
Top
See Also