Back to Devexpress

CustomExportEventArgs.GetPrintableControls() Method

dashboard-devexpress-dot-dashboardcommon-dot-customexporteventargs-97b14ecd.md

latest6.8 KB
Original Source

CustomExportEventArgs.GetPrintableControls() Method

Gets printable controls corresponding to the exported dashboard items.

Namespace : DevExpress.DashboardCommon

Assembly : DevExpress.Dashboard.v25.2.Core.dll

NuGet Package : DevExpress.Dashboard.Core

Declaration

csharp
public Dictionary<string, XRControl> GetPrintableControls()
vb
Public Function GetPrintableControls As Dictionary(Of String, XRControl)

Returns

TypeDescription
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 ItemXRControl
ChartDashboardItemXRChart
ScatterChartDashboardItemXRChart
PieDashboardItemXRChart
PivotDashboardItemXRPivotGrid
RangeFilterDashboardItem (When CustomExportBaseEventArgs.ExportMode is SingleItem)XRChart
GaugeDashboardItemXRGaugeDashboardItem
TextBoxDashboardItemXRTextBox

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.

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

csharp
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

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

dashboard-constant-lines/CS/ConstantLineExtension.Win/ConstantLineModule.cs#L52

csharp
private void Win_CustomExport(object sender, DevExpress.DashboardCommon.CustomExportEventArgs e) {
    Dictionary<string, XRControl> controls = e.GetPrintableControls();
    foreach(var control in controls) {

winforms-dashboard-display-each-series-in-separate-pane-for-chart-items/CS/MultiPaneExtension/MultiPaneModule.cs#L77

csharp
{
    foreach (var printControl in e.GetPrintableControls())
    {

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

vb
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

vb
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

winforms-dashboard-display-each-series-in-separate-pane-for-chart-items/VB/MultiPaneExtension/MultiPaneModule.vb#L73

vb
Private Sub CustomExport(ByVal sender As Object, ByVal e As CustomExportEventArgs)
    For Each printControl In e.GetPrintableControls()
        If TypeOf printControl.Value Is XRChart Then

See Also

CustomExportEventArgs Class

CustomExportEventArgs Members

DevExpress.DashboardCommon Namespace