Click or drag to resize

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.
Inheritance Hierarchy

Namespace:  MFiles.VAF.AdminConfigurations
Assembly:  MFiles.VAF (in MFiles.VAF.dll) Version: 2.1.0.1 (2.1.0.1)
Syntax
C#
public class DashboardNode : ConfigurationDomainNode

The DashboardNode type exposes the following members.

Constructors
  NameDescription
Public methodDashboardNode
Creates new dashboard node.
Top
Properties
  NameDescription
Public propertyDashboardGenerator
Function to generate html content for the dashboard in M-Files Admin.
Public propertyName
Name of the node. Must be unique for root level nodes.
Public propertySubNodes
Subnodes of this node. Visible in the tree view in M-Files Admin.
Top
Methods
  NameDescription
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
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 methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
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 methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodSaveConfiguration
Saves a new configuration value for the node. Only safe to call if GetCapabilities returns the Configuration flag.
(Inherited from ConfigurationDomainNode.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
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