Back to API Home

The EnhancedViewer type exposes the following members.

Constructors

  NameDescription
Public methodEnhancedViewer
Initializes a new instance of the EnhancedViewer class.

Methods

  NameDescription
Public methodAddDashBlock(Guid)
Adds the DashBlock to the current mashup. This will start a new mashup if a dashboard is currently being viewed.
Public methodAddDashBlock(DashboardDefinition)
Adds the DashBlock to the current mashup. This will start a new mashup if a dashboard is currently being viewed.
Public methodAddDashBlock(EnhancedViewerContentItem)
Adds the DashBlock to the current mashup. This will start a new mashup if a dashboard is currently being viewed.
Public methodConfigureSeries
Enters the configure series.
Public methodDispose
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
Public methodEnterAnnotateMode()()()()
Enters the annotate mode.
Public methodEnterAnnotateMode(EnhancedViewerContentItem, DashboardDataDescriptor, DataPointCollection)
Enters the annotate mode and pre-populates the default selection.
Public methodEnterAnnotateMode(EnhancedViewerContentItem, DashboardDataDescriptor, DataPointCollection, Guid)
Enters the annotate mode and pre-populates the default selection.
Public methodExitAnnotateMode
Exits the annotate mode.
Public methodExportEntireDashboard
Exports the entire dashboard of the specified content item.
Public methodGetContentItems
Gets the content items displayed in this enhanced viewer.
Public methodGetDefaultCommands
Gets the default commands. These are all the non context-sensitive commands that appear within the enhanced viewer.
Public methodGetParameters()()()()
Gets the parameters that are acting on the dashboard with their current values. For mashups, the parameters for each content item is applied by Id.
Public methodGetParameters(EnhancedViewerContentItem)
Gets the parameters that are acting on the 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 methodGetShortViewerLinkUri
Gets the short viewer link URI.
Public methodGetViewer()()()()
Gets the viewer.
Public methodGetViewer(DashboardContent)
Gets the viewer displaying the specified dashboard.
Public methodGetViewer(EnhancedViewerContentItem)
Gets the viewer displaying the specified content item.
Public methodGetViewerLinkUri
Gets the link URI for the current ViewerSource item.
Public methodStatic memberLoadRootNavigationItemAsync
Loads the root navigation item.
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 methodRemoveDashBlock
Removes the DashBlock from the mashup.
Public methodReplaceDashBlock
Replaces the DashBlock.
Public methodSetParameters(ParameterInfoCollection)
Sets the parameters to values specified on the corresponding content item (for mash-ups), or the first item.
Public methodSetParameters(ParameterInfoCollection, EnhancedViewerContentItem)
Sets the parameters to values specified on the specified dashboard.
Public methodSetupNotification()()()()
Shows the notification wizard.
Public methodSetupNotification(EnhancedViewerContentItem)
Shows the notification wizard.
Public methodSetupNotification(EnhancedViewerContentItem, DashboardControl, DashboardDataDescriptor, String)
Shows the notification wizard.
Public methodSetupNotification(EnhancedViewerContentItem, DashboardControl, DashboardDataDescriptor, String, WizardDisplayOptions)
Shows the notification wizard.
Public methodSetupScheduledReport()()()()
Shows the scheduled report wizard.
Public methodSetupScheduledReport(EnhancedViewerContentItem)
Shows the scheduled report wizard.
Public methodShowAnnotationGroupFilterDialog()()()()
Shows the annotation group filter dialog.
Public methodShowAnnotationGroupFilterDialog(WizardDisplayOptions)
Shows the annotation group filter dialog.
Public methodShowBookmarkDialog()()()()
Displays the bookmark dialog so the user can bookmark the currently viewed ViewerSource.
Public methodShowBookmarkDialog(Action)
Displays the bookmark dialog so the user can bookmark the currently viewed ViewerSource.
Public methodShowBookmarkDialog(Action, WizardDisplayOptions)
Displays the bookmark dialog so the user can bookmark the currently viewed item.
Public methodShowContentManager()()()()
Shows the content manager.
Public methodShowContentManager(WizardDisplayOptions)
Shows the content manager.
Public methodShowExportWizard()()()()
Shows the export wizard where the user has to select the dash-part (if there is more than one).
Public methodShowExportWizard(EnhancedViewerContentItem)
Shows the export wizard.
Public methodShowExportWizard(EnhancedViewerContentItem, IEnumerable<(Of <<'(DashboardControl>)>>), String)
Shows the export wizard.
Public methodShowExportWizard(EnhancedViewerContentItem, IEnumerable<(Of <<'(DashboardControl>)>>), String, WizardDisplayOptions)
Shows the export wizard.
Public methodShowPerformanceDialog()()()()
Shows the performance dialog.
Public methodShowPerformanceDialog(WizardDisplayOptions)
Shows the performance dialog.
Public methodShowPrintDialog()()()()
Shows the print dialog where the user has to select the dash-part (if there is more than one) and then the option to print.
Public methodShowPrintDialog(EnhancedViewerContentItem)
Shows the print dialog.
Public methodShowPrintDialog(EnhancedViewerContentItem, DashboardElement)
Shows the print dialog.
Public methodShowSaveMashupDialog()()()()
Shows the save mashup dialog.
Public methodShowSaveMashupDialog(Action)
Shows the save mashup dialog.
Public methodShowSaveMashupDialog(Action, WizardDisplayOptions)
Shows the save mashup dialog.
Public methodShowSelectDashBlockWizardAsync(Boolean, Action<(Of <<'(SelectDashBlockViewModel>)>>))
Shows the select DashBlock wizard async. This wizard lets the user pick a DashBlock from any that are currently being shown.
Public methodShowSelectDashBlockWizardAsync(Boolean, Action<(Of <<'(SelectDashBlockViewModel>)>>), Boolean)
Shows the select DashBlock wizard async. This wizard lets the user pick a DashBlock from any that are currently being shown.
Public methodShowSelectDashBlockWizardAsync(Boolean, Action<(Of <<'(SelectDashBlockViewModel>)>>), Boolean, WizardDisplayOptions)
Shows the select DashBlock wizard async. This wizard lets the user pick a DashBlock from any that are currently being shown.
Public methodShowShareDialog()()()()
Shows the share dialog so that the user can share the currently viewed item.
Public methodShowShareDialog(WizardDisplayOptions)
Shows the share dialog so that the user can share the currently viewed item.
Public methodStartTutorial
Starts the tutorial.

Fields

  NameDescription
Public fieldStatic memberAnnotateCommandId
The command id for the Annotate button.
Public fieldStatic memberBookmarkCommandId
The command id for the Bookmark button.
Public fieldStatic memberCustomizeCommandId
The command id for the Customize button.
Public fieldStatic memberExportCommandId
The command id for the Export button.
Public fieldStatic memberFilterAnnotationGroupsCommandId
The command id for the Filter Annotation Groups button.
Public fieldStatic memberFormulasMenuCommandId
The command id for the root formulas menu.
Public fieldStatic memberHeaderBackgroundProperty
Public fieldStatic memberHelpCommandId
The command id for the Help button.
Public fieldStatic memberIsAutoLoginEnabledProperty
Public fieldStatic memberIsErrorMessagesSuppressedProperty
Public fieldStatic memberIsLogoVisibleProperty
Public fieldStatic memberIsMashupsEnabledProperty
Public fieldStatic memberIsNavigationCollapsedProperty
Public fieldStatic memberIsNavigationVisibleProperty
Public fieldStatic memberIsToolbarCollapsedProperty
Public fieldStatic memberIsToolbarVisibleProperty
Public fieldStatic memberLinkUriBaseModeProperty
Public fieldStatic memberLinkUriBaseProperty
Public fieldStatic memberLogoImageProperty
Public fieldStatic memberLogoutCommandId
The command id for the Logout button.
Public fieldStatic memberManageContentCommandId
The command id for the Manage Content button.
Public fieldStatic memberMaxNumberOfDashBlocksProperty
Public fieldStatic memberNavigationItemTemplateProperty
Public fieldStatic memberNotificationCommandId
The command id for the Notification button.
Public fieldStatic memberPerformanceInfoCommandId
The command id for the Performance Info button.
Public fieldStatic memberPrintCommandId
The command id for the Print button.
Public fieldStatic memberSaveMashupCommandId
The command id for the Save Mashup button.
Public fieldStatic memberScheduledReportCommandId
The command id for the Schedule button.
Public fieldStatic memberShareCommandId
The command id for the Share button.
Public fieldStatic memberToolbarCommandsProperty
Public fieldStatic memberToolbarItemsInternalProperty
Public fieldStatic memberViewerSourceProperty

Properties

  NameDescription
Public propertyCurrentNavigationFolderId
Gets or sets the ID of the currently selected folder in the navigation pane.
Public propertyDefaultFolderId
Gets or sets the id of the folder that will be initially selected in the navigation bar when the viewer is loaded.
Public propertyHeaderBackground
Gets or sets the header background.
Public propertyIsAllViewersLoaded
Gets a value indicating whether all of the viewers have loaded (for the first time) for this enhanced viewer.
Public propertyIsAnnotateMode
Gets a value indicating whether this instance is in annotate mode.
Public propertyIsAutoLoginEnabled
Gets or sets a value indicating whether the viewer will automatically prompt the user to login if there's no active session.
Public propertyIsErrorMessagesSuppressed
Gets or sets a value indicating whether the viewer will get pop up messages for exceptions that may occur in the system.
Public propertyIsLogoVisible
Gets or sets a value indicating whether this instance is logo visible.
Public propertyIsMashupsEnabled
Gets or sets a value indicating whether mashups are enabled for the enhanced viewer.
Public propertyIsNavigationCollapsed
Gets or sets a value indicating whether the navigation is collapsed.
Public propertyIsNavigationVisible
Gets or sets a value indicating whether the navigation interface is visible.
Public propertyIsNewMashup
Gets a value indicating whether the current mashup is new (ie: has never been saved).
Public propertyIsShowingDashboard
Gets a value indicating whether this instance is showing a dashboard.
Public propertyIsShowingMashup
Gets a value indicating whether this instance is showing a mashup.
Public propertyIsToolbarCollapsed
Gets or sets a value indicating whether the toolbar is collapsed.
Public propertyIsToolbarVisible
Gets or sets a value indicating whether the toolbar is visible.
Public propertyIsViewerSourceLoading
Gets a value indicating whether the ViewerSource is loading.
Public propertyItemFilter
Gets or sets a predicate that controls which items are displayed in the navigation.
Public propertyLinkUriBase
Gets or sets the link URI. This is the URI that should be used when generating the view link. If this is set to nullNothingnullptra null reference (Nothing in Visual Basic), the current System.Windows.Browser.HtmlPage.Document.DocumentUri will be used.
Public propertyLinkUriBaseMode
Gets or sets the link URI base mode. The mode determines how link uris are generated.
Public propertyLogoImage
Gets or sets the logo image.
Public propertyMaxNumberOfDashBlocks
Gets or sets the maximum number of DashBlocks this enhanced viewer can show. Default value is 0, which is infinite number.
Public propertyNavigationItemTemplate
Gets or sets the template for navigation items.
Public propertyToolbarCommands
Gets or sets the toolbar commands.
Public propertyViewerNavigationControl
Gets the viewer navigation control (film strip) that this enhanced viewer is showing.
Public propertyViewerServices
Gets the services. This is the class that provides common functionality for those using the enhanced viewer.
Public propertyViewerSource
Gets or sets the source. This will cause the enhanced viewer to display what is set in the source. Setting this to nullNothingnullptra null reference (Nothing in Visual Basic) effectively clears the enhanced viewer.

Events

  NameDescription
Public eventInteractionError
Fires when an error is encountered during the build or run of an interaction script.
Public eventInteractionMessageRequest
Fires when the interaction requests a message to be displayed to the user.
Public eventInteractionNavigationRequest
Fires when the interaction requests a navigation.
Public eventInteractionNavigationRequestUpdateViewerSource
The event is used to update the Viewer Source after InteractionNavigationRequest fires.
Public eventInteractionTraceMessage
The event used to push trace (debugout) statements from the script engine.
Public eventLoggedIn
Occurs when the user has successfully logged in.
Public eventLoggedOut
Occurs when the user logs out.
Public eventLogInError
Occurs when there is an error during login.
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 eventViewerReady
Occurs when the viewer has finished loading and is ready to be used.
Public eventViewerSourceLoaded
Fires when the viewer source property has finished loading. At this point, the ContentItems will be available.
Public eventViewerSourceLoading
Fires when the viewer source property is loading.
Public eventVisualTreeUpdated
Fires when the visual tree has finished drawing.
Public eventVisualTreeUpdating
Fires when the visual tree is going to update.

Explicit Interface Implementations

  NameDescription
Explicit interface implemetationPrivate methodIServiceProvider..::..GetService
Gets the service object of the specified type.

See Also