Skip to main content
SearchCtrl K
Community

Source code

OfficeIMO.NET libraries, PowerShell module, CLI, Studio and browser tools 622 stars

Talk and help

DiscordQuestions, ideas and show and tell Report an issueBugs and feature requests SponsorFund ongoing development

Mode

Background

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Search the whole siteOpen search page →
Documentation Search all OfficeIMO/
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

Guides & Samples

Authored walkthroughs and practical samples linked to this command.

  • Migrate from PSWritePDF to PSWriteOffice Guide

    Replace legacy PSWritePDF and iText-based scripts with maintained OfficeIMO PDF commands for authoring, extraction, forms, and merge.

  • Position Text and Graphics on PDF Pages Guide

    Choose between flowing PDF text, positioned stamps, arbitrary page canvases, and imported page overlays with explicit coordinates.

  • Pipeline, Object, and DSL Workflows Guide

    Choose the shortest PSWriteOffice surface for quick exports, incremental composition, complete document authoring, or existing-file updates.

  • PowerShell Document Recipes Guide

    Practical PSWriteOffice patterns for reports, presentations, PDF, CSV, Markdown, RTF, and document extraction. Includes examples and API links.

Examples

Authored help example

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.