Click or drag to resize

DashboardPanel Class

Represents a simple panel in a StatusDashboard.
Inheritance Hierarchy
SystemObject
  MFiles.VAF.Configuration.Domain.DashboardsDashboardPanel

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 DashboardPanel : IDashboardContent

The DashboardPanel type exposes the following members.

Constructors
  NameDescription
Public methodDashboardPanel
Constructor.
Top
Properties
  NameDescription
Public propertyBackground
Controls the panel background color.
Public propertyCommands
The top-level commands to show for the panel (optional).
Public propertyIcon
The primary icon to show in the panel (optional). Should resolve to a file on either the server or client configurator app.
Public propertyID
The id of the panel. Optional. Will appear in the html output, so the panel can be referenced.
Public propertyInnerContent
The panel content (optional).
Public propertyStatusSummary
The status of the panel (optional). If specified, rendered as a StatusStub.
Public propertyTitle
The title of the panel (optional).
Public propertyTreePath
The domain tree path this list item represents (optional). If specified, the title will become a link that navigates to the tree node at the path in the configurator's navigation pane.
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 the panel content as xml.
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
Returns a string that represents the current object.
(Inherited from Object.)
Top
Extension Methods
  NameDescription
Public Extension MethodSetInnerContent
Sets the inner html content of a panel
(Defined by StatusDashboardContentExtensionMethods.)
Public Extension MethodToXmlFragment
Converts an IDashboardContent to an xml fragment in an undefined xml document.
(Defined by DashboardHelper.)
Public Extension MethodToXmlString
Converts an IDashboardContent to a string.
(Defined by DashboardHelper.)
Top
See Also