Click or drag to resize

StatusDashboard Class

Represents a ConfigurationDomain's status dashboard. Combines various pieces of content and generates a well formed html element containing it.
Inheritance Hierarchy
SystemObject
  MFiles.VAF.Configuration.Domain.DashboardsStatusDashboard

Namespace:  MFiles.VAF.Configuration.Domain.Dashboards
Assembly:  MFiles.VAF.Configuration (in MFiles.VAF.Configuration.dll) Version: 2.1.0.1 (2.1.0.1)
Syntax
C#
public class StatusDashboard

The StatusDashboard type exposes the following members.

Constructors
  NameDescription
Public methodStatusDashboard
Constructor.
Top
Properties
  NameDescription
Public propertyContents
The contents of the dashboard. Will be rendered in order.
Public propertyRefreshInterval
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.
Public propertyShowUserErrors
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.
Public propertyUpdateCommand
The id of a domain command to call to trigger dashboard updates at the defined RefreshInterval.
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 methodGenerate
Generates an XML document from the current dashboard contents.
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
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 methodToString
Generates an html string representing the current dashboard contents.
(Overrides ObjectToString.)
Top
Extension Methods
  NameDescription
Public Extension MethodAddContent(FormattableString)Overloaded.
Inserts html content into a dashboard.
(Defined by StatusDashboardContentExtensionMethods.)
Public Extension MethodAddContent(IDashboardContent)Overloaded.
Inserts html content into a dashboard.
(Defined by StatusDashboardContentExtensionMethods.)
Top
See Also