FieldsHighlightMode Enum

Lists conditions for highlighting the fields in the document.

Namespace: DevExpress.XtraRichEdit

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

Declaration

C#

[ComVisible(true)]
public enum FieldsHighlightMode

VB.NET

<ComVisible(True)>
Public Enum FieldsHighlightMode

Members

Name	Description
Auto	Default highlight mode (equals to FieldsHighlightMode.Never)
Never	Document fields are not visually recognized.
Always	Document fields are always highlighted.

Related API Members

The following properties accept/return FieldsHighlightMode values:

Library	Related API Members
WPF Controls	DXRichEditFieldOptions.HighlightMode
Office File API	FieldOptions.HighlightMode

Related API Members

The following properties accept/return FieldsHighlightMode values:

Library	Related API Members
WPF Controls	DXRichEditFieldOptions.HighlightMode
Office File API	FieldOptions.HighlightMode

Remarks

The FieldsHighlightMode enumeration member is specified in the FieldOptions.HighlightMode property. The color used to highlight document fields is specified via the FieldOptions.HighlightColor property.

Related GitHub Examples

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

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-create-nested-fields-programmatically-e4004/CS/Form1.cs#L39

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

how-to-replace-document-fields-with-their-values-e3482/CS/Form1.cs#L15

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

utility-for-creating-a-mail-merge-template-e3661/CS/Form1.cs#L15

richEditControl1.Options.Fields.HighlightColor = Color.Yellow;
richEditControl1.Options.Fields.HighlightMode = FieldsHighlightMode.Always;
richEditControl1.Options.DocumentSaveOptions.CurrentFileName = Path.Combine(Application.StartupPath, "Template.rtf");

VB.NET

how-to-create-nested-fields-programmatically-e4004/VB/Form1.vb#L41

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

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

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

utility-for-creating-a-mail-merge-template-e3661/VB/Form1.vb#L17

richEditControl1.Options.Fields.HighlightColor = Color.Yellow
richEditControl1.Options.Fields.HighlightMode = FieldsHighlightMode.Always
richEditControl1.Options.DocumentSaveOptions.CurrentFileName = Path.Combine(Application.StartupPath, "Template.rtf")