RichEditControl.ReadOnly Property

Gets or sets whether document modifications are prohibited.

Namespace: DevExpress.XtraRichEdit

Assembly: DevExpress.XtraRichEdit.v20.2.dll

NuGet Package: DevExpress.Win.RichEdit

Declaration

C#

[DefaultValue(false)]
[DXCategory("Behavior")]
public bool ReadOnly { get; set; }

VB.NET

<DXCategory("Behavior")>
<DefaultValue(False)>
Public Property ReadOnly As Boolean

Property Value

Type	Default	Description
Boolean	**false**	true if the document is in a read-only state; otherwise, false.

Remarks

When set to true, disables commands used to modify the document.

You can prohibit specific operations with a document. Use the DevExpress.XtraRichEdit.RichEditBehaviorOptions or DevExpress.XtraRichEdit.DocumentCapabilitiesOptions properties to restrict specific operations or document elements. Set the target property to DocumentCapability.Disabled or DocumentCapability.Hidden to disable or hide the corresponding command UI and pop-up menu items.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the ReadOnly property.

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#

how-the-layoutunit-property-affects-the-display-and-printout-appearance-e4021/CS/LayoutUnitExample/Form1.cs#L24

richEditControl2.ReadOnly = true;

how-to-bind-richedit-commands-to-buttons-check-boxes-and-other-ui-elements-e1774/CS/RichEditCommandExample/Form1.cs#L39

private void btnToggleReadOnly_Click(object sender, EventArgs e) {
    richEditControl1.ReadOnly = !richEditControl1.ReadOnly;
}

how-to-implement-navigation-between-a-set-of-referenced-documents-e4140/CS/Form1.cs#L17

InitializeComponent();
richEditControl1.ReadOnly = true;
richEditControl1.Options.Hyperlinks.ModifierKeys = PortableKeys.None;

how-to-create-a-log-viewer-application-e4683/CS/Form1.cs#L17

richEditControl1.ReadOnly = true;
richEditControl1.ActiveViewType = RichEditViewType.Draft;

VB.NET

how-to-bind-richedit-commands-to-buttons-check-boxes-and-other-ui-elements-e1774/VB/RichEditCommandExample/Form1.vb#L41

Private Sub btnToggleReadOnly_Click(ByVal sender As Object, ByVal e As EventArgs) Handles btnToggleReadonly.Click
    richEditControl1.ReadOnly = Not richEditControl1.ReadOnly
End Sub

how-to-implement-navigation-between-a-set-of-referenced-documents-e4140/VB/Form1.vb#L19

InitializeComponent()
richEditControl1.ReadOnly = True
richEditControl1.Options.Hyperlinks.ModifierKeys = PortableKeys.None

how-to-create-a-log-viewer-application-e4683/VB/Form1.vb#L19

richEditControl1.ReadOnly = True
richEditControl1.ActiveViewType = RichEditViewType.Draft