Share via


DocumentBase.Unprotect(Object) Method

Definition

Removes protection from the document.

public void Unprotect (ref object password);
member this.Unprotect : obj -> unit
Public Sub Unprotect (Optional ByRef password As Object)

Parameters

password
Object

The password used to protect the document. Passwords are case-sensitive. If the document is protected with a password and the correct password is not supplied, a dialog box prompts the user for the password.

Examples

The following code example uses the Unprotect method to remove protection from the document. The example assumes that the password variable securelyStoredPassword was obtained from user input. To use this example, run it from the ThisDocument class in a document-level project.

private void DocumentUnprotect(ref object securelyStoredPassword)
{
    if (this.ProtectionType != Word.WdProtectionType.wdNoProtection)
    {
        this.Unprotect(ref securelyStoredPassword);
    }
}
Private Sub DocumentUnprotect(ByRef securelyStoredPassword As Object)
    If Me.ProtectionType <> Word.WdProtectionType.wdNoProtection Then
        Me.Unprotect(securelyStoredPassword)
    End If
End Sub

Remarks

Avoid using hard-coded passwords in your applications. If a password is required in a procedure, request the password from the user, store it in a variable, and then use the variable in your code.

If the document is not protected, an exception is thrown.

Optional Parameters

For information on optional parameters, see Optional Parameters in Office Solutions.

Applies to