CustomExportEventArgs.GetPrintableControl(String) Method

Gets a printable control corresponding to the specified dashboard item.

Namespace: DevExpress.DashboardCommon

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

NuGet Package: DevExpress.Dashboard.Core

Declaration

C#

public XRControl GetPrintableControl(
    string dashboardItemName
)

VB.NET

Public Function GetPrintableControl(
    dashboardItemName As String
) As XRControl

Parameters

Name	Type	Description
dashboardItemName	String	A string that is the dashboard item’s component name.

Returns

Type	Description
XRControl	A printable control corresponding to the specified dashboard item.

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 snippet (auto-collected from DevExpress Examples) contains a reference to the GetPrintableControl(String) 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#

winforms-dashboard-pivot-custom-export/CS/WinformsExport/Form1.cs#L23

void dashboardViewer1_CustomExport(object sender, CustomExportEventArgs e) {
    XRPivotGrid pivot1 = e.GetPrintableControl("pivotDashboardItem1") as XRPivotGrid;
    XRPivotGrid pivot2 = e.GetPrintableControl("pivotDashboardItem2") as XRPivotGrid;

VB.NET

winforms-dashboard-pivot-custom-export/VB/WinFormsExport/Form1.vb#L25

Private Sub dashboardViewer1_CustomExport(ByVal sender As Object, ByVal e As CustomExportEventArgs) Handles dashboardViewer1.CustomExport
    Dim pivot1 As XRPivotGrid = TryCast(e.GetPrintableControl("pivotDashboardItem1"), XRPivotGrid)
    Dim pivot2 As XRPivotGrid = TryCast(e.GetPrintableControl("pivotDashboardItem2"), XRPivotGrid)