DocumentBase.Protect Method

Article
06/14/2013

Applies one of several types of protection to 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 Protect ( _
    type As WdProtectionType, _
    ByRef noReset As Object, _
    ByRef password As Object, _
    ByRef useIRM As Object, _
    ByRef enforceStyleLock As Object _
)

public void Protect(
    WdProtectionType type,
    ref Object noReset,
    ref Object password,
    ref Object useIRM,
    ref Object enforceStyleLock
)

Parameters

type
Type: WdProtectionType

The protection type for the specified document. WdProtectionType.

noReset
Type: System.Object%

false to reset form fields to their default values. true to retain the current form field values if the document is protected. If Type is not wdAllowOnlyFormFields, the NoReset argument is ignored.

password
Type: System.Object%

The password required to remove protection from the document. (See Remarks below.)

useIRM
Type: System.Object%

Specifies whether to use Information Rights Management (IRM) when protecting the document from changes.

enforceStyleLock
Type: System.Object%

Specifies whether formatting restrictions are enforced in a protected document.

Remarks

When a document is protected, users can make only limited changes, such as adding annotations, making revisions, or completing a form. If the document is already protected when you use this method, an exception is thrown.

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.

Optional Parameters

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

Examples

The following code example uses the Protect method to allow users to add only comments to the document. To use this example, run it from the ThisDocument class in a document-level project.

Private Sub DocumentProtect(ByRef securelyStoredPassword As Object)
    Me.Protect(Word.WdProtectionType.wdAllowOnlyComments, _
        Password:=securelyStoredPassword)
End Sub

private void DocumentProtect(ref object securelyStoredPassword)
{
    this.Protect(Word.WdProtectionType.wdAllowOnlyComments,
        ref missing, ref securelyStoredPassword, ref missing, 
        ref missing);
}

.NET Framework Security

Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.

Share via