ReportDesignTool.ShowDesigner() Method

Invokes the standard End-User Report Designer form which allows a report to be edited by end-users.

Namespace: DevExpress.XtraReports.UI

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

NuGet Package: DevExpress.Win.Reporting

Declaration

C#

public void ShowDesigner()

VB.NET

Public Sub ShowDesigner

Remarks

Use the ShowDesigner method to invoke the XRDesignForm form, and show a report in a standard End-User Report Designer form.

To access the XRDesignForm object of a ReportDesignTool, use the ReportDesignTool.DesignForm property.

After the End-User Designer form has been loaded for the current report, its XtraReport.DesignerLoaded event is raised.

Note that when an end-user edits a report in the End-User Designer, the instance of a report, for which the ShowDesigner method was called, is also changing. So, a report instance is changed even if an end-user chooses the No button in the “Report has been changed” dialog, invoked when closing a report.

Therefore, if you want to reject all changes made by an end-user, you first need to clone a report instance to a temporary object, and then restore a report from it.

To invoke the ribbon-based End-User Report Designer form for a report, call the ReportDesignTool.ShowRibbonDesigner method.

Example

This example demonstrates how to run the standard End-User Designer form for a particular report, using the ReportDesignTool, via either the ReportDesignTool.ShowDesigner or ReportDesignTool.ShowDesignerDialog methods.

Note that in this example, the End-User Designer is invoked two times: the first time modally, and the second time with the Properties window and Report Explorer windows being hidden. You can pass the list of windows to be hidden to the overloaded method as a parameter.

For this example to work correctly, the XtraReport1 class derived from the XtraReport class should exist in the example application.

C#

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

private void button1_Click(object sender, EventArgs e) {
    ReportDesignTool dt = new ReportDesignTool(new XtraReport1());

    // Invoke the standard End-User Designer form, modally.
    dt.ShowDesignerDialog();

    // Invoke the standard End-User Designer form
    // without the PropertyGrid and ReportExplorer panels.
    dt.ShowDesigner(UserLookAndFeel.Default, DesignDockPanelType.PropertyGrid |
DesignDockPanelType.ReportExplorer);
}

VB.NET

Imports System
Imports System.Windows.Forms
Imports DevExpress.LookAndFeel
Imports DevExpress.XtraReports.UI
Imports DevExpress.XtraReports.UserDesigner
' ...

Private Sub button1_Click(ByVal sender As Object, _ 
ByVal e As EventArgs) Handles button1.Click
    Dim dt As New ReportDesignTool(New XtraReport1())

    ' Invoke the standard End-User Designer form, modally.
    dt.ShowDesignerDialog()

    ' Invoke the standard End-User Designer form
    ' without the PropertyGrid and ReportExplorer panels.
    dt.ShowDesigner(UserLookAndFeel.Default, _ 
    DesignDockPanelType.PropertyGrid Or DesignDockPanelType.ReportExplorer)
End Sub

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the ShowDesigner() 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.

C#

reporting-winforms-provide-authentication-to-access-json-data/CS/Form1.cs#L31

    new DevExpress.XtraReports.UI.ReportDesignTool(report).ShowDesigner();
}

VB.NET

reporting-winforms-provide-authentication-to-access-json-data/VB/Form1.vb#L32

    Call (New DevExpress.XtraReports.UI.ReportDesignTool(report)).ShowDesigner()
End Sub

reporting-winforms-custom-control-numeric-label/VB/Form1.vb#L25

    AddHandler designForm.DesignMdiController.DesignPanelLoaded, AddressOf DesignMdiController_DesignPanelLoaded
    designTool.ShowDesigner()
End Sub

Implements

ShowDesigner()