ReportDesignTool.ShowRibbonDesignerDialog() Method

Invokes the ribbon-based End-User Report Designer form modally. This form allows a report to be edited by end-users.

Namespace: DevExpress.XtraReports.UI

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

NuGet Package: DevExpress.Win.Reporting

Declaration

C#

public void ShowRibbonDesignerDialog()

VB.NET

Public Sub ShowRibbonDesignerDialog

Remarks

Use the ShowRibbonDesignerDialog method to invoke XRDesignRibbonForm modally and show a report in an Office-inspired ribbon-based End-User Report Designer.

To make this method display the End-User Report Designer form with the previous ribbon version, set the static UseOfficeInspiredRibbonStyle property to false at the application’s startup.

C#

static class Program {
    static void Main() {
        DevExpress.XtraReports.Configuration.DesignSettings.Default.UseOfficeInspiredRibbonStyle = false;
        // ... 
    }
}

VB.NET

Module Program
    Private Sub Main()
        DevExpress.XtraReports.Configuration.DesignSettings.Default.UseOfficeInspiredRibbonStyle = false;
        ' ... 
    End Sub 
End Module 

To access the XRDesignRibbonForm object of a ReportDesignTool, use the ReportDesignTool.DesignRibbonForm 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 ShowRibbonDesignerDialog 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 standard End-User Report Designer form for a report, call the ReportDesignTool.ShowDesignerDialog method.

Example

This example demonstrates how to run the Ribbon End-User Designer form for a particular report, using the ReportDesignTool (via either the ReportDesignTool.ShowRibbonDesigner or ReportDesignTool.ShowRibbonDesignerDialog 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.

To learn about other approaches to invoke the Ribbon End-User Designer, see Quick Start.

C#

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

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

    // Invoke the Ribbon End-User Designer form
    // and load the report into it, modally.
    dt.ShowRibbonDesignerDialog();

    // Invoke the Ribbon End-User Designer form
    // without the PropertyGrid and ReportExplorer panels.
    dt.ShowRibbonDesigner(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 Form1_Load(ByVal sender As Object, ByVal e As EventArgs) Handles MyBase.Load
    Dim report As New XtraReport1()
    Dim dt As New ReportDesignTool(report)

    ' Invoke the Ribbon End-User Designer form
    ' and load the report into it, modally.
    dt.ShowRibbonDesignerDialog()

    ' Invoke the Ribbon End-User Designer form
    ' without the PropertyGrid and ReportExplorer panels.
    dt.ShowRibbonDesigner(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 ShowRibbonDesignerDialog() 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-sql-data-source-runtime/CS/RuntimeSqlDataSourceReportSample/Form1.cs#L36

ReportDesignTool designer = new ReportDesignTool(rep);
designer.ShowRibbonDesignerDialog();
#endregion

reporting-winforms-custom-controls-for-editing-report-content-in-print-preview/CS/RegisterCustomFieldEditor/Form1.cs#L80

    ReportDesignTool designTool = new ReportDesignTool(CreateReport());
    designTool.ShowRibbonDesignerDialog();
}

reporting-winforms-bind-mdb-with-select-query/CS/RuntimeBindingToMdbDatabase/Form1.cs#L85

    ReportDesignTool designTool = new ReportDesignTool(CreateReport());
    designTool.ShowRibbonDesignerDialog();
}

winforms-reporting-create-report-bound-to-xpobjectsource/CS/Form1.cs#L60

    ReportDesignTool designTool = new ReportDesignTool(report);
    designTool.ShowRibbonDesignerDialog();
}

reporting-winforms-create-report-bound-to-json-data-source/CS/Form1.cs#L29

ReportDesignTool designTool = new ReportDesignTool(report);
designTool.ShowRibbonDesignerDialog();
Application.Exit();

VB.NET

reporting-winforms-sql-data-source-runtime/VB/RuntimeSqlDataSourceReportSample/Form1.vb#L33

            Dim designer As New ReportDesignTool(rep)
            designer.ShowRibbonDesignerDialog()
#End Region

reporting-winforms-custom-controls-for-editing-report-content-in-print-preview/VB/RegisterCustomFieldEditor/Form1.vb#L68

    Dim designTool As ReportDesignTool = New ReportDesignTool(CreateReport())
    designTool.ShowRibbonDesignerDialog()
End Sub

reporting-winforms-bind-mdb-with-select-query/VB/RuntimeBindingToMdbDatabase/Form1.vb#L77

    Dim designTool As New ReportDesignTool(CreateReport())
    designTool.ShowRibbonDesignerDialog()
End Sub

winforms-reporting-create-report-bound-to-xpobjectsource/VB/Form1.vb#L59

    Dim designTool As New ReportDesignTool(report)
    designTool.ShowRibbonDesignerDialog()
End Sub

reporting-winforms-create-report-bound-to-json-data-source/VB/Form1.vb#L26

Dim designTool As New ReportDesignTool(report)
designTool.ShowRibbonDesignerDialog()
Application.Exit()

Implements

ShowRibbonDesignerDialog()