│ Grooper Help - Version 25.0
25.0.0017 2,127
  • Overview
  • Help Status

Bookmark Options

Embedded Object Grooper.Core

Enables bookmarking of child documents and/or data elements when generating a PDF file.

Remarks

Overview

The Bookmark Options object controls the creation of PDF bookmarks during export or merge operations. Bookmarks are navigational aids that help users quickly locate and navigate to important sections, documents, or data elements within a PDF.

Types of Bookmarks

  • Document Bookmarks:
    Automatically generated for each child Document Type in a compound document. These bookmarks mirror the batch hierarchy and use the display name of each document, which can be customized using the 'Caption' property of a Content Type.

  • Data Bookmarks:
    Created for specific Data Elements (such as Data Sections, Data Tables, or Data Fields) defined in the 'Data Elements' property. These bookmarks allow users to jump directly to key data regions, such as sections, tables, or fields. The label for each bookmark is based on the display name of the element, and can be customized using the 'Caption' property.

Configuration

  • Assign a Bookmark Options object to the 'Bookmarking' property of a PDF Data Mapping behavior.
  • Use the 'Data Elements' property to select which Data Elements should have bookmarks generated.
  • Customize the appearance of bookmarks using the 'Label Style' and 'Label Color' properties.

Example Scenarios

  • Compound Document Navigation:
    Enable document bookmarks to allow users to quickly jump between multiple documents combined into a single PDF.

  • Section and Table Navigation:
    Add data bookmarks for important sections or tables, making it easy to locate transactions, summaries, or repeating data.

  • Custom Bookmark Styling:
    Use 'Label Style' and 'Label Color' to visually distinguish different types of bookmarks or to match organizational branding.

Notes

  • Bookmarks are hierarchical and can reflect the structure of the batch or data model.
  • The order and nesting of bookmarks are determined by the batch/document structure and the selected Data Elements.
  • If no Data Elements are selected, only document-level bookmarks will be created.
  • The label for each bookmark can be customized using the 'Caption' property on the corresponding Content Type or Data Section.

Properties

NameTypeDescription

See Also

Data ColumnData FieldData ModelData SectionData Table

Used By

PDF Data Mapping

Notification