Set-OfficeWordTableOfContent.md

external help file	PSWriteOffice-help.xml
Module Name	PSWriteOffice
online version	https://github.com/EvotecIT/PSWriteOffice
schema	2.0.0

Set-OfficeWordTableOfContent

SYNOPSIS

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

SYNTAX

TableOfContent

Set-OfficeWordTableOfContent [-TableOfContent <WordTableOfContent>] [-Text <string>] [-TextNoContent <string>] [-PassThru] [<CommonParameters>]

Document

Set-OfficeWordTableOfContent [-Document <WordDocument>] [-Text <string>] [-TextNoContent <string>] [-PassThru] [<CommonParameters>]

DESCRIPTION

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

EXAMPLES

EXAMPLE 1

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

Updates the table of contents display text.

PARAMETERS

-Document

Document to update when provided explicitly.

Type: WordDocument
Parameter Sets: Document
Aliases: None
Possible values: 

Required: False
Position: named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: True

-PassThru

Emit the updated table of contents.

Type: SwitchParameter
Parameter Sets: TableOfContent, Document
Aliases: None
Possible values: 

Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: True

-TableOfContent

Table of contents to update.

Type: WordTableOfContent
Parameter Sets: TableOfContent
Aliases: None
Possible values: 

Required: False
Position: named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: True

-Text

Heading text for the table of contents.

Type: String
Parameter Sets: TableOfContent, Document
Aliases: None
Possible values: 

Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: True

-TextNoContent

Text shown when the table of contents has no entries.

Type: String
Parameter Sets: TableOfContent, Document
Aliases: None
Possible values: 

Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: True

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

• OfficeIMO.Word.WordTableOfContent OfficeIMO.Word.WordDocument

OUTPUTS

• OfficeIMO.Word.WordTableOfContent

RELATED LINKS

• None