Remove-OfficeWordTableOfContents

Namespace PSWriteOffice

Inputs

OfficeIMO.Word.WordDocument

Outputs

System.Object

Source

Sources/PSWriteOffice/Cmdlets/Word/RemoveOfficeWordTableOfContentsCommand.cs:17 Edit on GitHub

Removes the table of contents from a Word document.

Remarks

Removes the table of contents from a Word document.

Examples

Authored help example

Remove a table of contents from an opened document.

PS>


$doc = Get-OfficeWord -Path .\Report.docx
            $doc | Remove-OfficeWordTableOfContents -PassThru |
                Save-OfficeWord -Path .\Report-NoToc.docx

Removes the TOC from an OfficeIMO document object and saves the changed document to a new file.

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

Remove-OfficeWordTableOfContents [-Document <WordDocument>] [-PassThru] [<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 document after removal.

Outputs

System.Object