Back to API Home

The DashboardDefinition type exposes the following members.

Methods

  NameDescription
Public methodClone
Clones this instance. This is necessary when you want to display the same dashboard in two different viewers, as the dashboard carries references to the UI elements and will cause an exception otherwise.
Public methodStatic memberGetAsync(Guid, OnCompleted<(Of <<'(DashboardDefinition>)>>))
Retrieves an instance of the DashboardDefinition class specified by its ID for editing.
Public methodStatic memberGetAsync(Guid, Boolean, OnCompleted<(Of <<'(DashboardDefinition>)>>))
Retrieves an instance of the DashboardDefinition class specified by its ID.
Public methodGetParentViewerId
Gets the parent viewer Id.
Public methodSetParentViewerId
Sets the parent viewer Id.

Properties

  NameDescription
Public propertyBusinessObjectType
Gets the type of the business object.
(Inherited from BusinessObjectBase.)
Public propertyDashboardContent
Gets the content of the dashboard that is used by the viewer/designer to actually display the dashboard.
Public propertyDashboardSerializationException
Gets the dashboard serialization exception. This will be null unless the content failed to de-serialize, in which case it will carry the de-serializer exception.
Public propertyDataCacheClientDuration
Gets or sets the client data cache duration.
(Inherited from BusinessObjectBase.)
Public propertyDataCacheClientPreviewEnabled
Gets or sets a value indicating whether client data cache is used during preview.
(Inherited from BusinessObjectBase.)
Public propertyDataCacheClientViewEnabled
Gets or sets a value indicating whether client data cache is used during view.
(Inherited from BusinessObjectBase.)
Public propertyDataCacheServerDuration
Gets or sets the server data cache duration.
(Inherited from BusinessObjectBase.)
Public propertyDataCacheServerPreviewEnabled
Gets or sets a value indicating whether server data cache is used during preview.
(Inherited from BusinessObjectBase.)
Public propertyDataCacheServerViewEnabled
Gets or sets a value indicating whether server data cache is used during view.
(Inherited from BusinessObjectBase.)
Public propertyDescription
Gets or sets the object's description.
(Inherited from BusinessObjectBase.)
Public propertyFileType
Gets the entry type of the object.
(Inherited from BusinessObjectBase.)
Public propertyFullName
Gets the object's fully qualified name.
(Inherited from BusinessObjectBase.)
Public propertyId
Gets the object's ID.
(Inherited from BusinessObjectBase.)
Public propertyInstanceId
Gets the instance id. This is a unique Id that is unique to this particular instance of the dashboard.
Public propertyIsAnalytical
Gets a value indicating whether this instance is an analytical dashboard.
Public propertyIsCheckedOut
Gets a value indicating whether this instance is checked out.
(Inherited from BusinessObjectBase.)
Public propertyIsDashBlock
Gets a value indicating whether this instance is a DashBlock.
Public propertyIsNeverCheckedIn
Gets a value indicating whether this instance is never checked in.
(Inherited from BusinessObjectBase.)
Public propertyIsStub
Gets or sets the object stubbing status.
(Inherited from BusinessObjectBase.)
Public propertyIsTemplate
Gets a value indicating whether this instance is a dashboard template.
Public propertyKeyValues
Gets the key value pairs.
(Inherited from BusinessObjectBase.)
Public propertyMoreInfoUri
Gets or sets the dashboard's "more information" URI.
(Inherited from BusinessObjectBase.)
Public propertyName
Gets or sets the object's name.
(Inherited from BusinessObjectBase.)
Public propertyPerformanceMonitor
The performance measurements monitor.

Events

  NameDescription
Public eventPropertyChanged
Occurs when a property value changes.
(Inherited from BusinessObjectBase.)

See Also