Skip to main content
SearchCtrl K
Community

Source code

OfficeIMO.NET libraries, PowerShell module, CLI, Studio and browser tools 700 stars

Talk and help

DiscordQuestions, ideas and show and tell Report an issueBugs and feature requests SponsorFund ongoing development

Mode

Background

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Search the whole siteOpen search page →
Documentation Search all OfficeIMO/
Cmdlet

New-OfficePdfEncryptionOptions

Module
PSWriteOffice
Inputs
None
Outputs
System.Collections.Hashtable
Source
NewOfficePdfEncryptionOptionsCommand.cs:13 Edit on GitHub

Creates PDF encryption settings; Protect-OfficeDocument supplies the actual passwords.

Syntax

New-OfficePdfEncryptionOptions
[-Algorithm <Aes256|Aes128|LegacyRc4>]
[-NoMetadataEncryption]
[<CommonParameters>]
#
Parameter set: Default

Examples

Select AES-256 while leaving metadata readable.

$options = New-OfficePdfEncryptionOptions -Algorithm Aes256 -NoMetadataEncryption
Protect-OfficeDocument -Path ./Report.pdf -Encrypt -Password $password -Options $options

Parameters

-Algorithm PdfStandardEncryptionAlgorithm optional
Native PDF Standard encryption algorithm.
Possible values: Aes256, Aes128, LegacyRc4
-NoMetadataEncryption SwitchParameter optional
Leave document metadata unencrypted.

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.