How to: Create a RichEditControl with a Ribbon UI

  • 3 minutes to read

This tutorial describes how to create a word processing application with the ribbon UI and adjust its appearance.

In this document:

NOTE

Check the "Getting Started" tutorial on YouTube: DevExpress WinForms: Rich Text Editor.

Create a RichEditControl Application

  1. Create a new Windows Forms Application project in Visual Studio.

  2. Drop the RichEditControl item from the DX.20.1: Rich Text Editor toolbox tab onto the form.

    RichEdit_GettingStarted_DragAndDropControl

  3. Click the RichEditControl's smart tag and select Dock in Parent Container in the invoked RichEditControl Tasks menu. This allows the RichEditControl to expand to the form's size.

    RichEdit_GettingStarted_Docking

Create Ribbon Pages

Design Time

  1. Select Create Ribbon in the RichEditControl Tasks menu to add a RibbonControl onto the form.

    RichEdit_GettingStarted_CreateRibbon

  2. Select necessary ribbon pages in the RichEditControl Tasks menu or click Create All Bars to add all available rich edit ribbon pages at once. You can customize the created ribbon afterward: change the ribbon style, add new ribbon elements, modify or remove the existing items.

    RichEdit_GettingStarted_CreateAllTabs

  3. Click the RibbonControl's smart tag and select Convert Form To RibbonForm in the RibbonControl Tasks menu to convert the application form to a RibbonForm.

    RichEdit_GettingStarted_ConvertFormToRibbonForm

Runtime

Use the RichEditControl.CreateRibbon() method overloads to add a ribbon to the RichEditControl at runtime. Paste this code to the form constructor or to the Load event handler.

RibbonControl ribbon = richEditControl1.CreateRibbon();
this.Controls.Add(ribbon);   

Result

Run the Rich Text Editor and view the result. For example, type and format text, insert pictures and explore the various ribbon items.

RichEdit_GettingStarted_Result_RibbonForm

NOTE

Commands executed using the Ribbon user interface can throw unhandled exceptions if a problem occurs. Consider the situation when a document is being saved to a locked or read-only file. To prevent application failure, subscribe to the RichEditControl.UnhandledException event and set the RichEditUnhandledExceptionEventArgs.Handled property to true.

Change the Application's Appearance

Change the Application's Skin

At Design Time

In Code

Invoke the DevExpress Project Settings page and select a desired skin in the Skin Options group.

RichEditControl_GettingStarted_ProjectSettings

Call the UserLookAndFeel.Default static object's UserLookAndFeel.SetSkinStyle method:


using DevExpress.LookAndFeel;
// ...
UserLookAndFeel.Default.SetSkinStyle("Office 2019 Colorful", "Yale");

Use Bitmap or Vector Icons

The newly create word processing application uses vector icons. This ensures that the application is rendered correctly on high-DPI devices.

Set the static WindowsFormsSettings.AllowDefaultSvgImages property to DefaultBoolean.False at the application's startup to use bitmap icons in you application.


static void Main()
{
    DevExpress.XtraEditors.WindowsFormsSettings.AllowDefaultSvgImages = DevExpress.Utils.DefaultBoolean.False;
    // ...
}

The following images illustrate the standard RichEditControl's ribbon UI with default vector and bitmap icons:

  • SVG Icons

    RichEditControl_Ribbon_SVG

  • Bitmap Icons

    RichEditControl_Ribbon_Bitmap

TIP

You can disable or hide any command button on a ribbon tab by specifying restriction settings. Set the required properties of the RichEditBehaviorOptions (RichEditControl.Options.Behavior) and DocumentCapabilitiesOptions (RichEditControl.Options.DocumentCapabilities) objects to the DocumentCapability value to solve this task.

Use Skinned Open/Save File Dialogs

You can replace standard WinForms Open File and Save File dialogs with skinned DevExpress counterparts.

Set the static WindowsFormsSettings.UseDXDialogs property to DefaultBoolean.True at the application's startup to enable skinned dialogs in your application.

NOTE

Add the required assembly references to use skinned DevExpress dialogs. Refer to the Deployment topic for more information.

static void Main()
{
    DevExpress.XtraEditors.WindowsFormsSettings.UseDXDialogs = DefaultBoolean.True;
    // ...
}

As a result, the Open File and Save File dialogs match the application's theme.

IMAGE

TIP

Refer to the Examples section for more examples on how to work with the Rich Text Editor.

See Also