FieldOptions.HighlightColor Property

Gets or sets the color used to highlight the document fields.

Namespace: DevExpress.XtraRichEdit

Assembly: DevExpress.RichEdit.v24.2.Core.dll

NuGet Package: DevExpress.RichEdit.Core

Declaration

C#

public Color HighlightColor { get; set; }

VB.NET

Public Property HighlightColor As Color

Property Value

Type	Description
Color	A Color value representing the highlight color.

Property Paths

You can access this nested property as listed below:

Object Type	Path to HighlightColor
RichEditControlOptionsBase	.Fields .HighlightColor

Remarks

To specify whether the fields are highlighted, use the FieldOptions.HighlightMode property. Options for display of the document fields are available via the RichEditControlOptionsBase.Fields property.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the HighlightColor 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-replace-document-fields-with-their-values/CS/Form1.cs#L18

richEditControl1.Options.Fields.HighlightMode = FieldsHighlightMode.Always;
richEditControl1.Options.Fields.HighlightColor = Color.Yellow;

winforms-richedit-utility-to-create-a-mail-merge-template/CS/Form1.cs#L14

richEditControl1.Options.Fields.HighlightColor = Color.Yellow;
richEditControl1.Options.Fields.HighlightMode = FieldsHighlightMode.Always;

VB.NET

how-to-replace-document-fields-with-their-values/VB/Form1.vb#L17

richEditControl1.Options.Fields.HighlightMode = FieldsHighlightMode.Always
richEditControl1.Options.Fields.HighlightColor = Color.Yellow
Dim list As List(Of Employee) = New List(Of Employee)()

winforms-richedit-utility-to-create-a-mail-merge-template/VB/Form1.vb#L16

richEditControl1.Options.Fields.HighlightColor = Color.Yellow
richEditControl1.Options.Fields.HighlightMode = FieldsHighlightMode.Always