Click or drag to resize

ConfigurationNodeTConfig Class

A configuration node with actual configuration values.
Inheritance Hierarchy
SystemObject
  MFiles.VAF.Configuration.AdminConfigurationsConfigurationDomainNode
    MFiles.VAF.AdminConfigurationsDashboardNode
      MFiles.VAF.AdminConfigurationsConfigurationNodeTConfig

Namespace:  MFiles.VAF.AdminConfigurations
Assembly:  MFiles.VAF (in MFiles.VAF.dll) Version: 2.1.0.1 (2.1.0.1)
Syntax
C#
public class ConfigurationNode<TConfig> : DashboardNode
where TConfig : class, new()

Type Parameters

TConfig
The configuration type.

The ConfigurationNodeTConfig type exposes the following members.

Constructors
Properties
  NameDescription
Public propertyConfigSource
The named value source used as the save location for the configuration.
Public propertyCurrentConfiguration
The current configuration.
Public propertyCurrentConfigurationAndValidation Obsolete.
Current configuration and the related validation results.
Public propertyCurrentValidationResults
The current configuration's validation results.
Public propertyDashboardGenerator
Function to generate html content for the dashboard in M-Files Admin.
(Inherited from DashboardNode.)
Public propertyName
Name of the node. Must be unique for root level nodes.
(Inherited from DashboardNode.)
Public propertySubNodes
Subnodes of this node. Visible in the tree view in M-Files Admin.
(Inherited from DashboardNode.)
Public propertyValidator
The validator function to perform custom server side validation to the configured values.
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 DashboardNodeGetCapabilities.)
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.
(Overrides ConfigurationDomainNodeGetConfiguration(IConfigurationRequestContext).)
Public methodGetConfigurationSchema
Gets the schema describing the structure of the configuration. Only safe to call if GetCapabilities returns the Schema flag.
(Overrides ConfigurationDomainNodeGetConfigurationSchema(IConfigurationRequestContext).)
Public methodGetDashboardContent
Provides the html for a custom dashboard to display for the node. Only safe to call if GetCapabilities returns the StatusDashboard flag.
(Inherited from DashboardNode.)
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.
(Inherited from DashboardNode.)
Public methodGetName
Gets the human readable name for the domain. Can be localized.
(Inherited from DashboardNode.)
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.
(Inherited from DashboardNode.)
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 methodRunDefaultValidation
Validates a configuration.
Public methodSaveConfiguration
Saves a new configuration value for the node. Only safe to call if GetCapabilities returns the Configuration flag.
(Overrides ConfigurationDomainNodeSaveConfiguration(IConfigurationRequestContext, String, ClientOperations).)
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.
(Overrides ConfigurationDomainNodeValidate(IConfigurationRequestContext, String).)
Top
Events
  NameDescription
Public eventChanged
Triggered when the configuration changes.
Top
See Also