XRDesignRibbonForm Class

The ribbon-based End-User Report Designer form.

Namespace: DevExpress.XtraReports.UserDesigner

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

NuGet Package: DevExpress.Win.Reporting

Declaration

C#
VB.NET

public class XRDesignRibbonForm :
    RibbonForm,
    IDesignForm,
    IDisposable,
    ISupportLookAndFeel

Public Class XRDesignRibbonForm
    Inherits RibbonForm
    Implements IDesignForm,
               IDisposable,
               ISupportLookAndFeel

Remarks

The XRDesignRibbonForm represents a Ribbon End-User Designer form with a multi-document interface.

It contains an XRDesignRibbonController, XRDesignMdiController and XRDesignDockManager components.

The following image demonstrates an Office-inspired Ribbon End-User Designer form.

To show the XRDesignRibbonForm, call its Show (ShowDialog) method, or the ReportDesignTool.ShowRibbonDesigner (ReportDesignTool.ShowRibbonDesignerDialog) method.

The currently active XRDesignPanel of the XRDesignMdiController can be accessed via the XRDesignRibbonForm.ActiveDesignPanel property.

See Report Designer to learn more.

Example

When creating a custom Report Designer derived from the XRDesignRibbonForm class, you can load a report into it via the XRDesignRibbonForm.OpenReport method.

C#
VB.NET

using DevExpress.XtraReports.UserDesigner;
// ...

private void Form1_Load(object sender, System.EventArgs e) {
    // Enables form skins in the application (if required).
    DevExpress.Skins.SkinManager.EnableFormSkins();
    DevExpress.LookAndFeel.LookAndFeelHelper.ForceDefaultLookAndFeelChanged();
}

private void button1_Click(object sender, System.EventArgs e) {
    // Create an End-User Report Designer form with a ribbon UI.
    XRDesignRibbonForm designForm = new XRDesignRibbonForm();

    // Create a new blank report.
    designForm.OpenReport(new XtraReport1());

    // Display the Report Designer form.
    //designForm.Show();

    // Display the Report Designer form, modally.
    designForm.ShowDialog();
}

Imports DevExpress.XtraReports.UserDesigner
' ...

Private Sub Form1_Load(ByVal sender As Object, _ 
ByVal e As System.EventArgs) Handles MyBase.Load
    ' Enables form skins in the application (if required).
    DevExpress.Skins.SkinManager.EnableFormSkins()
    DevExpress.LookAndFeel.LookAndFeelHelper.ForceDefaultLookAndFeelChanged()
End Sub

Private Sub button1_Click(ByVal sender As Object, _ 
ByVal e As System.EventArgs) Handles button1.Click
    ' Create an End-User Report Designer form with a ribbon UI.
    Dim DesignForm As New XRDesignRibbonForm()

    ' Create a new blank report.
    DesignForm.OpenReport(New XtraReport1())

    ' Show the Report Designer form.
    ' DesignForm.Show()

    ' Show the Report Designer form, modally.
    DesignForm.ShowDialog()
End Sub