DesignerLoadedEventArgs.DesignerHost Property

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

Namespace: DevExpress.XtraReports.UserDesigner

Assembly: DevExpress.XtraReports.v18.2.dll

Declaration

C#

public IDesignerHost DesignerHost { get; }

VB.NET

Public ReadOnly Property DesignerHost As IDesignerHost

Property Value

Type	Description
IDesignerHost	An object implementing the IDesignerHost interface that is used to manage designer transactions and components.

Remarks

When a report is loaded into the End-User Designer, then the designer’s host provides all the services needed to support the editing of the report. These services can be obtained via its GetService method. For more information on the IDesignerHost see its description in MSDN.

Example

This example illustrates how to add a custom control to an End-User Report Designer’s toolbox by handling the XtraReport.DesignerLoaded 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 report instance.
    XtraReport1 report = new XtraReport1();

    // Create a Design Tool and assign the report to it.
    ReportDesignTool designTool = new ReportDesignTool(report);

    // Handle the DesignerLoaded event of the report.
    report.DesignerLoaded += report_DesignerLoaded;

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

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

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

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

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 report instance.
    Dim report As New XtraReport1()

    ' Create a Design Tool and assign the report to it.
    Dim designTool As New ReportDesignTool(report)

    ' Handle the DesignerLoaded event of the report.
    AddHandler report.DesignerLoaded, AddressOf report_DesignerLoaded

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

Private Sub report_DesignerLoaded(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 the default category.
    toolboxService.AddToolboxItem(New ToolboxItem(GetType(XRZipCode)))

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

Related GitHub Examples

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

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-add-a-datasource-to-the-component-tray-and-make-it-available-in-the-property-e1007/CS/Form1.cs#L41

private void OnDesignerLoaded(object sender, DesignerLoadedEventArgs e) {
    DesignToolHelper.AddToContainer(e.DesignerHost, ds);
    DesignToolHelper.AddToContainer(e.DesignerHost, adapter);

objectdatasource-how-to-provide-a-custom-parameter-editor-t246429/CS/CustomRepositoryItem/fmDesigner.cs#L20

void reportDesignerMDIController_DesignPanelLoaded(object sender, DevExpress.XtraReports.UserDesigner.DesignerLoadedEventArgs e) {
    ReplaceService(e.DesignerHost, typeof(IRepositoryItemsProvider), myRepositoryItemsProvider);
}

winforms-end-user-designer-how-to-customize-the-data-source-wizard-connection-string-stora-t119350/CS/T119350/fmDesigner.cs#L38

private void DesignMdiControllerOnDesignPanelLoaded(object sender, DesignerLoadedEventArgs e) {
    ReplaceService(e.DesignerHost, typeof(IConnectionStorageService), connectionStorageService);
}

Reporting_how-to-override-the-existing-behavior-when-dropping-an-item-from-the-field-list-in-e478/CS/Form1.cs#L26

    e.DesignerHost.AddService(typeof(IFieldListDragDropService),
        new MyFieldListDragDropService(e.DesignerHost));
}

Reporting_winforms-eud-how-to-create-a-control-template-gallery-with-reusable-control-sets-t341218/CS/ControlTemplateGallerySample/ControlTemplateGallery/TemplateUserControl.cs#L119

    e.DesignerHost.RemoveService(typeof(IDragDropService));
    e.DesignerHost.AddService(typeof(IDragDropService), new MyDragDropService(e.DesignerHost, templateStorage));
}

VB.NET

Reporting_how-to-add-a-datasource-to-the-component-tray-and-make-it-available-in-the-property-e1007/VB/Form1.vb#L42

Private Sub OnDesignerLoaded(ByVal sender As Object, ByVal e As DesignerLoadedEventArgs)
    DesignToolHelper.AddToContainer(e.DesignerHost, ds)
    DesignToolHelper.AddToContainer(e.DesignerHost, adapter)

objectdatasource-how-to-provide-a-custom-parameter-editor-t246429/VB/CustomRepositoryItem/fmDesigner.vb#L22

Private Sub reportDesignerMDIController_DesignPanelLoaded(ByVal sender As Object, ByVal e As DevExpress.XtraReports.UserDesigner.DesignerLoadedEventArgs)
    ReplaceService(e.DesignerHost, GetType(IRepositoryItemsProvider), myRepositoryItemsProvider)
End Sub

winforms-end-user-designer-how-to-customize-the-data-source-wizard-connection-string-stora-t119350/VB/T119350/fmDesigner.vb#L27

Private Sub DesignMdiControllerOnDesignPanelLoaded(ByVal sender As Object, ByVal e As DesignerLoadedEventArgs)
    ReplaceService(e.DesignerHost, GetType(IConnectionStorageService), connectionStorageService)
End Sub

Reporting_how-to-override-the-existing-behavior-when-dropping-an-item-from-the-field-list-in-e478/VB/Form1.vb#L26

    e.DesignerHost.RemoveService(GetType(IFieldListDragDropService))
    e.DesignerHost.AddService(GetType(IFieldListDragDropService), New MyFieldListDragDropService(e.DesignerHost))
End Sub

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

    e.DesignerHost.RemoveService(GetType(IDragDropService))
    e.DesignerHost.AddService(GetType(IDragDropService), New MyDragDropService(e.DesignerHost, templateStorage))
End Sub