XRDesignMdiController.DesignPanelLoaded Event

Occurs when an XRDesignPanel object has been loaded.

Namespace: DevExpress.XtraReports.UserDesigner

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

Declaration

public event DesignerLoadedEventHandler DesignPanelLoaded
Public Event DesignPanelLoaded As DesignerLoadedEventHandler

The event handler DesignerLoadedEventHandler receives an argument of the DesignerLoadedEventArgs type.

Property Description
DesignerHost

Gets the designer host which provides all the services that are available for editing a report in its End-User Designer.

Within a multi-document interface, the DesignPanelLoaded event provides the functionality similar to that of the XtraReport.DesignerLoaded event of a single-document Report Designer version, but the changes made in the DesignPanelLoaded event handler will apply to all the reports opened within the End-User Report Designer form.

For example, the DesignPanelLoaded event can be used for adding custom controls to an MDI Designer's toolbox.

Examples

This example illustrates how to add a custom control to an End-User Report Designer's toolbox by handling the XRDesignMdiController.DesignPanelLoaded event and accessing the toolbox service.

Tip

This code adds the XRZipCode control to the toolbox. It is hidden by default because most countries do not use it.

See Using Custom and Third-Party Controls to learn how to create custom report controls and add them to a Report Designer's toolbox.

using DevExpress.XtraReports.UI;
using DevExpress.XtraReports.UserDesigner;
using System.Drawing.Design;
// ...

private void button1_Click(object sender, System.EventArgs e) {
    // Create a Design Tool with an assigned report instance.
    ReportDesignTool designTool = new ReportDesignTool(new XtraReport1());

    // Access the standard or ribbon-based Designer form.
    // IDesignForm designForm = designTool.DesignForm;
    IDesignForm designForm = designTool.DesignRibbonForm;

    // Handle the Design Panel's Loaded event.
    designForm.DesignMdiController.DesignPanelLoaded += DesignMdiController_DesignPanelLoaded;

    // Load a Report Designer in a dialog window.
    // designTool.ShowDesignerDialog();
    designTool.ShowRibbonDesignerDialog();
}

void DesignMdiController_DesignPanelLoaded(object sender, DesignerLoadedEventArgs e) {
    // Access the Toolbox service.
    IToolboxService toolboxService =
        (IToolboxService)e.DesignerHost.GetService(typeof(IToolboxService));

    // Add a custom control to a new category.
    toolboxService.AddToolboxItem(new ToolboxItem(typeof(XRZipCode)), "New Category");

    // Add a custom control to the default category.
    // toolboxService.AddToolboxItem(new ToolboxItem(typeof(XRZipCode)));
}

See Also