XRDesignMdiController.AddCommandHandler(ICommandHandler) Method

Adds the specified command handler to the command handlers list for one or several of the report commands.

Namespace: DevExpress.XtraReports.UserDesigner

Assembly: DevExpress.XtraReports.v19.1.Extensions.dll

NuGet Package: DevExpress.Win.Reporting

Declaration

C#

public void AddCommandHandler(
    ICommandHandler handler
)

VB.NET

Public Sub AddCommandHandler(
    handler As ICommandHandler
)

Parameters

Name	Type	Description
handler	ICommandHandler	An object which implements 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.

Use the AddCommandHandler method, to add custom handlers to any of the report commands listed in the ReportCommand enumeration.

To remove the current command handler from one or several report commands, use the XRDesignMdiController.RemoveCommandHandler method.

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-suppress-the-report-has-been-changed-do-you-want-to-save-changes-message-t424864/CS/WindowsFormsApplication1/Form2.cs#L21

InitializeComponent();
reportDesigner1.AddCommandHandler(new MyClosingReportCommandHandler(reportDesigner1));

Reporting_winforms-end-user-designer-how-to-customize-a-subreport-once-it-has-been-created-t317196/CS/WindowsFormsApplication1/Form1.cs#L24

ReportDesignTool dt = new ReportDesignTool(new XtraReport1());
dt.DesignForm.DesignMdiController.AddCommandHandler(new MyCommandHandler(dt.DesignForm.DesignMdiController));
dt.ShowDesignerDialog();

VB.NET

Reporting_how-to-suppress-the-report-has-been-changed-do-you-want-to-save-changes-message-t424864/VB/WindowsFormsApplication1/Form2.vb#L20

InitializeComponent()
reportDesigner1.AddCommandHandler(New MyClosingReportCommandHandler(reportDesigner1))

Reporting_winforms-end-user-designer-how-to-customize-a-subreport-once-it-has-been-created-t317196/VB/WindowsFormsApplication1/Form1.vb#L26

Dim dt As New ReportDesignTool(New XtraReport1())
dt.DesignForm.DesignMdiController.AddCommandHandler(New MyCommandHandler(dt.DesignForm.DesignMdiController))
dt.ShowDesignerDialog()