PrintingSystemBase.AddCommandHandler(ICommandHandler) Method

Adds the specified command handler to the command handlers list for one or several of the printing system commands (listed in the PrintingSystemCommand enumeration).

Namespace: DevExpress.XtraPrinting

Assembly: DevExpress.Printing.v20.2.Core.dll

NuGet Packages: DevExpress.Printing.Core, DevExpress.WindowsDesktop.Printing.Core

Declaration

C#

public void AddCommandHandler(
    ICommandHandler handler
)

VB.NET

Public Sub AddCommandHandler(
    handler As ICommandHandler
)

Parameters

Name	Type	Description
handler	ICommandHandler	An object implementing the ICommandHandler interface.

Remarks

Note

The AddCommandHandler method takes effect only in Windows Forms applications, where it must be called after the DocumentViewer.DocumentSource property has been assigned a value.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the AddCommandHandler(ICommandHandler) 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#

Reporting_how-to-customize-a-report-controls-appearance-only-when-exporting-the-report-e1159/CS/WindowsApplication1/Form1.cs#L30

// Override the ExportGraphic command.
pt.PrintingSystem.AddCommandHandler(new ExportToExcelCommandHandler());

Reporting_how-to-export-different-report-groups-to-different-sheets-in-an-xls-file-e1352/CS/WindowsApplication1/Form1.cs#L29

ReportPrintTool tool = new ReportPrintTool(report);
tool.PrintingSystem.AddCommandHandler(new ExportToXlsCommandHandler());
tool.ShowPreviewDialog();

Reporting_how-to-override-commands-in-print-preview-custom-export-e2305/CS/OverridePreviewCommands/Form1.cs#L27

// Override the ExportGraphic command.
pt.PrintingSystem.AddCommandHandler(new ExportToImageCommandHandler());

Reporting_how-to-customize-file-names-in-differentfiles-export-mode-when-exporting-to-ms-t424910/CS/WindowsFormsApplication1/Form1.cs#L30

pt.PrintingSystem.AddCommandHandler(new ExcelExportCommandHandler(FilePostfix));
pt.ShowPreviewDialog();

VB.NET

Reporting_how-to-customize-a-report-controls-appearance-only-when-exporting-the-report-e1159/VB/WindowsApplication1/Form1.vb#L32

' Override the ExportGraphic command.
pt.PrintingSystem.AddCommandHandler(New ExportToExcelCommandHandler())

Reporting_how-to-export-different-report-groups-to-different-sheets-in-an-xls-file-e1352/VB/WindowsApplication1/Form1.vb#L31

Dim tool As New ReportPrintTool(report)
tool.PrintingSystem.AddCommandHandler(New ExportToXlsCommandHandler())
tool.ShowPreviewDialog()

Reporting_how-to-override-commands-in-print-preview-custom-export-e2305/VB/OverridePreviewCommands/Form1.vb#L29

' Override the ExportGraphic command.
pt.PrintingSystem.AddCommandHandler(New ExportToImageCommandHandler())

Reporting_how-to-customize-file-names-in-differentfiles-export-mode-when-exporting-to-ms-t424910/VB/WindowsFormsApplication1/Form1.vb#L28

pt.PrintingSystem.AddCommandHandler(New ExcelExportCommandHandler(FilePostfix))
pt.ShowPreviewDialog()