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.3.623.2

Syntax

C++

Copy

public class ConfigurationNode<TConfig> : DashboardNode
where TConfig : class, new()

Public Class ConfigurationNode(Of TConfig As {Class, New})
	Inherits DashboardNode

generic<typename TConfig>
where TConfig : ref class, gcnew()
public ref class ConfigurationNode : public DashboardNode

Type Parameters

TConfig: The configuration type.

The ConfigurationNodeTConfig type exposes the following members.

Constructors

	Name	Description
	ConfigurationNodeTConfig	Creates a new configuration node.

Top

Properties

	Name	Description
	ConfigSource	The named value source used as the save location for the configuration.
	CurrentConfiguration	The current configuration.
	CurrentConfigurationAndValidation	Current configuration and the related validation results.
	CurrentValidationResults	The current configuration's validation results.
	DashboardGenerator	Function to generate html content for the dashboard in M-Files Admin. (Inherited from DashboardNode.)
	Name	Name of the node. Must be unique for root level nodes. (Inherited from DashboardNode.)
	SubNodes	Subnodes of this node. Visible in the tree view in M-Files Admin. (Inherited from DashboardNode.)
	Validator	The validator function to perform custom server side validation to the configured values.

Top

Methods

	Name	Description
	GetCapabilities	Describes the capabilities this node has. The capabilities returned correspond to which interface methods are implemented/ok to call. (Overrides DashboardNodeGetCapabilities.)
	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. (Overrides ConfigurationDomainNodeGetConfiguration(IConfigurationRequestContext).)
	GetConfigurationSchema	Gets the schema describing the structure of the configuration. Only safe to call if GetCapabilities returns the Schema flag. (Overrides ConfigurationDomainNodeGetConfigurationSchema(IConfigurationRequestContext).)
	GetDashboardContent	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.)
	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. (Inherited from DashboardNode.)
	GetName	Gets the human readable name for the domain. Can be localized. (Inherited from DashboardNode.)
	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. (Inherited from DashboardNode.)
	RunDefaultValidation	Validates a configuration.
	SaveConfiguration	Saves a new configuration value for the node. Only safe to call if GetCapabilities returns the Configuration flag. (Overrides ConfigurationDomainNodeSaveConfiguration(IConfigurationRequestContext, String, ClientOperations).)
	Validate	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

	Name	Description
	Changed	Triggered when the configuration changes.

Top

Reference

MFiles.VAF.AdminConfigurations Namespace

ConfigurationNodeAddLanguageSpecificTextSet("LST78EBC252_0?cs=&lt;|vb=(Of |cpp=&lt;|fs=&lt;'|nu=(");TConfigAddLanguageSpecificTextSet("LST78EBC252_1?cs=&gt;|vb=)|cpp=&gt;|fs=&gt;|nu=)"); Class

Type Parameters

Reference

ConfigurationNodeTConfig Class