DocumentBase.Unprotect Method

Removes protection from the document.

Namespace:  Microsoft.Office.Tools.Word
Assembly:  Microsoft.Office.Tools.Word.v4.0.Utilities (in Microsoft.Office.Tools.Word.v4.0.Utilities.dll)

Syntax

'Declaration
Public Sub Unprotect ( _
    ByRef password As Object _
)
public void Unprotect(
    ref Object password
)

Parameters

  • password
    Type: System.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.

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.

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

.NET Framework Security

See Also

Reference

DocumentBase Class

Microsoft.Office.Tools.Word Namespace