OfficeIMO

API Reference

Command

Set-OfficeWordTableOfContent

Namespace PSWriteOffice
Inputs
OfficeIMO.Word.WordTableOfContent OfficeIMO.Word.WordDocument
Outputs
OfficeIMO.Word.WordTableOfContent

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

Remarks

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

Examples

Update the table of contents headings.


PS>Set-OfficeWordTableOfContent -Text 'Contents' -TextNoContent 'No entries'

Updates the table of contents display text.

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-OfficeWordTableOfContent [-PassThru] [-TableOfContent <WordTableOfContent>] [-Text <String>] [-TextNoContent <String>] [<CommonParameters>]
#
Parameter set: TableOfContent

Parameters

PassThru SwitchParameter optionalposition: namedpipeline: False
Emit the updated table of contents.
TableOfContent 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-OfficeWordTableOfContent [-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