OfficeIMO

API Reference

Command

Get-OfficeWordBookmark

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

Gets bookmarks from a Word document.

Remarks

Gets bookmarks from a Word document.

Examples

List all bookmarks.


PS>Get-OfficeWordBookmark -Path .\Report.docx
        

Returns all bookmarks in 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

Get-OfficeWordBookmark -InputPath <String> [-Name <String[]>] [<CommonParameters>]
#
Parameter set: Path

Parameters

InputPath String requiredposition: 0pipeline: Falsealiases: FilePath, Path
Path to the .docx file.
Name String[] optionalposition: namedpipeline: False
Bookmark name filter (wildcards supported).

Outputs

OfficeIMO.Word.WordBookmark

Get-OfficeWordBookmark -Document <WordDocument> [-Name <String[]>] [<CommonParameters>]
#
Parameter set: Document

Parameters

Document WordDocument requiredposition: namedpipeline: True (ByValue)
Word document to read.
Name String[] optionalposition: namedpipeline: False
Bookmark name filter (wildcards supported).

Outputs

OfficeIMO.Word.WordBookmark