OfficeIMO

API Reference

Command

Protect-OfficeWordDocument

Namespace PSWriteOffice
Inputs
OfficeIMO.Word.WordDocument
Outputs
System.Object

Protects a Word document with a password.

Remarks

Protects a Word document with a password.

Examples

Protect a document as read-only.


PS>Protect-OfficeWordDocument -Password 'secret'
        

Applies read-only protection to the current document.

Common Parameters

This command supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable.

For more information, see about_CommonParameters.

Syntax

Protect-OfficeWordDocument [-Document <WordDocument>] [-PassThru] -Password <String> [-ProtectionType <DocumentProtectionValues>] [<CommonParameters>]
#
Parameter set: All Parameter Sets

Parameters

Document WordDocument optionalposition: namedpipeline: True (ByValue)
Document to protect when provided explicitly.
PassThru SwitchParameter optionalposition: namedpipeline: False
Emit the protected document.
Password String requiredposition: 0pipeline: False
Password to apply.
ProtectionType DocumentProtectionValues optionalposition: namedpipeline: False
Protection type (defaults to ReadOnly).

Outputs

System.Object