CustomExportEventArgs.GetPrintableControls() Method

Gets printable controls corresponding to the exported dashboard items.

Namespace: DevExpress.DashboardCommon

Assembly: DevExpress.Dashboard.v24.1.Core.dll

NuGet Package: DevExpress.Dashboard.Core

Declaration

C#

public Dictionary<string, XRControl> GetPrintableControls()

VB.NET

Public Function GetPrintableControls As Dictionary(Of String, XRControl)

Returns

Type	Description
Dictionary<String, XRControl>	A collection of printable controls corresponding to the exported dashboard items.

Remarks

The following table illustrates dashboard items and their corresponding printable XRControls:

Dashboard Item	XRControl
ChartDashboardItem	XRChart
ScatterChartDashboardItem	XRChart
PieDashboardItem	XRChart
PivotDashboardItem	XRPivotGrid
RangeFilterDashboardItem (When CustomExportBaseEventArgs.ExportMode is SingleItem)	XRChart
GaugeDashboardItem	XRGaugeDashboardItem
TextBoxDashboardItem	XRTextBox

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the GetPrintableControls() method.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

wpf-dashboard-custom-properties/CS/Wpf-Dashboard-Custom-Properties/Modules/ChartItemModule/ChartOptions/ScaleBreak.cs#L26

public static void CustomExport(DashboardControl dashboardControl, CustomExportEventArgs e) {
    Dictionary<string, XRControl> controls = e.GetPrintableControls();
    foreach(var control in controls) {

winforms-dashboard-custom-properties/CS/WinForms-Dashboard-Custom-Properties/Modules/ChartScaleBreakModule.cs#L59

void Designer_CustomExport(object sender, CustomExportEventArgs e) {
    Dictionary<string, XRControl> controls = e.GetPrintableControls();
    foreach(var control in controls) {

VB.NET

wpf-dashboard-custom-properties/VB/Wpf-Dashboard-Custom-Properties/Modules/ChartItemModule/ChartOptions/ScaleBreak.vb#L30

Public Shared Sub CustomExport(ByVal dashboardControl As DashboardControl, ByVal e As CustomExportEventArgs)
    Dim controls As Dictionary(Of String, XRControl) = e.GetPrintableControls()
    For Each control In controls

winforms-dashboard-custom-properties/VB/WinForms-Dashboard-Custom-Properties/Modules/ChartScaleBreakModule.vb#L61

Private Sub Designer_CustomExport(ByVal sender As Object, ByVal e As CustomExportEventArgs)
    Dim controls As Dictionary(Of String, XRControl) = e.GetPrintableControls()
    For Each control In controls