Field.Locked Property

Gets or sets whether the field is locked, so that it cannot be updated automatically or by executing UI commands.

Namespace: DevExpress.XtraRichEdit.API.Native

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

NuGet Package: DevExpress.RichEdit.Core

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

Declaration

C#

bool Locked { get; set; }

VB.NET

Property Locked As Boolean

Property Value

Type	Description
Boolean	True, to lock the field; otherwise, false.

Remarks

Locked fields cannot be updated by calling the Field.Update or FieldCollection.Update methods. However, you can use the FieldOptions.UpdateLockedFields property to allow the control to update all locked fields or only DOCVARIABLE fields.

Example

View Example

Form1.cs

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

Form1.vb

richEditControl1.Document.Fields(0).Locked = True
richEditControl2.Options.Fields.UpdateLockedFields = UpdateLockedFields.Never

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the Locked 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#L29

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

word-document-api-use-docvariable-fields/CS/WordProcessingFileAPI_CalcDocumentVariable/Program.cs#L20

srv.Document.Fields[0].Locked = true;

VB.NET

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

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

word-document-api-use-docvariable-fields/VB/WordProcessingFileAPI_CalcDocumentVariable/Program.vb#L13

srv.LoadDocument("Docs\invitation.docx")
srv.Document.Fields(0).Locked = True
srv.Options.MailMerge.DataSource = New SampleData()