Cmdlet

ConvertTo-OfficePdfRedacted

Module PSWriteOffice

Inputs

System.String

Outputs

System.IO.FileInfo

Source

ConvertToOfficePdfRedactedCommand.cs:23 Edit on GitHub

Applies explicit or text-matched PDF redactions and writes a new PDF.

Syntax

ConvertTo-OfficePdfRedacted [-FillColor <String>] -Height <Double> [-IgnorePermissionRestrictions] [-Label <String>] [-OnlyPaintMatches] [-OutputPath] <String> -PageNumber <Int32> [-Password <String>] [-Path] <String> -Width <Double> -X <Double> -Y <Double> [<CommonParameters>]

Parameter set: Rectangle

ConvertTo-OfficePdfRedacted -Area <PdfRedactionArea[]> [-FillColor <String>] [-IgnorePermissionRestrictions] [-OnlyPaintMatches] [-OutputPath] <String> [-Password <String>] [-Path] <String> [<CommonParameters>]

Parameter set: Area

ConvertTo-OfficePdfRedacted [-FillColor <String>] [-IgnorePermissionRestrictions] [-MatchCase] [-OnlyPaintMatches] [-OutputPath] <String> [-Password <String>] [-Path] <String> -Text <String[]> [<CommonParameters>]

Parameter set: Text

Examples

Authored help example

Apply a redaction rectangle.

ConvertTo-OfficePdfRedacted -Path .\Report.pdf -OutputPath .\Report-Redacted.pdf -PageNumber 1 -X 72 -Y 650 -Width 240 -Height 32

Removes matching text objects and annotations in the rectangle, then paints a redaction mark.

Redact logical text blocks containing a value.

ConvertTo-OfficePdfRedacted -Path .\Report.pdf -OutputPath .\Report-Redacted.pdf -Text 'Account number'

Finds matching logical text blocks, removes their content, and paints the derived areas.

Parameters

-FillColor String optional: Redaction fill color. Named colors and hexadecimal values are accepted. Defaults to black.
-Height Double requiredsets: Rectangle: Rectangle height in PDF points.
-IgnorePermissionRestrictions SwitchParameter optional: After successful password authentication, explicitly ignore owner-imposed modification restrictions.
-Label String optionalsets: Rectangle: Optional redaction area label.
-OnlyPaintMatches SwitchParameter optional: Paint only areas that match text or annotations in the redaction plan.
-OutputPath String requiredposition: 1: Output PDF path.
-PageNumber Int32 requiredsets: Rectangle: One-based page number for the redaction rectangle.
-Password String optional: Password used to read a Standard password-encrypted PDF.
-Path String requiredposition: 0pipeline: True (ByValue)aliases: FilePath: Input PDF path.
-Width Double requiredsets: Rectangle: Rectangle width in PDF points.
-X Double requiredsets: Rectangle: Left coordinate in PDF points.
-Y Double requiredsets: Rectangle: Bottom coordinate in PDF points.
-Area PdfRedactionArea[] requiredsets: Area: One or more pre-created OfficeIMO.Pdf redaction areas.
-MatchCase SwitchParameter optionalsets: Text: Use case-sensitive literal text matching.
-Text String[] requiredsets: Text: Literal text used to derive redaction areas from matching logical text blocks.

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.