Back to Devexpress

Document.IsDocumentProtected Property

officefileapi-devexpress-dot-xtrarichedit-dot-api-dot-native-dot-document-df789153.md

latest3.3 KB
Original Source

Document.IsDocumentProtected Property

Gets whether document protection is enabled.

Namespace : DevExpress.XtraRichEdit.API.Native

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

NuGet Package : DevExpress.RichEdit.Core

Declaration

csharp
bool IsDocumentProtected { get; }
vb
ReadOnly Property IsDocumentProtected As Boolean

Property Value

TypeDescription
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.

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.

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

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

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

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

See Also

BeginUpdateRangePermissions()

ProtectDocumentCommand

UnprotectDocumentCommand

Document Interface

Document Members

DevExpress.XtraRichEdit.API.Native Namespace