FieldOptions Class

Contains options used to define the appearance and behavior of the document fields.

Namespace: DevExpress.XtraRichEdit

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

NuGet Package: DevExpress.RichEdit.Core

Declaration

C#

[ComVisible(true)]
public class FieldOptions :
    RichEditNotificationOptions

VB.NET

<ComVisible(True)>
Public Class FieldOptions
    Inherits RichEditNotificationOptions

Related API Members

The following members return FieldOptions objects:

• RichEditControlOptionsBase.Fields

Example

The code snippet below demonstrates how to specify field options.

C#

using DevExpress.XtraRichEdit;
using DevExpress.XtraRichEdit.API.Native;
//...

using (RichEditDocumentServer wordProcessor = new RichEditDocumentServer())
{
    // Specify field options.
    FieldOptions fieldOptions = wordProcessor.Options.Fields;
    fieldOptions.HighlightMode = FieldsHighlightMode.Always;
    fieldOptions.HighlightColor = System.Drawing.Color.LightSalmon;
    fieldOptions.UseCurrentCultureDateTimeFormat = true;
    fieldOptions.ThrowExceptionOnInvalidFormatSwitch = true;
    fieldOptions.UpdateFieldsInTextBoxes = true;

    // Access a document.
    Document document = wordProcessor.Document;

    // Insert a text box in the document.
    Shape myTextBox = document.Shapes.InsertTextBox(document.Range.Start);

    // Access text box content.
    SubDocument textBoxDocument1 = myTextBox.ShapeFormat.TextBox.Document;

    // Create the "DATE" field.
    textBoxDocument.Fields.Create(textBoxDocument.Range.Start, "DATE");

    // Update the field.
    textBoxDocument.Fields.Update();
}

VB.NET

Imports DevExpress.XtraRichEdit
Imports DevExpress.XtraRichEdit.API.Native
'...

Using wordProcessor As New RichEditDocumentServer()
    ' Specify field options.
    Dim fieldOptions As FieldOptions = wordProcessor.Options.Fields
    fieldOptions.HighlightMode = FieldsHighlightMode.Always
    fieldOptions.HighlightColor = System.Drawing.Color.LightSalmon
    fieldOptions.UseCurrentCultureDateTimeFormat = True
    fieldOptions.ThrowExceptionOnInvalidFormatSwitch = True
    fieldOptions.UpdateFieldsInTextBoxes = True

    ' Access a document.
    Dim document As Document = wordProcessor.Document

    ' Insert a text box in the document.
    Dim myTextBox As Shape = document.Shapes.InsertTextBox(document.Range.Start)

    ' Access text box content.
    Dim textBoxDocument1 As SubDocument = myTextBox.ShapeFormat.TextBox.Document

    ' Create the "DATE" field.
    textBoxDocument.Fields.Create(textBoxDocument.Range.Start, "DATE")

    ' Update the field.
    textBoxDocument.Fields.Update()
End Using

Implements

INotifyPropertyChanged

Inheritance

Object

ViewStatePersisterCore

BaseOptions

RichEditNotificationOptions

FieldOptions