RichEditControlOptionsBase.Fields Property

Provides access to options specific to document fields.

Namespace: DevExpress.XtraRichEdit

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

Declaration

C#

public FieldOptions Fields { get; }

VB.NET

Public ReadOnly Property Fields As FieldOptions

Property Value

Type	Description
FieldOptions	A FieldOptions class instance containing options specific to fields.

Property Paths

You can access this nested property as listed below:

Library	Object Type	Path to Fields
WinForms Controls	SnapControl	.Options.Fields
	RichEditControl	.Options.Fields
WPF Controls	RichEditControl	.Options.Fields
Office File API	IRichEditDocumentServer	.Options.Fields
	RichEditDocumentServer	.Options.Fields
Reporting	SyntaxEditor	.Options.Fields

Remarks

Use the Fields property to get access to options which specify the color to highlight the fields and the conditions for highlighting.

To get access to the collection of fields in the current document, use the SubDocument.Fields property.

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the Fields 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#L30

richEditControl1.Document.Fields[0].Locked = true;
richEditControl2.Options.Fields.UpdateLockedFields = UpdateLockedFields.Never;
#endregion #lockfields

VB.NET

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

            richEditControl1.Document.Fields(0).Locked = True
            richEditControl2.Options.Fields.UpdateLockedFields = UpdateLockedFields.Never
'            #End Region ' #lockfields