Cmdlet

New-OfficePdfRewriteOptions

Module: PSWriteOffice
Inputs: None
Outputs: OfficeIMO.Pdf.PdfRewritePreservationOptions
Source: NewOfficePdfRewriteOptionsCommand.cs:13 Edit on GitHub

Creates native PDF rewrite preservation checks for Test-OfficePdfRewrite.

Syntax

New-OfficePdfRewriteOptions
[-FormWidgetActions]
[-NoAnnotations]
[-NoCatalogActions]
[-NoCatalogViewSettings]
[-NoDocumentVersionState]
[-NoEmbeddedFiles]
[-NoForms]
[-NoLinkAnnotations]
[-NoMetadata]
[-NoNamedDestinations]
[-NoOpenAction]
[-NoOptionalContent]
[-NoOutlines]
[-NoOutputIntents]
[-NoPageActions]
[-NoPageCount]
[-NoPageGeometry]
[-NoPageLabels]
[-NoRevisionStructure]
[-NoSecurityState]
[-NoTaggedContent]
[-NoViewerPreferences]
[-NoXmpMetadata]
[<CommonParameters>]

Parameter set: Default

Examples

Permit a rewrite to update document metadata.

$options = New-OfficePdfRewriteOptions -NoMetadata -NoXmpMetadata
Test-OfficePdfRewrite -ReferencePath ./Original.pdf -DifferencePath ./Updated.pdf -Options $options -FailOnLoss

Parameters

-FormWidgetActions SwitchParameter optional: Require preservation of form field and widget actions.
-NoAnnotations SwitchParameter optional: Exclude annotations from preservation checks.
-NoCatalogActions SwitchParameter optional: Exclude catalog actions from preservation checks.
-NoCatalogViewSettings SwitchParameter optional: Exclude catalog view settings from preservation checks.
-NoDocumentVersionState SwitchParameter optional: Exclude document version state from preservation checks.
-NoEmbeddedFiles SwitchParameter optional: Exclude embedded files from preservation checks.
-NoForms SwitchParameter optional: Exclude forms from preservation checks.
-NoLinkAnnotations SwitchParameter optional: Exclude link annotations from preservation checks.
-NoMetadata SwitchParameter optional: Exclude metadata from preservation checks.
-NoNamedDestinations SwitchParameter optional: Exclude named destinations from preservation checks.
-NoOpenAction SwitchParameter optional: Exclude open action from preservation checks.
-NoOptionalContent SwitchParameter optional: Exclude optional content from preservation checks.
-NoOutlines SwitchParameter optional: Exclude outlines from preservation checks.
-NoOutputIntents SwitchParameter optional: Exclude output intents from preservation checks.
-NoPageActions SwitchParameter optional: Exclude page actions from preservation checks.
-NoPageCount SwitchParameter optional: Exclude page count from preservation checks.
-NoPageGeometry SwitchParameter optional: Exclude page geometry from preservation checks.
-NoPageLabels SwitchParameter optional: Exclude page labels from preservation checks.
-NoRevisionStructure SwitchParameter optional: Exclude revision structure from preservation checks.
-NoSecurityState SwitchParameter optional: Exclude security state from preservation checks.
-NoTaggedContent SwitchParameter optional: Exclude tagged content from preservation checks.
-NoViewerPreferences SwitchParameter optional: Exclude viewer preferences from preservation checks.
-NoXmpMetadata SwitchParameter optional: Exclude xmp metadata from preservation checks.

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.