Document.IsDocumentProtected Property

Gets whether document protection is enabled.

Namespace: DevExpress.XtraRichEdit.API.Native

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

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

Declaration

C#

bool IsDocumentProtected { get; }

VB.NET

ReadOnly Property IsDocumentProtected As Boolean

Property Value

Type	Description
Boolean	true if document protection is enabled; otherwise, false.

Remarks

If document protection is enabled, then no content in this document is editable, except for the ranges with permission set. Document ranges containing permissions are editable by the users specified by the RangePermission.UserName property.

To enable or disable protection, use the ProtectDocumentCommand and the UnprotectDocumentCommand commands respectively.

Related GitHub Examples

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

word-document-api-examples/CS/CodeExamples/ProtectionActions.cs#L27

// Check whether the document is protected.
if (!document.IsDocumentProtected)
{

VB.NET

word-document-api-examples/VB/CodeExamples/ProtectionActions.vb#L27

' Check whether the document is protected.
If Not document.IsDocumentProtected Then
    ' Protect the document with a password.