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

Add-OfficePdfParagraph

Aliases: PdfParagraph
Module
PSWriteOffice
Aliases
PdfParagraph
Inputs
OfficeIMO.Pdf.PdfDocument
Outputs
OfficeIMO.Pdf.PdfDocument
Source
AddOfficePdfParagraphCommand.cs:20 Edit on GitHub

Adds a paragraph to a PDF document.

Syntax

Add-OfficePdfParagraph
[-Align <Left|Center|Right|Justify>]
[-Color <String>]
[-PassThru]
[-Text] <String>
[<CommonParameters>]
#
Parameter set: Context
Add-OfficePdfParagraph
[-Align <Left|Center|Right|Justify>]
[-Color <String>]
-Document <PdfDocument>
[-PassThru]
[-Text] <String>
[<CommonParameters>]
#
Parameter set: Document

Examples

Add body text to a generated PDF.

New-OfficePdf -Path .\Examples\Documents\PdfParagraph.pdf {
    Add-OfficePdfHeading -Text 'Status'
    Add-OfficePdfParagraph -Text 'All monitored services are currently healthy.' -Color '#166534'
}

Adds a colored body paragraph after a heading.

Parameters

-Align PdfAlign optional
Paragraph alignment.
Possible values: Left, Center, Right, Justify
-Color String optional
Optional text color. Named colors and hexadecimal values are accepted.
-PassThru SwitchParameter optional
Emit the updated document.
-Text String requiredposition: 0
Paragraph text.
-Document PdfDocument requiredpipeline: True (ByValue)sets: Document
PDF document to update outside the DSL context.

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.