DashboardNode Class

A configuration node without configuration. Can be used as top node for multiple subnodes or just to show dashboard content in M-Files Admin.

Definition

Namespace: MFiles.VAF.AdminConfigurations
Assembly: MFiles.VAF (in MFiles.VAF.dll) Version: 24.1.706.1
C#
public class DashboardNode : ConfigurationDomainNode
Inheritance
Object    ConfigurationDomainNode    DashboardNode
Derived

Constructors

DashboardNode Creates new dashboard node.

Properties

DashboardGenerator Function to generate html content for the dashboard in M-Files Admin.
Name Name of the node. Must be unique for root level nodes.
SubNodes Subnodes of this node. Visible in the tree view in M-Files Admin.

Methods

GetCapabilities Describes the capabilities this node has. The capabilities returned correspond to which interface methods are implemented/ok to call.
(Overrides ConfigurationDomainNodeGetCapabilities)
GetCommands 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)
GetConfiguration Gets the current/stored configuration value for the node. Only safe to call if GetCapabilities returns the Configuration flag.
(Inherited from ConfigurationDomainNode)
GetConfigurationSchema Gets the schema describing the structure of the configuration. Only safe to call if GetCapabilities returns the Schema flag.
(Inherited from ConfigurationDomainNode)
GetDashboardContent 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))
GetDescription Provides a description of the domain. Currently displayed in the domain header area, and in some default dashboards.
(Inherited from ConfigurationDomainNode)
GetID 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)
GetName Gets the human readable name for the domain. Can be localized.
(Overrides ConfigurationDomainNodeGetName(IConfigurationRequestContext))
GetSortPriority Controls the order in which the node appears amongst siblings.
(Inherited from ConfigurationDomainNode)
GetStatusSummary Provides a status summary for the node. Only safe to call if GetCapabilities returns the StatusSummary flag.
(Inherited from ConfigurationDomainNode)
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.
(Overrides ConfigurationDomainNodeGetSubDomainNodes(IConfigurationRequestContext))
SaveConfiguration Saves a new configuration value for the node. Only safe to call if GetCapabilities returns the Configuration flag.
(Inherited from ConfigurationDomainNode)
Validate Validates the node along with the current, or passed configuration text. Only safe to call if GetCapabilities returns the Validation flag.
(Inherited from ConfigurationDomainNode)

See Also