Update-OfficeWordTableOfContent

Namespace PSWriteOffice

Inputs

OfficeIMO.Word.WordTableOfContent OfficeIMO.Word.WordDocument

Outputs

OfficeIMO.Word.WordTableOfContent

Updates the table of contents in a Word document.

Remarks

Updates the table of contents in a Word document.

Examples

Mark table of contents for refresh on open.


PS>Update-OfficeWordTableOfContent

Marks TOC fields as dirty and updates the document settings.

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

Update-OfficeWordTableOfContent [-PassThru] [-Regenerate] [-TableOfContent <WordTableOfContent>] [<CommonParameters>]

Parameter set: TableOfContent

Parameters

PassThru SwitchParameter optionalposition: namedpipeline: False: Emit the updated table of contents.
Regenerate SwitchParameter optionalposition: namedpipeline: False: Rebuild the table of contents before updating.
TableOfContent WordTableOfContent optionalposition: namedpipeline: True (ByValue): Table of contents to update.

Outputs

OfficeIMO.Word.WordTableOfContent

Update-OfficeWordTableOfContent [-Document <WordDocument>] [-PassThru] [-Regenerate] [<CommonParameters>]

Parameter set: Document

Parameters

Document WordDocument optionalposition: namedpipeline: True (ByValue): Document to update when provided explicitly.
PassThru SwitchParameter optionalposition: namedpipeline: False: Emit the updated table of contents.
Regenerate SwitchParameter optionalposition: namedpipeline: False: Rebuild the table of contents before updating.

Outputs

OfficeIMO.Word.WordTableOfContent