Add-OfficeWordTableOfContent

Namespace PSWriteOffice

Inputs

OfficeIMO.Word.WordDocument

Outputs

OfficeIMO.Word.WordTableOfContent

Adds a table of contents to a Word document.

Remarks

Adds a table of contents to a Word document.

Examples

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