Back to API Home

The Viewer type exposes the following members.

Constructors

  NameDescription
Public methodViewer
Initializes a new instance of the Viewer class.

Methods

  NameDescription
Public methodAddDataError
Adds the data error to the viewer's registry of errors for this data visualization control.
Public methodClearAnnotationSelection
Clears the annotation selection for whatever element has any selected item in this viewer.
Public methodCreateDataErrors
Creates the visual elements that display data errors.
Public methodDispose()()()()
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
Public methodDispose(Boolean)
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. Allows control over whether to close all other dialogs during preview mode.
Public methodEnterAnnotateMode()()()()
Enters the annotate mode.
Public methodEnterAnnotateMode(DashboardDataDescriptor, DataPointCollection, Guid)
Enters the annotate mode.
Public methodExitAnnotateMode
Exits the annotate mode.
Public methodGetAnalyticalDataForAllAnalyticalControls
Gets the analytical data for all analytical controls on this dashboard.
Public methodGetDashboardElementWriteableBitmap(DashboardElement)
Gets the dashboard control as a writeable bitmap.
Public methodGetDashboardElementWriteableBitmap(DashboardElement, Boolean, ExportLegendPosition)
Gets the dashboard control as a writeable bitmap.
Public methodGetDashboardWriteableBitmap
Gets the dashboard as a writeable bitmap.
Public methodGetDataResultByDashboardDataVisualizationControl
Gets the data result by dashboard data visualization control.
Public methodGetDataResultsForAllDataVisualizationControls
Gets the data results for all data visualization controls in the current dashboard.
Public methodGetParameters
Gets the parameters that are acting on this dashboard with their current values. The order is random on both get and apply, so if there is more than 1 parameter acting on a KPI the results are indeterminate.
Public methodOnApplyTemplate
When overridden in a derived class, is invoked whenever application code or internal processes (such as a rebuilding layout pass) call ApplyTemplate()()()().
(Overrides FrameworkElement..::..OnApplyTemplate()()()().)
Public methodPrint()()()()
Prints the dashboard of this viewer instance.
Public methodPrint(DashboardElement)
Prints an element from the dashboard of this viewer instance.
Public methodRefresh
Attempts to remove the viewer from its container, and add it again.
Public methodRefreshAnnotations
Causes all controls that support annotations to refresh which points have annotations. This is a heavy call and should only be done when it is assured that an update is required.
Public methodSetParameters
Sets the parameters to values specified on the dashboard.

Fields

  NameDescription
Public fieldStatic memberDashboardProperty
The dependency property for Dashboard.
Public fieldStatic memberIsPreviewProperty
The dependency property for IsPreview.
Public fieldStatic memberIsSimulatedDataEnabledProperty
The dependency property for IsSimulatedDataEnabled.

Properties

  NameDescription
Public propertyDashboard
Gets or sets the dashboard that the viewer will display. This property should be set to nullNothingnullptra null reference (Nothing in Visual Basic) when the dashboard no longer wishes to be displayed so that the viewer can properly de-subscribe to its events.
Public propertyHasAllExternalDataControlsFinished
Gets or sets a value indicating whether this instance has all external data controls finished.
Public propertyInstanceId
Gets the instance id that identifies the unique id of this instance of the viewer.
Public propertyIsAnnotateMode
Gets a value indicating whether this instance is in annotate mode.
Public propertyIsAnnotateModeSupported
Gets a value indicating whether this instance supports annotate mode. This is determined by if any controls within the dashboard support annotate mode and at least one is enabled.
Public propertyIsPreview
Gets or sets a value indicating whether the viewer is in preview mode. In preview mode, KPIs that are not checked-in, only saved, will be retrieved. This value must be set before the OnApplyTemplate phase as after that point changing it will have no affect.
Public propertyIsSimpleDisplayModeEnabled
Gets or sets a value indicating whether this instance is in a "simple" display mode. This is used for image creation. If so, annotations, real-time updates and animations are disabled for this viewer. This must be set before the Dashboard is loaded to have any effect.
Public propertyIsSimulatedDataEnabled
Gets or sets a value indicating whether the viewer should use simulated data. In this mode, the wrappers will be called as if the designer is showing them. This has the benefit that no actual data-retrieval will be done, providing a good mode for a preview of just the layout without any data.
Public propertyTrackingId
Unique GUID meant to identify a particular dashboard being viewed.

Events

  NameDescription
Public eventAllExternalDataControlsLoaded
Fires when all controls which implement the IExternalDataSupport interface have finished loading. This may never fire if one of them throws an exception, or if no controls support this interface, so it must be used with care in determining finalization. Use it in conjunction with the HasAllExternalDataControlsFinished property.
Public eventAnnotationSelectionChanged
Fires when the annotation selection of any control changes.
Public eventInteractionError
Fires when an error is encountered during the build or run of an interaction script.
Public eventInteractionLogoutRequest
Fires when the interaction requests a logout.
Public eventInteractionMashupNavigationRequest
Fires when the interaction requests a navigation to a mashup.
Public eventInteractionMessageRequest
Fires when the interaction requests a message to be displayed to the user.
Public eventInteractionNavigationRequest
Fires when the interaction requests a navigation to a dashboard or dashblock.
Public eventInteractionTraceMessage
The event used to push trace (debugout) statements from the script engine.
Public eventViewerDashBlockLoaded
Fires when a contained DashBlockViewer has loaded a DashBlock.
Public eventViewerError
Fires when an error is encountered in the viewer.
Public eventViewerMessage
Fires when a message needs to be shown by the viewer.
Public eventVisualTreeUpdated
Fires when the visual tree has finished drawing.
Public eventVisualTreeUpdating
Fires when the visual tree is going to update.

See Also