.NET Framework 4.5.2+
.NET Framework 4.5.2+
.NET Standard 2.0+

Document.Protect(String) Method

Protects a document with a given password.

Namespace: DevExpress.XtraRichEdit.API.Native

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

Declaration

void Protect(
    string password
)
Sub Protect(
    password As String
)

Parameters

Name Type Description
password String

A string that specifies a password for the document. If an empty string is specified, the document can be unprotected without a password.

Remarks

The Protect method prevents end users from modifying the document. This method overload enables the DocumentProtectionType.ReadOnly editing mode.

The Document.IsDocumentProtected property indicates whether the document is protected.

The password specified as the method's parameter is used to unlock the document in the UI using the Unprotect Document dialog.

To remove protection in code, call the Document.Unprotect method. It unlocks the document, ignoring the password.

The Protect method does not require user input. To allow end users to create a password to protect the document, execute the ProtectDocumentCommand command instead. Refer to the Restrictions and Protection topic for more details.

TIP

A complete sample project is available in the DevExpress Code Examples database at http://www.devexpress.com/example=E3017.

See Also