Cmdlet

Set-OfficePdfPageBorder

Aliases: PdfPageBorder

Module: PSWriteOffice
Aliases: PdfPageBorder
Inputs: OfficeIMO.Pdf.PdfDocument
Outputs: OfficeIMO.Pdf.PdfDocument
Source: SetOfficePdfPageBorderCommand.cs:21 Edit on GitHub

Sets or clears the generated PDF page border decoration.

Syntax

Set-OfficePdfPageBorder
[-Clear]
[-Color <String>]
[-DashStyle <Solid|Dash|Dot|DashDot|DashDotDot>]
[-Inset <Double>]
[-Opacity <Double>]
[-PassThru]
[-Width <Double>]
[<CommonParameters>]

Parameter set: Context

Set-OfficePdfPageBorder
[-Clear]
[-Color <String>]
[-DashStyle <Solid|Dash|Dot|DashDot|DashDotDot>]
-Document <PdfDocument>
[-Inset <Double>]
[-Opacity <Double>]
[-PassThru]
[-Width <Double>]
[<CommonParameters>]

Parameter set: Document

Examples

Add a subtle page border.

New-OfficePdf -Path .\Examples\Documents\PdfPageBorder.pdf {
    Set-OfficePdfPageBorder -Color '#CBD5E1' -Width 0.75 -Inset 24 -Opacity 0.8
    Add-OfficePdfHeading -Text 'Bordered report'
}

Decorates generated pages with an OfficeIMO.Pdf page border.

Parameters

-Clear SwitchParameter optional: Clear the generated PDF page border decoration.
-Color String optional: Border color. Named colors and hexadecimal values are accepted.
-DashStyle OfficeStrokeDashStyle optional: Border dash style.; Possible values: Solid, Dash, Dot, DashDot, DashDotDot
-Inset Double optional: Distance from the page edge to the border path in PDF points.
-Opacity Double optional: Border opacity from 0 through 1.
-PassThru SwitchParameter optional: Emit the updated document.
-Width Double optional: Border stroke width in PDF points.
-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.