DashboardHelper Class

Dashboard creation helpers for the configurator.

Definition

Namespace: MFiles.VAF.Configuration.Domain.Dashboards
Assembly: MFiles.VAF.Configuration (in MFiles.VAF.Configuration.dll) Version: 23.12.13247.3
C#
public static class DashboardHelper
Inheritance
Object    DashboardHelper

Methods

AddClass Utility method for adding a class to an element. Concatenates the classname (separated by a space) to the class attribute if already defined.
AddRefreshContentBehavior Adds behavior to an xml element so that its content will refresh at the specified interval.
AddRunDomainCommandBehavior Adds behavior to an xml element so that when clicked/activated, it triggers a domain command.
AddSelectNodeBehavior(DashboardCommand, String) Adds behavior to a command, so that when it is clicked/activated the configurator will navigate to the tree node at the nodePath specified.
AddSelectNodeBehavior(XmlElement, String) Adds behavior to an element, so that when it is clicked/activated the configurator will navigate to the tree node at the nodePath specified.
AddStyle Utility method for adding a style rule property/value to an element. Concatenates the style rule to the existing style attribute, if already defined.
CreateDomainCommand(ConfigurationDomainCommand) Converts a domain command into a dashboard command. When clicked/activated, the domain command will be triggered.
CreateDomainCommand(String, String, String) Converts a domain command into a dashboard command. When clicked/activated, the domain command will be triggered.
CreateDomainStatusDashboard Creates a generic dashboard based on a ConfigurationDomain definition.
CreateElement Creates an xml element and it's inner content from markup.
CreateFragment Creates an xml fragment from html markup.
CreateSelectConfigurationNodeCommand(String) Creates a command that when clicked/activated will navigate to a domain's configuration tree node in the configurator's navigation pane. Uses default configure label.
CreateSelectConfigurationNodeCommand(String, String) Creates a command that when clicked/activated will navigate to a domain's configuration tree node in the configurator's navigation pane.
CreateSelectDomainNodeCommand(ConfigurationDomain) Creates a command that when clicked/activated will navigate to a domain's tree node in the configurator's navigation pane.
CreateSelectDomainNodeCommand(String, String) Creates a command that when clicked/activated will navigate to a domain's tree node in the configurator's navigation pane.
CreateSubDomainListItem Creates a generic DashboardListItem based on a ConfigurationDomain.
FormatDashboardContentString In a fashion similar to String.Format() this takes a formatted string with positional placeholders, and replaces them with content generated from the IDashboardContent item at the corresponding position.
GetConfigurationPath Resolves the path to a domain's configuration node.
GetStatusIconClass Resolves the class name to use for a status value.
ImageFileToDataUri Converts an image file's content into a base64 encoded data uri.
ToParagraphs Converts a raw text value to html paragraphs, splitting the content by new lines.
ToXmlFragment Converts an IDashboardContent to an xml fragment in an undefined xml document.
ToXmlString Converts an IDashboardContent to a string.

See Also