XRDesignPanel.RemoveCommandHandler(ICommandHandler) Method

Removes the specified command handler.

Namespace: DevExpress.XtraReports.UserDesigner

Assembly: DevExpress.XtraReports.v24.2.Extensions.dll

NuGet Package: DevExpress.Win.Reporting

Declaration

C#

public void RemoveCommandHandler(
    ICommandHandler handler
)

VB.NET

Public Sub RemoveCommandHandler(
    handler As ICommandHandler
)

Parameters

Name	Type	Description
handler	ICommandHandler	The command handler to be removed.

Remarks

Call the RemoveCommandHandler method to remove a command handler that is assigned to a report command.

Note

The RemoveCommandHandler method is available only in Windows Forms applications.

Report commands are listed in the ReportCommand enumeration. To add a custom command handler to one or several report commands, call the XRDesignPanel.AddCommandHandler method.

Example

The code sample below demonstrates how to use the RemoveCommandHandler method to remove the Save command’s custom handler.

C#

using DevExpress.XtraReports.UI;
using DevExpress.XtraReports.UserDesigner;
using System.Windows.Forms;

namespace CodeSnippets.XRDesignPanel_AddRemoveCommandHandlers
{
    public class ReportTester
    {
        XRDesignMdiController mdiController;

        private void CustomReportDesigner()
        {
            // 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 XtraReport());

            // 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)
        {
            if (MessageBox.Show("Please enter your license key to be able to save the report.", "caption", MessageBoxButtons.OKCancel) == DialogResult.OK)
            {
                // Write your code to enter a license key.

                // Remove this command handler if the license key is entered.
                panel.RemoveCommandHandler(this);
            }
        }

        public bool CanHandleCommand(DevExpress.XtraReports.UserDesigner.ReportCommand command,
        ref bool useNextHandler)
        {
            useNextHandler = !(command == ReportCommand.SaveFile ||
                command == ReportCommand.SaveFileAs);
            return !useNextHandler;
        }
    }
}

VB.NET

Imports DevExpress.XtraReports.UI
Imports DevExpress.XtraReports.UserDesigner

Namespace CodeSnippets.XRDesignPanel_AddRemoveCommandHandlers
    Public Class ReportTester
        Private mdiController As XRDesignMdiController

        Private Sub CustomReportDesigner()
            ' Create a design form and get its MDI controller.
            Dim form As New XRDesignForm()
            mdiController = form.DesignMdiController

            ' Handle the DesignPanelLoaded event of the MDI controller,
            ' to override the SaveCommandHandler for every loaded report.
            AddHandler mdiController.DesignPanelLoaded, AddressOf mdiController_DesignPanelLoaded

            ' Open an empty report in the form.
            mdiController.OpenReport(New XtraReport())

            ' Show the form.
            form.ShowDialog()
            If mdiController.ActiveDesignPanel IsNot Nothing Then
                mdiController.ActiveDesignPanel.CloseReport()
            End If
        End Sub
        Private Sub mdiController_DesignPanelLoaded(ByVal sender As Object, ByVal e As DesignerLoadedEventArgs)
            Dim panel As XRDesignPanel = DirectCast(sender, XRDesignPanel)
            panel.AddCommandHandler(New SaveCommandHandler(panel))
        End Sub
    End Class

    Public Class SaveCommandHandler
        Implements ICommandHandler

        Private panel As XRDesignPanel

        Public Sub New(ByVal panel As XRDesignPanel)
            Me.panel = panel
        End Sub

        Public Sub HandleCommand(ByVal command As ReportCommand, ByVal args() As Object) _
            Implements ICommandHandler.HandleCommand
            If MessageBox.Show("Please enter your license key to be able to save the report.",
                               "caption",
                               MessageBoxButtons.OKCancel) = DialogResult.OK Then
                ' Write your code to enter a license key.

                ' Remove this command handler if the license key is entered.
                panel.RemoveCommandHandler(Me)
            End If
        End Sub

        Public Function CanHandleCommand(ByVal command As ReportCommand, ByRef useNextHandler As Boolean) As Boolean _
            Implements ICommandHandler.CanHandleCommand
            useNextHandler = Not (command = ReportCommand.SaveFile OrElse command = ReportCommand.SaveFileAs)
            Return Not useNextHandler
        End Function
    End Class
End Namespace