PDF Document

Represents a PDF document attachment for a Batch Folder, providing access to PDF-specific properties, metadata, and commands.

Remarks

The PDF Document attachment type enables Batch Folders to interact with PDF files (application/pdf), exposing properties such as version, page count, permissions, and embedded metadata.

Usage

Assign the PDF Document type to a Batch Folder by attaching a .pdf file. This enables display and extraction of PDF-specific properties and metadata.

Available Properties

• PdfVersion: The PDF specification version of the document.
• PageCount: The number of pages in the PDF.
• Permissions: Security and usage permissions embedded in the PDF.
• Metadata: Dictionary of all document metadata (title, author, etc.).
• FormData: Dictionary of AcroForm field values, if present.

Available Commands

The following commands are available for PDF attachments and can be used in batch workflows or from the context menu:

• Repair: Attempts to fix structural or content errors in the PDF. Optionally rasterizes pages if direct repair fails.
• Compact: Optimizes PDF file size by deduplicating resources and applying compression.
• Burst: Splits a PDF into multiple child documents using methods such as:
  • FixedPageCount: Split by a fixed number of pages.
  • Bookmarks: Split at specified bookmark levels.
  • TagBased: Split using regular expressions on page text.
  • PagePiece: Split at pages with specific PieceInfo dictionaries.
• RemoveAttachment (inherited): Deletes the locally-stored PDF attachment from the Batch Folder.
• RemovePdfVersion (inherited): Deletes the Grooper-generated PDF version from the Batch Folder.

Integration

The PDF Document type is automatically selected for files with the .pdf extension or application/pdf MIME type.

For more information on PDF standards and metadata, see PDF and PDF Reference.

Properties

Name	Type		Description
PDF Version	String	►	The PDF specification version of the document. Indicates the version of the PDF standard used to create the document (e.g., "1.4", "1.7"). This value is useful for compatibility checks and understanding available PDF features.
Page Count	Int32	►	The number of pages in the PDF document. Default0 Displays the total page count of the attached PDF file for this Batch Folder. Useful for navigation, splitting, or validation scenarios.
Permissions	PdfPermissions	►	The permissions embedded in the PDF document. DefaultNone A combination of the following flags: Name Value Description None 0 None Print 4 Allows printing of the document Modify 8 Allows modifications to the document CopyTextAndGraphics 16 Allows text and graphics to be copied from the document ModifyAnnotationsOrFields 32 Allows annotations and fields to be modified FillFields 256 Allows form fields to be filled in AccessibilityExtractTextAndGraphics 512 Allows text and graphics extraction for users with disabilities AssembleDocument 1024 Allow the insertion, rotation, or deletion of pages and creation of bookmarks and thumbnail images. PrintHighQuality 2048 Allows the highest possible quality printing of the document possible on the output device. Default 3900 The default permissions. Shows the set of security and usage permissions defined in the PDF, such as printing, copying, or modifying content. These permissions are enforced by PDF viewers and may restrict certain operations.
Metadata	Object - Dictionary(Of String, Object)[]	►	All metadata fields present in the PDF document. ConverterPg Dictionary Converter Returns a dictionary containing all standard and custom metadata fields from the PDF's document information dictionary. Common fields include Title, Author, Subject, Keywords, Creator, Producer, CreationDate, and ModDate. The dictionary keys are metadata field names, and values are the corresponding values. For more information, see the PDF Metadata specification.
Form Data	Object - Dictionary(Of String, Object)[]	►	All AcroForm field values present in the PDF document. ConverterPg Dictionary Converter Returns a dictionary containing the names and values of all interactive form fields (AcroForm) in the PDF. Keys are field names; values are the current field values. If the PDF does not contain forms, the dictionary will be empty. Useful for extracting user-entered data from fillable PDF forms.

Context Menu Commands

Command	Shortcut	Description
burst_mode Burst		Splits a PDF document into multiple smaller documents based on user-defined rules or content structure.
photo_size_select_small Compact		Reduces the size of a PDF file by removing duplicate resources and optimizing compression.
picture_as_pdf Repair		Repairs PDF files which contain minor errors.