DashboardControl Members

Constructors

Name Description
DashboardControl()

Initializes a new instance of the DashboardControl class.

Fields

Name Description
AllowMaximizeAnimationProperty

Identifies the AllowMaximizeAnimation dependency property.

DashboardProperty

Identifies the DashboardControl.Dashboard dependency property.

DashboardSourceProperty

Identifies the DashboardControl.DashboardSource dependency property.

FullscreenDashboardViewModelProperty

Identifies the FullscreenDashboardViewModel dependency property.

MaximizedDashboardItemNameProperty

Identifies the MaximizedDashboardItemNameProperty dependency property.

ObjectDataSourceLoadingBehaviorProperty

Identifies the ObjectDataSourceLoadingBehaviorProperty dependency property.

TitleAlignmentProperty

Identifies the TitleAlignment dependency property.

TitleContentProperty

Identifies the TitleContent dependency property.'

TitleContentTemplateProperty

Identifies the TitleContentTemplate dependency property.

TitleContentTemplateSelectorProperty

Identifies the TitleContentTemplateSelector dependency property.

TitleVisibilityProperty

Identifies the TitleVisibility dependency property.

Properties

Name Description
AllowMaximizeAnimation

Gets or sets whether to enable the animation when you maximize or restore dashboard items. This is a dependency property.

AnimationInProgress

Gets whether the animation is being played.

Dashboard

Gets or sets the opened dashboard.

DashboardSource

Gets or sets a dashboard source for the DashboardControl.

DashboardViewModel

This member supports the internal infrastructure and is not intended to be used directly from your code.

ExcelExportOptions

Provides access to options related to exporting a dashboard item to the Excel format.

FullscreenDashboardViewModel

This member supports the internal infrastructure and is not intended to be used directly from your code.

ImageExportOptions

Provides access to options related to exporting a dashboard/dashboard item to an image.

MaximizedDashboardItemName

Gets or sets the name of the maximized dashboard item. This is the dependency property.

ObjectDataSourceLoadingBehavior

Specifies how to load the object data sources available in the end-user application considering the application security.

PdfExportOptions

Provides access to options related to exporting a dashboard/dashboard item to the PDF format.

TitleAlignment

Gets or sets the horizontal alignment of the dashboard title content, excluding command buttons. This is a dependency property.

TitleContent

Gets or sets the title text. This is a dependency property.

TitleContentTemplate

Allows you to specify a template to display in the dashboard title (command buttons are not affected).

TitleContentTemplateSelector

Gets or sets an object that returns a template based on custom logic. This is a dependency property.

TitleVisibility

Gets or sets whether the dashboard title is displayed.

Methods

Name Description
CanClearMasterFilter(String)

Returns whether or not the specified master filter can be cleared in the current state.

CanPerformDrillDown(String)

Returns whether or not drill down is possible in the current state of the specified dashboard item.

CanPerformDrillUp(String)

Returns whether or not drill up is possible in the current state of the specified dashboard item.

CanSetMasterFilter(String)

Returns whether or not the master filter item allows selecting one or more elements.

CanSetMultiValueMasterFilter(String)

Returns whether or not the master filter item allows selecting multiple elements.

ClearMasterFilter(String)

Clears the specified master filter item.

ExportDashboardItemToExcel(String, Stream)

Exports the dashboard item to the specified stream in Excel format.

ExportDashboardItemToExcel(String, Stream, DashboardExcelExportOptions)

Exports the dashboard item to the specified stream in Excel format using specified export options.

ExportDashboardItemToExcel(String, String)

Exports the dashboard item to the specified file in Excel format.

ExportDashboardItemToExcel(String, String, DashboardExcelExportOptions)

Exports the dashboard item to the specified file in Excel format using specified export options.

ExportDashboardItemToImage(String, Stream)

Exports the dashboard item to the specified stream in Image format.

ExportDashboardItemToImage(String, Stream, DashboardImageExportOptions)

Exports the dashboard item to the specified stream in Image format using the specified image options.

ExportDashboardItemToImage(String, String)

Exports the dashboard item to the specified file in Image format.

ExportDashboardItemToImage(String, String, DashboardImageExportOptions)

Exports the dashboard item to the image file using the specified image options.

ExportDashboardItemToPdf(String, Stream)

Exports the dashboard item to the specified stream in PDF format.

ExportDashboardItemToPdf(String, Stream, DashboardPdfExportOptions)

Exports the dashboard item to the specified stream in PDF format using the specified PDF-specific options.

ExportDashboardItemToPdf(String, String)

Exports the dashboard item to the specified file in PDF format.

ExportDashboardItemToPdf(String, String, DashboardPdfExportOptions)

Exports the dashboard item to the specified file in PDF format using the specified PDF-specific options.

ExportToExcel(Stream)

Exports dashboard data to the specified stream in Excel format.

ExportToExcel(Stream, DashboardExcelExportOptions)

Exports dashboard data to the specified stream in Excel format.

ExportToExcel(String)

Exports dashboard data to the specified file in Excel format.

ExportToExcel(String, DashboardExcelExportOptions)

Exports dashboard data to the specified file in Excel format.

ExportToImage(Stream)

Exports a dashboard to the specified stream in Image format.

ExportToImage(Stream, DashboardImageExportOptions)

Exports a dashboard to the specified stream in Image format using the specified image-specific options.

ExportToImage(String)

Exports a dashboard to the specified file in Image format.

ExportToImage(String, DashboardImageExportOptions)

Exports a dashboard to the specified image file using the specified image-specific options.

ExportToPdf(Stream)

Exports a dashboard to the specified stream in PDF format.

ExportToPdf(Stream, DashboardPdfExportOptions)

Exports a dashboard to the specified stream in PDF format using the specified PDF-specific options.

ExportToPdf(String)

Exports a dashboard to the specified file in PDF format.

ExportToPdf(String, DashboardPdfExportOptions)

Exports a dashboard to the specified file in PDF format using the specified PDF-specific options.

GetAvailableDrillDownValues(String)

Returns axis point tuples identifying elements that can be used to perform drill-down in the specified dashboard item.

GetAvailableFilterValues(String)

Returns axis point tuples identifying elements that can be selected in the current state of the master filter item.

GetAvailablePredefinedRanges(String)

Returns names of the predefined ranges available for the specified Range Filter.

GetCurrentDrillDownValues(String)

Returns an axis point tuple identifying the current drill-down state.

GetCurrentFilterValues(String)

Returns axis point tuples identifying currently selected elements in the master filter item.

GetCurrentPredefinedRange(String)

Returns the name of the currently selected predefined range.

GetCurrentRange(String)

Returns the selected range for the specified Range Filter dashboard item.

GetCurrentSelection(String)

Returns records identifying currently selected elements in the master filter item.

GetDashboardLayout()

Saves dashboard layout to a string.

GetDashboardState()

Gets the current dashboard state.

GetEntireRange(String)

Returns the visible range for the specified Range Filter dashboard item.

GetItemData(String)

Returns the client data for the specified dashboard item.

GetPrintableComponent(String)

Gets a printable component corresponding to the specified dashboard item.

GetUnderlyingData(String)

Returns underlying data for the specified dashboard item.

GetUnderlyingData(String, IList<AxisPoint>)

Returns underlying data for the specified dashboard item by the specified axis points.

GetUnderlyingData(String, IList<AxisPoint>, IList<String>)

Returns underlying data for the specified dashboard item by the specified axis points.

GetUnderlyingData(String, IList<String>)

Returns underlying data for the specified dashboard item by the specified data members.

GetUnderlyingData(String, IList<UnderlyingDataTargetValue>)

Returns underlying data for the specified dashboard item by the specified dimension values.

GetUnderlyingData(String, IList<UnderlyingDataTargetValue>, IList<String>)

Returns underlying data for the specified dashboard item by the specified dimension values.

InvalidateData()

Schedules the asynchronous data update for the entire dashboard. The data update is performed when the UpdateLayout() method is called.

InvalidateData(String)

Schedules the asynchronous data update for the specified dashboard item. The data update is performed when the UpdateLayout() method is called.

LoadDashboard(Stream)

Loads a dashboard from a stream.

LoadDashboard(String)

Loads a dashboard from an XML file.

LoadDashboardLayout(Stream)

Loads a dashboard layout from a stream.

LoadDashboardLayout(String)

Loads a dashboard layout from an XML file.

PerformDrillDown(String, AxisPointTuple)

Performs a drill-down for the required element.

PerformDrillDown(String, DashboardDataRow)

Performs a drill-down for the required element.

PerformDrillDown(String, Object)

Performs a drill-down for the required element by its value.

PerformDrillUp(String)

Performs a drill-up in the specified dashboard item.

ReloadData()

Reloads data from the data source for the entire dashboard.

ReloadData(String)

Reloads data from the data source for the specified dashboard item.

SaveDashboardLayout(Stream)

Saves a dashboard layout to a stream.

SaveDashboardLayout(String)

Saves a dashboard layout to an XML file.

SetDashboardLayout(String)

Applies dashboard layout contained in a string.

SetDashboardState(DashboardState)

Applies the dashboard state to the loaded dashboard.

SetMasterFilter(String, AxisPointTuple)

Selects required elements in the specified master filter item.

SetMasterFilter(String, IEnumerable<AxisPointTuple>)

Selects the required elements in the specified master filter item.

SetMasterFilter(String, IEnumerable<DashboardDataRow>)

Selects required elements in the specified master filter item.

SetMasterFilter(String, Object)

Selects required elements by their values in the specified master filter item.

SetRange(String, RangeFilterSelection)

Selects the required range in the specified Range Filter dashboard item.

SetRange(String, String)

Selects the specified range in the specified Range Filter dashboard item.

UpdateData()

Performs the scheduled data update asynchronously.

Events

Name Description
AsyncDataLoading

Allows you to provide data for the DashboardObjectDataSource.

AsyncExcelDataSourceBeforeFill

Provides the capability to change options used to extract data from Microsoft Excel workbooks (XLS, XLSX or XLSM files) or CSV files asynchronously.

AsyncValidateCustomSqlQuery

Enables you to check the validity of the custom SQL query used to supply the dashboard with data.

BeforeExportDocument

Allows you to hide specific dashboard items when printing or exporting the entire dashboard.

ConfigureDataConnection

Allows you to customize connection settings before the DashboardControl connects to a data store (database, OLAP cube, etc.).

ConfigureItemDataCalculation

Allows you to configure how the dashboard item's client data is calculated.

ConnectionError

Allows overriding the default behavior when current connection parameters do not allow connecting to a data store.

CustomAssemblyLoading

Occurs before a custom assembly is loaded for use as DashboardEFDataSource.

CustomExport

Allows you to customize the exported document.

CustomFilterExpression

Allows you to include WHERE clauses into DashboardSqlDataSource queries.

CustomPalette

Provides the capability 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.

CustomizeExportDocument

Allows you to customize the exported document.

DashboardItemMouseDoubleClick

Occurs when an end-user double-clicks a dashboard item.

DashboardItemMouseDown

Occurs when the mouse pointer is over the dashboard item and a mouse button is released.

DashboardItemMouseEnter

Occurs when the mouse pointer enters the dashboard item.

DashboardItemMouseLeave

Occurs when the mouse pointer enters the dashboard item.

DashboardItemMouseMove

Occurs when the mouse pointer moves over a 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 DashboardControl.

DataLoadingError

Allows you to suppress the form containing errors that occur during data loading.

DrillDownPerformed

Occurs after a drill-down is performed.

DrillUpPerformed

Occurs after a drill-up is performed.

MasterFilterCleared

Occurs when an end-user clears the selection in the master filter item.

MasterFilterSet

Occurs when an end-user changes the state of the master filter.

SetInitialDashboardState

Allows you to specify the initial dashboard state when loading a dashboard.