StatusDashboard Class

Represents a ConfigurationDomain's status dashboard. Combines various pieces of content and generates a well formed html element containing it.

Definition

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

Constructors

StatusDashboard Constructor.

Properties

Contents The contents of the dashboard. Will be rendered in order.
RefreshInterval The interval (in seconds) at which the client should refresh/update the dashboard. If an UpdateCommand is defined, it will be called to refresh the dashboard, otherwise the whole dashboard will be refreshed from the source defined in the domain. Value is ignored if less than 1. Low values should be used with caution.
ShowUserErrors Determines if dashboard update/refresh errors are shown to the user. Many transient errors can occur with updates if the vault or application is restarting so typically these are ignored.
UpdateCommand The id of a domain command to call to trigger dashboard updates at the defined RefreshInterval.

Methods

Generate Generates an XML document from the current dashboard contents.
ToString Generates an html string representing the current dashboard contents.
(Overrides ObjectToString)

Extension Methods

AddContent Inserts html content into a dashboard.
(Defined by StatusDashboardContentExtensionMethods)
AddContent Inserts html content into a dashboard.
(Defined by StatusDashboardContentExtensionMethods)

See Also