UpdateLockedFields Enum

Lists options which determine how the Field.Locked property affects field updates.

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#

public enum UpdateLockedFields

VB.NET

Public Enum UpdateLockedFields

Members

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

Related API Members

The following properties accept/return UpdateLockedFields values:

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

Related API Members

The following properties accept/return UpdateLockedFields values:

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

Remarks

Normally, the Field.Locked property set true prevents a field from updating. However, you can specify the FieldOptions.UpdateLockedFields property value to update a locked field of any type, or a specific type (namely, the DOCVARIABLE field

Related GitHub Examples

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