XRDesignMdiController.DesignPanelLoaded Event

Occurs when an XRDesignPanel object has been loaded.

Namespace: DevExpress.XtraReports.UserDesigner

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

NuGet Package: DevExpress.Win.Reporting

Declaration

C#

public event DesignerLoadedEventHandler DesignPanelLoaded

VB.NET

Public Event DesignPanelLoaded As DesignerLoadedEventHandler

Event Data

The DesignPanelLoaded event's data class is DesignerLoadedEventArgs. The following properties provide information specific to this event:

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

Remarks

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.

Example

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.

C#

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)));
}

VB.NET

Imports DevExpress.XtraReports.UI
Imports DevExpress.XtraReports.UserDesigner
Imports System.Drawing.Design
' ...

Private Sub button1_Click(sender As Object, e As System.EventArgs)
    ' Create a Design Tool with an assigned report instance.
    Dim designTool As New ReportDesignTool(New XtraReport1())

    ' Access the standard or ribbon-based Designer form.
    ' Dim designForm As IDesignForm = designTool.DesignForm
    Dim designForm As IDesignForm = designTool.DesignRibbonForm

    ' Handle the Design Panel's Loaded event.
    AddHandler designForm.DesignMdiController.DesignPanelLoaded, _ 
        AddressOf DesignMdiController_DesignPanelLoaded

    ' Load a Report Designer in a dialog window.
    ' designTool.ShowDesignerDialog()
    designTool.ShowRibbonDesignerDialog()
End Sub

Private Sub DesignMdiController_DesignPanelLoaded(sender As Object, e As DesignerLoadedEventArgs)
    ' Access the Toolbox service.
    Dim toolboxService As IToolboxService = _ 
        DirectCast(e.DesignerHost.GetService(GetType(IToolboxService)), IToolboxService)

    ' Add a custom control to a new category.
    toolboxService.AddToolboxItem(New ToolboxItem(GetType(XRZipCode)), "New Category")

    ' Add a custom control to the default category.
    ' toolboxService.AddToolboxItem(New ToolboxItem(GetType(XRZipCode)))
End Sub

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the DesignPanelLoaded event.

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_winforms-eud-how-to-create-a-control-template-gallery-with-reusable-control-sets-t341218/CS/ControlTemplateGallerySample/Form1.cs#L26

reportDesigner1.DesignPanelLoaded += reportDesigner1_DesignPanelLoaded;
reportDesigner1.OpenReport(new XtraReport1());

Reporting_how-to-add-a-custom-control-to-the-end-user-report-designers-toolbox-e1929/CS/ToolboxAddControl/Form1.cs#L19

// Handle the DesignPanelLoaded event.
designForm.DesignMdiController.DesignPanelLoaded +=
    new DesignerLoadedEventHandler(DesignMdiController_DesignPanelLoaded);

Reporting_how-to-rename-toolbox-items-in-end-user-designer-e2477/CS/EUD_RenameToolboxItems/Form1.cs#L18

// Handle the DesignPanelLoaded event.
designForm.DesignMdiController.DesignPanelLoaded +=
    new DesignerLoadedEventHandler(DesignMdiController_DesignPanelLoaded);

Reporting_how-to-change-names-of-report-controls-and-loaded-data-sources-data-adapters-in-the-e4703/CS/E4703/Form1.cs#L28

// Handle the DesignMdiController.DesignPanelLoaded event
tool.DesignForm.DesignMdiController.DesignPanelLoaded += new DevExpress.XtraReports.UserDesigner.DesignerLoadedEventHandler(DesignMdiController_DesignPanelLoaded);
// Show End-User Report Designer

reporting-winforms-custom-xml-serialization/CS/WindowsApplication54/Form1.cs#L31

using(ReportDesignTool tool = new ReportDesignTool(report)) {
    tool.DesignForm.DesignMdiController.DesignPanelLoaded += OnDesignPanelLoaded;
    tool.ShowDesignerDialog();

VB.NET

Reporting_winforms-eud-how-to-create-a-control-template-gallery-with-reusable-control-sets-t341218/VB/ControlTemplateGallerySample/Form1.vb#L28

AddHandler reportDesigner1.DesignPanelLoaded, AddressOf reportDesigner1_DesignPanelLoaded
reportDesigner1.OpenReport(New XtraReport1())

Reporting_how-to-add-a-custom-control-to-the-end-user-report-designers-toolbox-e1929/VB/ToolboxAddControl/Form1.vb#L21

' Handle the DesignPanelLoaded event.
AddHandler designForm.DesignMdiController.DesignPanelLoaded, _
    AddressOf DesignMdiController_DesignPanelLoaded

Reporting_how-to-rename-toolbox-items-in-end-user-designer-e2477/VB/EUD_RenameToolboxItems/Form1.vb#L20

' Handle the DesignPanelLoaded event.
AddHandler designForm.DesignMdiController.DesignPanelLoaded, AddressOf DesignMdiController_DesignPanelLoaded

Reporting_how-to-change-names-of-report-controls-and-loaded-data-sources-data-adapters-in-the-e4703/VB/E4703/Form1.vb#L26

' Handle the DesignMdiController.DesignPanelLoaded event
AddHandler tool.DesignForm.DesignMdiController.DesignPanelLoaded, AddressOf DesignMdiController_DesignPanelLoaded
' Show End-User Report Designer

reporting-winforms-custom-xml-serialization/VB/WindowsApplication54/Form1.vb#L35

Using tool As ReportDesignTool = New ReportDesignTool(report)
    AddHandler tool.DesignForm.DesignMdiController.DesignPanelLoaded, AddressOf OnDesignPanelLoaded
    tool.ShowDesignerDialog()