Project

PSWriteOffice

PSWriteOffice is an open-source PowerShell and .NET project with packages, release history, and technical documentation.

View on GitHub Releases Get package

Stars 144

Forks 12

Open issues 16

PowerShell Gallery downloads 150,904

Release v0.2.0

Language: C# Updated: 2026-04-06

API Reference

Cmdlet

Add-OfficeWordTableOfContent

Namespace PSWriteOffice

Inputs

OfficeIMO.Word.WordDocument

Outputs

OfficeIMO.Word.WordTableOfContent

Source

Sources/PSWriteOffice/Cmdlets/Word/AddOfficeWordTableOfContentCommand.cs:18 Edit on GitHub

Adds a table of contents to a Word document.

Remarks

Adds a table of contents to a Word document.

Examples

Authored help example

Add a default table of contents.

PS>


Add-OfficeWordTableOfContent

Inserts a table of contents using the default template.

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.

Syntax

Add-OfficeWordTableOfContent [-Document <WordDocument>] [-PassThru] [-Style <Template1|Template2>] [<CommonParameters>]

Parameter set: All Parameter Sets

Parameters

Document WordDocument optionalposition: namedpipeline: True (ByValue): Document to modify when provided explicitly.
PassThru SwitchParameter optionalposition: namedpipeline: False: Emit the created table of contents.
Style TableOfContentStyle optionalposition: namedpipeline: Falsevalues: 2: Table of contents template style.; Possible values: Template1, Template2

Outputs

OfficeIMO.Word.WordTableOfContent