DashboardViewer Events

A Dashboard Viewer control used to embed dashboards created in the Dashboard Designer into a WinForms application.

Name	Description
AsyncDataLoading	Allows you to provide data for the DashboardObjectDataSource in asynchronous mode.
AsyncExcelDataSourceBeforeFill	Allows you to change options used to extract data from Microsoft Excel workbooks (XLS, XLSX or XLSM files) or CSV files asynchronously.
AsyncValidateCustomSqlQuery	Allows you to validate a custom SQL query of the DashboardSqlDataSource in asynchronous mode.
AutoSizeChanged	Occurs when the AutoSize property changes. Inherited from UserControl.
AutoValidateChanged	Occurs when the AutoValidate property changes. Inherited from UserControl.
BackColorChanged	Occurs when the value of the BackColor property changes. Inherited from Control.
BackgroundImageChanged	Occurs when the value of the BackgroundImage property changes. Inherited from Control.
BackgroundImageLayoutChanged	Occurs when the BackgroundImageLayout property changes. Inherited from Control.
BeforeExportDocument	Allows you to hide specific dashboard items when printing or exporting the entire dashboard.
BindingContextChanged	Occurs when the value of the BindingContext property changes. Inherited from Control.
CausesValidationChanged	Occurs when the value of the CausesValidation property changes. Inherited from Control.
ChangeUICues	Occurs when the focus or keyboard user interface (UI) cues change. Inherited from Control.
Click	Occurs when the control is clicked. Inherited from Control.
ClientSizeChanged	Occurs when the value of the ClientSize property changes. Inherited from Control.
ConfigureDataConnection	Allows you to customize connection settings before the DashboardViewer connects to a data store (database, OLAP cube, etc.).
ConnectionError	Allows users to override the default behavior if data store connection fails with current connection parameters.
ContextMenuChanged	Occurs when the value of the ContextMenu property changes. Inherited from Control.
ContextMenuStripChanged	Occurs when the value of the ContextMenuStrip property changes. Inherited from Control.
ControlAdded	Occurs when a new control is added to the Control.ControlCollection. Inherited from Control.
ControlRemoved	Occurs when a control is removed from the Control.ControlCollection. Inherited from Control.
CursorChanged	Occurs when the value of the Cursor property changes. Inherited from Control.
CustomAssemblyLoading	Occurs before a custom assembly is loaded for use as DashboardEFDataSource.
CustomDashboardItemControlCreating	Occurs when a dashboard control visualizes a custom item.
CustomExport	Allows you to customize the exported document.
CustomFilterExpression	Allows you to include WHERE clauses into DashboardSqlDataSource queries.
CustomizeDashboardItemCaption	Allows you to customize the dashboard item caption at runtime.
CustomizeDashboardTitle	Allows you to customize the dashboard title at runtime.
CustomizeExportDocument	Allows you to customize the exported document.
CustomPalette	Allows you to substitute the default palette containing colors used to paint dashboard item elements.
CustomParameters	Occurs before data is loaded from the data store and allows you to customize dashboard parameters that are used for data processing.
DashboardChanged	Occurs after a dashboard has been opened.
DashboardCustomPropertyChanged	Occurs when the custom property value in the Dashboard Viewer is changed.
DashboardItemBeforeControlDisposed	Allows you to access underlying WinForms controls.
DashboardItemClick	Occurs when an end user clicks a dashboard item.
DashboardItemControlCreated	Allows you to access underlying WinForms controls.
DashboardItemControlUpdated	Allows you to access underlying WinForms controls.
DashboardItemDoubleClick	Occurs when an end user double-clicks a dashboard item.
DashboardItemElementCustomColor	Allows you to color the required dashboard item elements using the specified colors.
DashboardItemMaximizedStateChanged	Fires when an item becomes maximized or restores its original size.
DashboardItemMouseDown	Occurs when the mouse pointer is over the dashboard item and a mouse button is pressed.
DashboardItemMouseEnter	Occurs when the mouse pointer enters the dashboard item.
DashboardItemMouseHover	Occurs when the mouse pointer rests on the dashboard item.
DashboardItemMouseLeave	Occurs when the mouse pointer leaves the dashboard item.
DashboardItemMouseMove	Occurs when the mouse pointer is moved over the dashboard item.
DashboardItemMouseUp	Occurs when the mouse pointer is over the dashboard item and a mouse button is released.
DashboardItemMouseWheel	Occurs when the mouse wheel moves while the dashboard item has focus.
DashboardItemSelectionChanged	Occurs after the selection within the dashboard item is changed.
DashboardItemVisualInteractivity	Allows you to provide custom visual interactivity for data-bound dashboard items that support element selection and highlighting.
DashboardLoaded	Occurs after the dashboard is loaded to the DashboardViewer.
DashboardStateChanged	Occurs after the current dashboard state in the DashboardViewer is changed.
DataInspectorFormClosing	Occurs before the Data Inspector window closes. Allows you to access the window’s grid controls.
DataInspectorFormLoad	Occurs before the Data Inspector window displays. Allows you to access the window’s grid controls and change their settings.
DataLoading	Allows you to provide data for the DashboardObjectDataSource.
DataLoadingError	Allows you to suppress the form containing errors that occur during data loading.
Disposed	Occurs when the component is disposed by a call to the Dispose() method. Inherited from Component.
DockChanged	Occurs when the value of the Dock property changes. Inherited from Control.
DoubleClick	Occurs when the control is double-clicked. Inherited from Control.
DragDrop	Occurs when a drag-and-drop operation is completed. Inherited from Control.
DragEnter	Occurs when an object is dragged into the control’s bounds. Inherited from Control.
DragLeave	Occurs when an object is dragged out of the control’s bounds. Inherited from Control.
DragOver	Occurs when an object is dragged over the control’s bounds. Inherited from Control.
DrillDownPerformed	Occurs after drill-down is performed.
DrillUpPerformed	Occurs after a drill-up is performed.
EnabledChanged	Occurs when the Enabled property value has changed. Inherited from Control.
Enter	Occurs when the control is entered. Inherited from Control.
ExportFormShowing	Occurs when the Export Form is about to be displayed, and allows you to cancel the action.
FontChanged	Occurs when the Font property value changes. Inherited from Control.
ForeColorChanged	Occurs when the ForeColor property value changes. Inherited from Control.
GiveFeedback	Occurs during a drag operation. Inherited from Control.
GotFocus	Occurs when the control receives focus. Inherited from Control.
HandleCreated	Occurs when a handle is created for the control. Inherited from Control.
HandleDestroyed	Occurs when the control’s handle is in the process of being destroyed. Inherited from Control.
HelpRequested	Occurs when the user requests help for a control. Inherited from Control.
ImeModeChanged	Occurs when the ImeMode property has changed. Inherited from Control.
Initialized	Handle this event to get the dashboard item data, and apply master filter and dashboard state in asynchronous mode.
Invalidated	Occurs when a control’s display requires redrawing. Inherited from Control.
KeyDown	Occurs when a key is pressed while the control has focus. Inherited from Control.
KeyPress	Occurs when a character. space or backspace key is pressed while the control has focus. Inherited from Control.
KeyUp	Occurs when a key is released while the control has focus. Inherited from Control.
Layout	Occurs when a control should reposition its child controls. Inherited from Control.
LayoutChanged	Occurs after the dashboard layout is changed.
Leave	Occurs when the input focus leaves the control. Inherited from Control.
Load	Occurs before the control becomes visible for the first time. Inherited from UserControl.
LocationChanged	Occurs when the Location property value has changed. Inherited from Control.
LostFocus	Occurs when the control loses focus. Inherited from Control.
MarginChanged	Occurs when the control’s margin changes. Inherited from Control.
MasterFilterCleared	Occurs when an end user clears the selection in the master filter item.
MasterFilterDefaultValues	Allows you to apply default filtering to master filter items.
MasterFilterSet	Occurs when an end user changes the state of the master filter.
MouseCaptureChanged	Occurs when the control loses mouse capture. Inherited from Control.
MouseClick	Occurs when the control is clicked by the mouse. Inherited from Control.
MouseDoubleClick	Occurs when the control is double clicked by the mouse. Inherited from Control.
MouseDown	Occurs when the mouse pointer is over the control and a mouse button is pressed. Inherited from Control.
MouseEnter	Occurs when the mouse pointer enters the control. Inherited from Control.
MouseHover	Occurs when the mouse pointer rests on the control. Inherited from Control.
MouseLeave	Occurs when the mouse pointer leaves the control. Inherited from Control.
MouseMove	Occurs when the mouse pointer is moved over the control. Inherited from Control.
MouseUp	Occurs when the mouse pointer is over the control and a mouse button is released. Inherited from Control.
MouseWheel	Occurs when the mouse wheel moves while the control has focus. Inherited from Control.
Move	Occurs when the control is moved. Inherited from Control.
PaddingChanged	Occurs when the control’s padding changes. Inherited from Control.
Paint	Occurs when the control is redrawn. Inherited from Control.
PaintEx	A DirectX-compatible event that replaces the standard Control.Paint event. Occurs when the control is redrawn. Inherited from XtraUserControl.
ParentChanged	Occurs when the Parent property value changes. Inherited from Control.
PopupMenuShowing	Allows you to customize the pop-up menu that users invoke in the DashboardViewer.
PreviewKeyDown	Occurs before the KeyDown event when a key is pressed while focus is on this control. Inherited from Control.
PrintPreviewShowing	Allows you to customize the Print Preview window at runtime.
QueryAccessibilityHelp	Occurs when AccessibleObject is providing help to accessibility applications. Inherited from Control.
QueryContinueDrag	Occurs during a drag-and-drop operation and enables the drag source to determine whether the drag-and-drop operation should be canceled. Inherited from Control.
RangeFilterDefaultValue	Allows you to specify the default selected range in the Range Filter dashboard item.
RegionChanged	Occurs when the value of the Region property changes. Inherited from Control.
Resize	Occurs when the control is resized. Inherited from Control.
RightToLeftChanged	Occurs when the RightToLeft property value changes. Inherited from Control.
Scroll	Occurs when the user or code scrolls through the client area. Inherited from ScrollableControl.
SelectedTabPageChanged	Occurs when the selected tab page is changed.
SetInitialDashboardState	Allows you to specify the initial dashboard state when loading a dashboard.
SizeChanged	Occurs when the Size property value changes. Inherited from Control.
StyleChanged	Occurs when the control style changes. Inherited from Control.
SystemColorsChanged	Occurs when the system colors change. Inherited from Control.
TabIndexChanged	Occurs when the TabIndex property value changes. Inherited from Control.
TabStopChanged	Occurs when the TabStop property value changes. Inherited from Control.
TextChanged	Raises the TextChanged event. Inherited from UserControl.
ValidateCustomSqlQuery	Allows you to validate a custom SQL query of the DashboardSqlDataSource.
Validated	Occurs when the control is finished validating. Inherited from Control.
Validating	Occurs when the control is validating. Inherited from Control.
VisibleChanged	Occurs when the Visible property value changes. Inherited from Control.