Get-OfficePdfRedactionPlan

Namespace PSWriteOffice

Inputs

System.String

Outputs

OfficeIMO.Pdf.PdfRedactionPlan

Source

Sources/PSWriteOffice/Cmdlets/Pdf/GetOfficePdfRedactionPlanCommand.cs:17 Edit on GitHub

Previews text and annotations intersecting rectangle-based redaction areas.

Remarks

This command reports redaction impact only. It does not remove or rewrite PDF content.

Examples

Authored help example

Preview a redaction rectangle.

PS>


Get-OfficePdfRedactionPlan -Path .\Report.pdf -PageNumber 1 -X 72 -Y 650 -Width 240 -Height 32

Returns line-level text blocks and annotations that intersect the rectangle.

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

Get-OfficePdfRedactionPlan -Height <Double> [-Label <String>] -PageNumber <Int32> [-Password <String>] -Path <String> -Width <Double> -X <Double> -Y <Double> [<CommonParameters>]

Parameter set: Rectangle

Parameters

Height Double requiredposition: namedpipeline: False: Rectangle height in PDF points.
Label String optionalposition: namedpipeline: False: Optional redaction area label.
PageNumber Int32 requiredposition: namedpipeline: False: One-based page number for the redaction rectangle.
Password String optionalposition: namedpipeline: False: Password used to read a Standard password-encrypted PDF.
Path String requiredposition: 0pipeline: True (ByValue)aliases: FilePath: PDF file path.
Width Double requiredposition: namedpipeline: False: Rectangle width in PDF points.
X Double requiredposition: namedpipeline: False: Left coordinate in PDF points.
Y Double requiredposition: namedpipeline: False: Bottom coordinate in PDF points.

Outputs

OfficeIMO.Pdf.PdfRedactionPlan

Get-OfficePdfRedactionPlan -Area <PdfRedactionArea[]> [-Password <String>] -Path <String> [<CommonParameters>]

Parameter set: Area

Parameters

Area PdfRedactionArea[] requiredposition: namedpipeline: False: One or more pre-created OfficeIMO.Pdf redaction areas.
Password String optionalposition: namedpipeline: False: Password used to read a Standard password-encrypted PDF.
Path String requiredposition: 0pipeline: True (ByValue)aliases: FilePath: PDF file path.

Outputs

OfficeIMO.Pdf.PdfRedactionPlan