Project

PSWriteOffice

PowerShell document automation across OfficeIMO's document, spreadsheet, presentation, PDF, Project, Access, EPUB, invoicing, and conversion engines.

View on GitHub Releases Get package
Stars 654
Forks 82
Open issues 1
Total downloads 4,320,051
Release OfficeIMO-v3.5.3
Language: C# Updated: 2026-11-03
Cmdlet

Clear-OfficePdfBackgroundShape

Module
PSWriteOffice
Inputs
OfficeIMO.Pdf.PdfDocument
Outputs
OfficeIMO.Pdf.PdfDocument
Source
ClearOfficePdfBackgroundShapeCommand.cs:20 Edit on GitHub

Clears generated PDF page background shapes.

Syntax

Clear-OfficePdfBackgroundShape
[-PassThru]
[<CommonParameters>]
#
Parameter set: Context
Clear-OfficePdfBackgroundShape
-Document <PdfDocument>
[-PassThru]
[<CommonParameters>]
#
Parameter set: Document

Examples

Remove queued background shapes during composition.

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.

Parameters

-PassThru SwitchParameter optional
Emit the updated document.
-Document PdfDocument requiredpipeline: True (ByValue)sets: Document
Compatibility parameter. Page composition is supported only inside New-OfficePdf.

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.