Back to Devexpress

CustomExportWebEventArgs.GetPrintableControls() Method

dashboard-devexpress-dot-dashboardweb-dot-customexportwebeventargs-950e3ce6.md

latest6.1 KB
Original Source

CustomExportWebEventArgs.GetPrintableControls() Method

Gets printable controls corresponding to the exported dashboard items.

Namespace : DevExpress.DashboardWeb

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

NuGet Package : DevExpress.Web.Dashboard.Common

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.

asp-net-web-forms-dashboard-custom-properties-sample/CS/WebFormsDashboardCustomPropertiesSample/Export/ChartConstantLinesExtension.cs#L25

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

web-forms-dashboard-gauge-ranges/CS/Default.aspx.cs#L30

csharp
const string CustomPropertyName = "GaugeRanges";
Dictionary<string, XRControl> controls = e.GetPrintableControls();

asp-net-mvc-dashboard-custom-properties-sample/CS/AspMvcDashboardCustomPropertiesSample/Export/ChartConstantLinesExtension.cs#L25

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

dashboard-constant-lines/CS/ConstantLineExtension.Web/ConstantLineModule.cs#L64

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

asp-net-core-dashboard-custom-properties-sample/CS/AspNetCoreDashboard/Export/ChartConstantLinesExtension.cs#L25

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

asp-net-web-forms-dashboard-custom-properties-sample/VB/WebFormsDashboardCustomPropertiesSample/Export/ChartConstantLinesExtension.vb#L24

vb
Public Sub CustomExport(ByVal e As CustomExportWebEventArgs)
    Dim controls As Dictionary(Of String, XRControl) = e.GetPrintableControls()
    For Each control In controls

See Also

CustomExportWebEventArgs Class

CustomExportWebEventArgs Members

DevExpress.DashboardWeb Namespace