Clear-OfficePdfBackgroundShape

Namespace PSWriteOffice

Inputs

OfficeIMO.Pdf.PdfDocument

Outputs

OfficeIMO.Pdf.PdfDocument

Source

Sources/PSWriteOffice/Cmdlets/Pdf/ClearOfficePdfBackgroundShapeCommand.cs:20 Edit on GitHub

Clears generated PDF page background shapes.

Remarks

Clears generated PDF page background shapes.

Examples

Authored help example

Remove queued background shapes during composition.

PS>


New-OfficePdf -Path .\Examples\Documents\PdfNoBackgroundShape.pdf {
                Add-OfficePdfBackgroundShape -Shape Rectangle -FillColor '#EEF2FF' -X 0 -Y 0 -Width 595 -Height 120
                Clear-OfficePdfBackgroundShape
                Add-OfficePdfHeading -Text 'Clean variant'
            }

Clears generated page background shapes while the PDF page is being composed.

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

Clear-OfficePdfBackgroundShape [-PassThru] [<CommonParameters>]

Parameter set: Context

Parameters

PassThru SwitchParameter optionalposition: namedpipeline: False: Emit the updated document.

Outputs

OfficeIMO.Pdf.PdfDocument

Clear-OfficePdfBackgroundShape -Document <PdfDocument> [-PassThru] [<CommonParameters>]

Parameter set: Document

Parameters

Document PdfDocument requiredposition: namedpipeline: True (ByValue): Compatibility parameter. Page composition is supported only inside New-OfficePdf with OfficeIMO 3.2.
PassThru SwitchParameter optionalposition: namedpipeline: False: Emit the updated document.

Outputs

OfficeIMO.Pdf.PdfDocument