Back to API Home

The DashboardContent type exposes the following members.

Constructors

  NameDescription
Public methodDashboardContent
Initializes a new instance of the DashboardContent class.

Methods

  NameDescription
Public methodAddService
Public methodDispose
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
Public methodGetAllDefinedInteractionsOnDashboard
Gets all the defined interactions on this dashboard.
Public methodGetAnalyticalDataDescriptorByName
Gets the analytical data descriptor by name.
Public methodGetAnalyticalDataDescriptorsByAnalyticalVisualObjectName
Gets the name of the data descriptors by data visualization object name.
Public methodGetDashBlockViewerControls
Gets the dash block viewer controls.
Public methodGetDashboardAnalyticalControls
Gets the dashboard analytical controls.
Public methodGetDashboardDataVisualizationControls
Gets the dashboard data visualization controls.
Public methodGetDashboardParameterByName
Gets the dashboard parameter by name.
Public methodGetDashboardParametersByDataDescriptor(String)
Gets the dashboard parameters by data descriptor.
Public methodGetDashboardParametersByDataDescriptor(DashboardDataDescriptor)
Gets the dashboard parameters by data descriptor.
Public methodGetDashboardParameterVisualObjectByName
Gets the parameter visual object by name.
Public methodGetDashboardParameterVisualObjectByParameterName
Gets the name of the dashboard parameter visual object by parameter name.
Public methodGetDataDescriptorByName
Gets the data descriptor by name.
Public methodGetDataDescriptorByToken
Gets the data descriptor by token.
Public methodGetDataDescriptorsByDataVisualizationObjectName
Gets the name of the data descriptors by data visualization object name.
Public methodGetDataResultDimensionGrain
Gets the data result dimension grain. This is used in the DataGrid's on demand data retrieval code.
Public methodGetGroupCurrentPosition
Gets the group's current position (top left x,y).
Public methodGetService(Type)
Gets the service object of the specified type.
Public methodGetService<(Of <<'(TService>)>>)()()()()
Public methodGetVisibleAndExportableDashboardControls
Gets the dashboard controls that consume data, are visible and are exportable.
Public methodGetVisualObjectByName
Gets the name of the visual object by.
Public methodGetVisualObjectsByGroup
Gets the visual objects by group name.
Public methodInteractionTrigger(Interaction, Object, DashboardEventArgs)
Triggers an interaction.
Public methodInteractionTrigger(InteractionCollection, Object, DashboardEventArgs)
Triggers an interaction.
Public methodRefresh
Refreshes all data visualization controls, which causes a re-query for all data that the control displays.
Public methodRemoveService
Public methodSetGroupPosition
Sets the group's position.
Public methodSetGroupProperty
Sets a property on all elements within a group.
Public methodSetGroupVisibility
Sets the group's visibility.
Public methodSetParentDashboard
Sets the parent dashboard on script services. This is used for DashBlocks which are embedded on a dashboard, so that the script on the DashBlock can access the parent dashboard.

Properties

  NameDescription
Public propertyActualHeight
Gets or sets the actual height of this dashboard.
Public propertyActualWidth
Gets or sets the actual width of this dashboard.
Public propertyAdditionalInfoUrl
Gets or sets the additional info URL.
Public propertyAnalyticalCommands
Gets or sets the analytical commands.
Public propertyAnalyticalCommandsDataContract
Gets or sets the analytical commands data contract.
Public propertyAnalyticalDataDescriptors
Gets or sets the analytical data descriptors.
Public propertyAreCustomTokensDisabled
Gets or sets a value indicating whether custom tokens are disabled.
Public propertyBackground
Gets or sets the background of the dashboard.
Public propertyContextClickInteractions
Gets the context click interactions.
Public propertyCustomContextMenuCommands
Gets or sets the custom context menu commands.
Public propertyDashboardExportPlugins
Gets or sets the dashboard export plugins.
Public propertyDashboardId
Gets the dashboard ID.
Public propertyDashboardParameters
Gets or sets the parameters on this dashboard.
Public propertyDashboardSettings
Gets or sets the dashboard settings.
Public propertyDashboardStyle
Gets or sets the dashboard style.
Public propertyDataDescriptors
Gets or sets the data descriptors.
Public propertyDescription
Gets the description.
Public propertyExportedInteractions
Gets the Exported interactions.
Public propertyExportingInteractions
Gets the Exporting interactions.
Public propertyHeight
Gets or sets the height of the dashboard.
Public propertyHorizontalGuidelines
Gets or sets the horizontal guidelines.
Public propertyInteractionList
Gets the interaction list. These are interactions which a script on another interaction can call to avoid copy/pasting code all over the place.
Public propertyIsAnalytical
Gets or sets a value indicating whether this dashboard is an analytical dashboard.
Public propertyIsAnnotationsDisabled
Gets or sets a value indicating whether annotations are disabled on this entire dashboard.
Public propertyIsContextMenuEnabled
Gets or sets a value indicating whether all of the controls have their context menu enabled on this dashboard. This value overrides the value set on the element level, so if this is not enabled, no elements will show their context menu.
Public propertyIsDesignTimeMode
Gets or sets a value indicating whether this instance is in design time mode. If so, interactions will be ignored.
Public propertyIsLoadingDataDisabled
Gets or sets a value indicating whether this instance is loading data on startup and parameter change.
Public propertyIsPreviewMode
Gets a value indicating whether this Dashboard is in preview mode.
Public propertyIsTrackingDisabled
Gets or sets a value indicating whether this dashboard is excluded from usage tracking.
Public propertyMaxHeight
Gets or sets the height of the max.
Public propertyMaxWidth
Gets or sets the width of the max.
Public propertyMinHeight
Gets or sets the height of the min.
Public propertyMinWidth
Gets or sets the width of the min.
Public propertyName
Gets or sets the dashboard's name.
Public propertyOnLoadInteractions
Gets the on load interactions.
Public propertyOnUnloadInteractions
Gets the on unload interactions.
Public propertyParameterChangedInteractions
Gets the parameter changed interactions.
Public propertyParameterChangingInteractions
Gets the parameter changing interactions.
Public propertyPrintedInteractions
Gets the Printed interactions.
Public propertyPrintingInteractions
Gets the Printing interactions.
Public propertyProjectId
Gets the project ID.
Public propertyReferences
Gets or sets the project's script references.
Public propertyResizeMode
Gets or sets the resize mode.
Public propertySizeChangedInteractions
Gets the size changed interactions.
Public propertyThemeResourceKey
Gets or sets the theme id for this dashboard.
Public propertyToolTipDuration
Gets or sets a value indicating how long tooltips should be displayed on this dashboard.
Public propertyVerticalGuidelines
Gets or sets the vertical guidelines.
Public propertyVisualObjects
Gets or sets the visual objects that will appear on the dashboard.
Public propertyWidth
Gets or sets the width of the dashboard.

Events

  NameDescription
Public eventOnLoad
Fires when the dashboard content has (visually) loaded. This is akin to the OnLoadInteractions, but for C# code instead.
Public eventOnUnload
Fires when the dashboard content has unloaded. This is akin to the OnUnloadInteractions, but for C# code instead.
Public eventPropertyChanged
Occurs when a property value changes.
Public eventRefreshRequested
Occurs when this dashboard is requested to have its data refreshed.

See Also