XRDesignPanel.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.v20.2.Extensions.dll
NuGet Package: DevExpress.Win.Reporting
Declaration
Parameters
| Name | Type | Description |
|---|---|---|
| handler | ICommandHandler | An object which implements the ICommandHandler interface, representing the command handler to be added. |
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 XRDesignPanel.RemoveCommandHandler method.
Example
This example demonstrates how to override and customize saving in the End-User Report Designer. This can be useful, for example, if all the reports in a project should be stored in a database, and are retrieved from the database via a stream, and all of this should be done automatically, without forcing an end-user to do anything but click the Save (or Save As) toolbar button.
In this example, a report will also be automatically saved using the custom saving procedure when an end-user closes the Report Designer. To implement this task, handle the ReportCommand.SaveFile and ReportCommand.SaveFileAs commands (and, if necessary, the ReportCommand.Closing command, as well).
The following code demonstrates how this can be done.
using System;
using System.Collections.Generic;
using System.ComponentModel;
using System.Data;
using System.Drawing;
using System.Linq;
using System.Text;
using System.Windows.Forms;
using DevExpress.XtraReports.UserDesigner;
namespace CustomSavingEUD
{
public partial class Form1 : Form
{
public Form1() {
InitializeComponent();
}
// Create an MDI (multi-document interface) controller instance.
XRDesignMdiController mdiController;
private void button1_Click(object sender, EventArgs e) {
// Create a design form and get its MDI controller.
XRDesignForm form = new XRDesignForm();
mdiController = form.DesignMdiController;
// Handle the DesignPanelLoaded event of the MDI controller,
// to override the SaveCommandHandler for every loaded report.
mdiController.DesignPanelLoaded +=
new DesignerLoadedEventHandler(mdiController_DesignPanelLoaded);
// Open an empty report in the form.
mdiController.OpenReport(new XtraReport1());
// Show the form.
form.ShowDialog();
if (mdiController.ActiveDesignPanel != null) {
mdiController.ActiveDesignPanel.CloseReport();
}
}
void mdiController_DesignPanelLoaded(object sender, DesignerLoadedEventArgs e) {
XRDesignPanel panel = (XRDesignPanel)sender;
panel.AddCommandHandler(new SaveCommandHandler(panel));
}
public class SaveCommandHandler : DevExpress.XtraReports.UserDesigner.ICommandHandler {
XRDesignPanel panel;
public SaveCommandHandler(XRDesignPanel panel) {
this.panel = panel;
}
public void HandleCommand(DevExpress.XtraReports.UserDesigner.ReportCommand command,
object[] args) {
// Save the report.
Save();
}
public bool CanHandleCommand(DevExpress.XtraReports.UserDesigner.ReportCommand command,
ref bool useNextHandler) {
useNextHandler = !(command == ReportCommand.SaveFile ||
command == ReportCommand.SaveFileAs);
return !useNextHandler;
}
void Save() {
// Write your custom saving here.
// ...
// For instance:
panel.Report.SaveLayout("c:\\report1.repx");
// Prevent the "Report has been changed" dialog from being shown.
panel.ReportState = ReportState.Saved;
}
}
}
}
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.