Cmdlet

Add-OfficePdfBookmark

Aliases: PdfBookmark

Module PSWriteOffice

Aliases

PdfBookmark

Inputs

OfficeIMO.Pdf.PdfDocument

Outputs

OfficeIMO.Pdf.PdfDocument

Source

AddOfficePdfBookmarkCommand.cs:24 Edit on GitHub

Adds a named bookmark at the current generated PDF flow position.

Syntax

Add-OfficePdfBookmark [-Name] <String> [-PassThru] [<CommonParameters>]

Parameter set: Context

Add-OfficePdfBookmark -Document <PdfDocument> [-Name] <String> [-PassThru] [<CommonParameters>]

Parameter set: Document

Examples

Authored help example

Add a bookmark target and link to it.

New-OfficePdf -Path .\Examples\Documents\PdfBookmarks.pdf {
  Add-OfficePdfText -Run @(
    @{ Text = 'Jump to details'; LinkDestinationName = 'details'; Color = '#2563EB'; Underline = $true }
  )
  Add-OfficePdfPageBreak
  Add-OfficePdfBookmark -Name 'details'
  Add-OfficePdfHeading -Text 'Details' -Level 2
}

Creates an internal link target inside the generated PDF.

Parameters

-Name String requiredposition: 0: Bookmark name.
-PassThru SwitchParameter optional: Emit the updated document.
-Document PdfDocument requiredpipeline: True (ByValue)sets: Document: PDF document to update outside the DSL context.

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.