Back to Devexpress

Views in Rich Text Editor for WinForms

windowsforms-18081-controls-and-libraries-rich-text-editor-visual-elements-views.md

latest5.3 KB
Original Source

Views in Rich Text Editor for WinForms

  • Jun 28, 2022
  • 2 minutes to read

RichEditControl can display documents in three different ways depending on the applied document View.

Simple View

Draft View

Print Layout View

End users can click the Document Views buttons on the View ribbon tab to change the active view. Refer to the How to: Create a RichEditControl with a Ribbon UI topic for information on how to provide a Ribbon UI for the RichEditControl.

The table below describes and compares the available views.

Simple ViewDraft ViewPrint Layout View
APIActiveViewType set to Simple
SimpleViewActiveViewType set to Draft
DraftViewActiveViewType set to PrintLayout
PrintLayoutView
DescriptionSuitable for simple text and web pages. Shows how to the document looks as a website.Used for text formatting. Shows how the document looks on a monitor.Used for complex documents. Shows how the document looks as a printout.
Displayed Editor ElementsNoneHorizontal RulerHorizontal and Vertical Rulers
PagingDocument is not split into pages.Document is not split into pages.Document is divided into pages.
Page LayoutNo page layout options are applied.Only the page width is applied. Multiple columns are displayed as a single column.All page layout options are applied.
Floating Objects PositionMisplacedMisplacedCorrect

View Options

You can use the RichEditControl.ActiveView property to access the current view. The returned RichEditView options allow you to customize the target view.

csharp
richEditControl1.ActiveView.AllowDisplayLineNumbers = true;
richEditControl1.ActiveView.BackColor = System.Drawing.Color.Beige;
vb
richEditControl1.ActiveView.AllowDisplayLineNumbers = True
richEditControl1.ActiveView.BackColor = System.Drawing.Color.Beige

Use the RichEditLayoutOptions property to access view-specific options. Document layout options for Print Layout View are retrieved from a document.

csharp
using DevExpress.XtraRichEdit;

RichEditLayoutOptions layoutOptions = richEditControl.Options.Layout;

layoutOptions.DraftView.MatchHorizontalTableIndentsToTextEdge = true;
layoutOptions.SimpleView.ResizeTablesToFitContent = true;
vb
Imports DevExpress.XtraRichEdit

Dim layoutOptions As RichEditLayoutOptions = richEditControl.Options.Layout

layoutOptions.DraftView.MatchHorizontalTableIndentsToTextEdge = True
layoutOptions.SimpleView.ResizeTablesToFitContent = True

Note

Set the current view’s AdjustColorsToSkins property to true to adapt the RichEditControl’s text editing surface elements to the current theme.

You can control the scrollbar and ruler visibility for any view. Use the following properties to customize the editing surface appearance:

The code sample below hides all rulers and scrollbars:

csharp
RichEditControlOptions richEditControlOptions = richEditControl.Options;

richEditControlOptions.VerticalScrollbar.Visibility = RichEditScrollbarVisibility.Hidden;
richEditControlOptions.HorizontalScrollbar.Visibility = RichEditScrollbarVisibility.Hidden;

richEditControlOptions.VerticalRuler.Visibility = RichEditRulerVisibility.Hidden;
richEditControlOptions.HorizontalRuler.Visibility = RichEditRulerVisibility.Hidden;
vb
Dim richEditControlOptions As RichEditControlOptions = richEditControl.Options

richEditControlOptions.VerticalScrollbar.Visibility = RichEditScrollbarVisibility.Hidden
richEditControlOptions.HorizontalScrollbar.Visibility = RichEditScrollbarVisibility.Hidden

richEditControlOptions.VerticalRuler.Visibility = RichEditRulerVisibility.Hidden
richEditControlOptions.HorizontalRuler.Visibility = RichEditRulerVisibility.Hidden