Cmdlet

New-OfficePdfRedactionArea

Module: PSWriteOffice
Inputs: None
Outputs: OfficeIMO.Pdf.PdfRedactionArea
Source: NewOfficePdfRedactionAreaCommand.cs:16 Edit on GitHub

Creates a redaction area for Remove-OfficePdfContent and Get-OfficePdfRedactionPlan -Area.

Syntax

New-OfficePdfRedactionArea
-Height <OfficeLength>
[-Label <String>]
[-Page] <Int32>
-Width <OfficeLength>
-X <OfficeLength>
-Y <OfficeLength>
[<CommonParameters>]

Parameter set: Default

Examples

Use the native OfficePdfRedactionArea command.

$area = New-OfficePdfRedactionArea -Page 1 -X 2cm -Y 3cm -Width 8cm -Height 2cm -Label 'Signature'
Remove-OfficePdfContent -Path .\Contracts\Signed.pdf -OutputPath .\Contracts\Signed-Redacted.pdf -Area $area

Parameters

-Height OfficeLength required: Height for this operation.
-Label String optional: Label for this operation.
-Page Int32 requiredposition: 0: Page for this operation.
-Width OfficeLength required: Width for this operation.
-X OfficeLength required: X for this operation.
-Y OfficeLength required: Y for this operation.

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.