Get Started

API Reference

Cmdlet

Set-OfficeWordTableOfContents

Namespace PSWriteOffice
Inputs
OfficeIMO.Word.WordTableOfContent OfficeIMO.Word.WordDocument
Outputs
OfficeIMO.Word.WordTableOfContent
Source
Sources/PSWriteOffice/Cmdlets/Word/SetOfficeWordTableOfContentsCommand.cs:30 Edit on GitHub

Sets properties on a table of contents in a Word document.

Remarks

Sets properties on a table of contents in a Word document.

Examples

Authored help example

Customize table of contents text during composition.

PS>


New-OfficeWord -Path .\Report.docx {
                Add-OfficeWordTableOfContents
                Set-OfficeWordTableOfContents -Text 'Contents' -TextNoContent 'No entries yet'
                Add-OfficeWordParagraph -Text 'Executive summary' -Style Heading1
                Update-OfficeWordTableOfContents
            }

Updates TOC display text, adds heading content, and marks the TOC for refresh.

Update an existing TOC object from a document.

PS>


$doc = Get-OfficeWord -Path .\Report.docx
            $doc |
                Get-OfficeWordTableOfContents |
                Set-OfficeWordTableOfContents -Text 'Report contents'
            $doc | Save-OfficeWord -Path .\Report-Toc.docx

Pipes the OfficeIMO TOC object into the thin setter and saves the document.

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

Set-OfficeWordTableOfContents [-PassThru] [-TableOfContents <WordTableOfContent>] [-Text <String>] [-TextNoContent <String>] [<CommonParameters>]
#
Parameter set: TableOfContents

Parameters

PassThru SwitchParameter optionalposition: namedpipeline: False
Emit the updated table of contents.
TableOfContents WordTableOfContent optionalposition: namedpipeline: True (ByValue)
Table of contents to update.
Text String optionalposition: namedpipeline: False
Heading text for the table of contents.
TextNoContent String optionalposition: namedpipeline: False
Text shown when the table of contents has no entries.

Outputs

OfficeIMO.Word.WordTableOfContent

Set-OfficeWordTableOfContents [-Document <WordDocument>] [-PassThru] [-Text <String>] [-TextNoContent <String>] [<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.
Text String optionalposition: namedpipeline: False
Heading text for the table of contents.
TextNoContent String optionalposition: namedpipeline: False
Text shown when the table of contents has no entries.

Outputs

OfficeIMO.Word.WordTableOfContent