Cmdlet

Add-OfficeWordHeading

Aliases: WordHeading

Module: PSWriteOffice
Aliases: WordHeading
Inputs: OfficeIMO.Word.WordDocument
Outputs: OfficeIMO.Word.WordParagraph
Source: AddOfficeWordHeadingCommand.cs:45 Edit on GitHub

Adds a heading using the document's built-in heading, title or subtitle style.

Syntax

Add-OfficeWordHeading
[-Alignment <OfficeAlignment>]
[-Document <WordDocument>]
[-Level <WordHeadingLevel>]
[-PassThru]
[-Text] <String>
[<CommonParameters>]

Parameter set: Text

Add-OfficeWordHeading
[-Alignment <OfficeAlignment>]
[-Content] <ScriptBlock>
[-Document <WordDocument>]
[-Level <WordHeadingLevel>]
[-PassThru]
[<CommonParameters>]

Parameter set: Content

Description

Levels 1–9 participate in document navigation and tables of contents. A content block accepts WordText runs.

Examples

Add a heading hierarchy.

WordHeading 'Service review'
WordHeading 'Availability' -Level 2

Add a rich heading to a live document.

Add-OfficeWordHeading -Document $document -Level 2 { WordText 'Open incidents '; WordText '(3)' -Bold }

Parameters

-Alignment OfficeAlignment optional: Optional horizontal alignment.; Possible values: Left, Center, Right, Justify, Start, End
-Document WordDocument optionalpipeline: True (ByValue): Live document; omitted inside a Word content block.
-Level WordHeadingLevel optional: Heading level 1–9, Title or Subtitle. Defaults to Heading1.; Possible values: Heading1, Heading2, Heading3, Heading4, Heading5, Heading6, Heading7, Heading8, Heading9, Title, Subtitle
-PassThru SwitchParameter optional: Emit the object created or changed by the command.
-Text String requiredposition: 0sets: Text: Heading text.
-Content ScriptBlock requiredposition: 0sets: Content: Rich heading content composed with WordText.

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.