FieldOptions.UpdateFieldsInTextBoxes Property

Gets or sets whether the FieldCollection.Update method updates fields contained in text boxes.

Namespace: DevExpress.XtraRichEdit

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

NuGet Package: DevExpress.RichEdit.Core

NuGet Packages: DevExpress.RichEdit.Core, DevExpress.WindowsDesktop.RichEdit.Core

Declaration

C#

[DefaultValue(false)]
public bool UpdateFieldsInTextBoxes { get; set; }

VB.NET

<DefaultValue(False)>
Public Property UpdateFieldsInTextBoxes As Boolean

Property Value

Type	Default	Description
Boolean	**false**	True, to update fields contained in text boxes; otherwise, false.

Property Paths

You can access this nested property as listed below:

Library	Object Type	Path to UpdateFieldsInTextBoxes
WinForms Controls	SnapControlOptions	.Fields .UpdateFieldsInTextBoxes
	RichEditControlOptions	.Fields .UpdateFieldsInTextBoxes
WPF Controls	RichEditControlOptions	.Fields .UpdateFieldsInTextBoxes
Office File API	RichEditControlOptionsBase	.Fields .UpdateFieldsInTextBoxes

Remarks

When the UpdateFieldsInTextBoxes is set to true, the FieldCollection.Update method iterates through all text boxes in a document to update fields contained in text boxes.

To update fields in the main document, document header, etc. the FieldCollection.Update method should be explicitly invoked for the proper SubDocument.

Note

Switching on the UpdateFieldsInTextBoxes option can slow down field update process.