RichEditControl.Options Property

Provides access to the variety of options which can be specified for the RichEditControl.

Namespace: DevExpress.XtraRichEdit

Assembly: DevExpress.XtraRichEdit.v20.2.dll

NuGet Package: DevExpress.Win.RichEdit

Declaration

C#

[DXCategory("Options")]
public RichEditControlOptions Options { get; }

VB.NET

<DXCategory("Options")>
Public ReadOnly Property Options As RichEditControlOptions

Property Value

Type	Description
RichEditControlOptions	A RichEditControlOptions object containing various RichEditControl’s options.

Remarks

The Options property provides access to the object which exposes all options implemented for the RichEditControl.

Use the RichEditControlOptions properties to access target options.

The code sample below shows how to access options used to specify document restrictions.

C#

private void RestrictFormatting()
{
  richEditControl.Options.DocumentCapabilities.CharacterFormatting = DocumentCapability.Hidden;
  richEditControl.Options.DocumentCapabilities.Comments = DocumentCapability.Disabled;
  richEditControl.Options.DocumentCapabilities.FloatingObjects = DocumentCapability.Hidden;
}

VB.NET

Private Sub RestrictFormatting()
   richEditControl.Options.DocumentCapabilities.CharacterFormatting = DocumentCapability.Hidden          
   richEditControl.Options.DocumentCapabilities.FloatingObjects = DocumentCapability.Hidden 
   richEditControl.Options.DocumentCapabilities.Comments = DocumentCapability.Disabled
End Sub

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the Options 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-to-use-document-variable-docvariable-fields-e3099/CS/DocumentVariablesExample/Form1.cs#L20

richEditControl1.Options.MailMerge.DataSource = new SampleData();
richEditControl2.Document.CalculateDocumentVariable += new CalculateDocumentVariableEventHandler(eventHandler_CalculateDocumentVariable);

export-to-html-how-to-export-only-body-tag-content-and-specify-the-location-of-css-styles-e1726/CS/ExportOnlyBodyContent/Form1.cs#L53

try {
    string fileName = richEditControl1.Options.DocumentSaveOptions.CurrentFileName;
    if(!String.IsNullOrEmpty(fileName)) {

how-to-customize-dialog-forms-in-xtrarichedit-suite-e3095/CS/CustomDialogs/MyFontForm.cs#L49

if (richEditControl != null) {
    this.fontEdit1.Enabled = richEditControl.Options.DocumentCapabilities.CharacterFormattingAllowed;
    this.fontEdit1.Text = controller.FontName;

how-to-implement-progress-indicator-for-slow-richeditcontrol-operations-e3075/CS/ProgressIndicator/Form1.cs#L22

    richEditControl1.LoadDocument("Docs\\invitation.docx");
    richEditControl1.Options.MailMerge.DataSource = new SampleData();
}

how-to-use-api-to-set-tab-stops-tab-leading-characters-and-the-tab-marker-e3081/CS/TabStops/Form1.cs#L43

    string s = textEdit1.Text.Replace("\\t","\t");
    richEditControl1.Options.Behavior.TabMarker = s ;
}

VB.NET

how-to-use-document-variable-docvariable-fields-e3099/VB/DocumentVariablesExample/Form1.vb#L22

richEditControl1.Options.MailMerge.DataSource = New SampleData()
AddHandler richEditControl2.Document.CalculateDocumentVariable, AddressOf eventHandler_CalculateDocumentVariable

export-to-html-how-to-export-only-body-tag-content-and-specify-the-location-of-css-styles-e1726/VB/ExportOnlyBodyContent/Form1.vb#L55

Try
    Dim fileName As String = richEditControl1.Options.DocumentSaveOptions.CurrentFileName
    If (Not String.IsNullOrEmpty(fileName)) Then

how-to-customize-dialog-forms-in-xtrarichedit-suite-e3095/VB/CustomDialogs/MyFontForm.vb#L53

If richEditControl IsNot Nothing Then
    Me.fontEdit1.Enabled = richEditControl.Options.DocumentCapabilities.CharacterFormattingAllowed
    Me.fontEdit1.Text = controller_Renamed.FontName

how-to-implement-progress-indicator-for-slow-richeditcontrol-operations-e3075/VB/ProgressIndicator/Form1.vb#L21

    richEditControl1.LoadDocument("Docs\invitation.docx")
    richEditControl1.Options.MailMerge.DataSource = New SampleData()
End Sub

how-to-use-api-to-set-tab-stops-tab-leading-characters-and-the-tab-marker-e3081/VB/TabStops/Form1.vb#L41

    Dim s As String = textEdit1.Text.Replace("\t",Constants.vbTab)
    richEditControl1.Options.Behavior.TabMarker = s
End If