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-OfficePdfHeading

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

Adds a heading to a PDF document.

Syntax

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

Guides & Samples

Authored walkthroughs and practical samples linked to this command.

  • PSWriteOffice DSL Cookbook Guide

    Copy complete PowerShell recipes for Word, Excel, PowerPoint, PDF, Markdown, and multi-format document jobs.

  • Migrate from PSWritePDF to PSWriteOffice Guide

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

  • 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

Create heading levels in a PDF report.

New-OfficePdf -Path .\Examples\Documents\PdfHeadings.pdf {
  Add-OfficePdfHeading -Text 'Service Review' -Level 1 -Color '#1D4ED8'
  Add-OfficePdfHeading -Text 'Open risks' -Level 2
  Add-OfficePdfParagraph -Text 'Heading levels create the report structure.'
}

Adds report headings before body content.

Parameters

-Align PdfAlign optional
Heading alignment.
Possible values: Left, Center, Right, Justify
-Color String optional
Optional heading color. Named colors and hexadecimal values are accepted.
-Level Int32 optional
Heading level, 1 through 3.
-PassThru SwitchParameter optional
Emit the updated document.
-Text String requiredposition: 0
Heading 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.