Add-OfficeWordTableOfContents

Namespace PSWriteOffice

Inputs

OfficeIMO.Word.WordDocument

Outputs

OfficeIMO.Word.WordTableOfContent

Source

Sources/PSWriteOffice/Cmdlets/Word/AddOfficeWordTableOfContentsCommand.cs:22 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 table of contents before report sections.

PS>


New-OfficeWord -Path .\ExecutiveReport.docx {
                Add-OfficeWordTableOfContents -Style Template1
                Add-OfficeWordParagraph -Text 'Executive summary' -Style Heading1
                Add-OfficeWordParagraph -Text 'Summary text'
                Add-OfficeWordParagraph -Text 'Appendix' -Style Heading1
                Add-OfficeWordParagraph -Text 'Supporting details'
                Update-OfficeWordTableOfContents
            }

Creates a navigable report outline and marks the TOC for refresh when the document opens.

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-OfficeWordTableOfContents [-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