FieldOptions.UpdateLockedFields Property

Gets or sets whether locked fields can be updated.

Namespace: DevExpress.XtraRichEdit

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

NuGet Packages: DevExpress.RichEdit.Core, DevExpress.Win.Navigation

Declaration

C#

[DefaultValue(UpdateLockedFields.Never)]
public UpdateLockedFields UpdateLockedFields { get; set; }

VB.NET

<DefaultValue(UpdateLockedFields.Never)>
Public Property UpdateLockedFields As UpdateLockedFields

Property Value

Type	Default	Description
UpdateLockedFields	Never	An UpdateLockedFields enumeration member that specifies what fields can be updated.

Available values:

Name	Description
Always	Locked fields are updated.
Never	Locked fields are not updated. Default value.
DocVariableOnly	Only DOCVARIABLE fields are updated.

Property Paths

You can access this nested property as listed below:

Object Type	Path to UpdateLockedFields
RichEditControlOptionsBase	.Fields .UpdateLockedFields

Remarks

Use the Field.Locked property to lock/unlock a field. The UpdateLockedFields option allows you to temporarily disable field lock for all fields, or for DOCVARIABLE fields only.

Example

The code sample below allows to update DOCVARIABLE fields and updates all field in the main document body.

View Example

Form1.cs

richEditControl2.Options.Fields.UpdateLockedFields = UpdateLockedFields.DocVariableOnly;
richEditControl2.Document.Fields.Update();

Form1.vb

richEditControl2.Options.Fields.UpdateLockedFields = UpdateLockedFields.DocVariableOnly
richEditControl2.Document.Fields.Update()

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the UpdateLockedFields 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-docvariable-fields/CS/DocumentVariablesExample/Form1.cs#L30

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

VB.NET

how-to-use-docvariable-fields/VB/DocumentVariablesExample/Form1.vb#L30

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