pdftools_sdk.optimization.removal_options

Classes

RemovalOptions(handle)

The parameters defining the optional data to remove or flatten

class pdftools_sdk.optimization.removal_options.RemovalOptions(handle)[source]

Bases: _NativeObject

The parameters defining the optional data to remove or flatten

Removal options specify the PDF data structures to copy or remove, e.g. article threads, metadata, or alternate images.

In addition, the visual appearances of signatures, annotations, form fields, and links can be flattened.

Flattening means, that the appearance of such a data structure is drawn as non-editable graphic onto the page; for visual appearances of signatures, flattening has a slightly different meaning (see property pdftools_sdk.optimization.removal_options.RemovalOptions.remove_signature_appearances ).

property remove_alternate_images: bool

Whether to remove additional or alternative versions of images

Default is False except in the profile pdftools_sdk.optimization.profiles.print.Print .

Returns:: bool

property remove_article_threads: bool

Whether to remove the sequential flows (threads) of articles

Default is True except in the profile pdftools_sdk.optimization.profiles.archive.Archive .

Returns:: bool

property remove_metadata: bool

Whether to remove document’s XMP metadata

Default:

pdftools_sdk.optimization.profiles.web.Web profile: True
pdftools_sdk.optimization.profiles.print.Print profile: False
pdftools_sdk.optimization.profiles.archive.Archive profile: False
pdftools_sdk.optimization.profiles.minimal_file_size.MinimalFileSize profile: True
pdftools_sdk.optimization.profiles.mrc.Mrc profile: False

Returns:: bool

property remove_output_intents: bool

Whether to remove all output intents

Output intents provide a means for matching the color characteristics of PDF page content with those of a target output device or production environment in which the document will be printed.

Default is False except in the profile pdftools_sdk.optimization.profiles.minimal_file_size.MinimalFileSize .

Returns:: bool

property remove_piece_info: bool

Whether to remove the piece-info dictionary (private PDF processor data)

The removal of this proprietary application data has no effect on the document’s visual appearance.

Default is True except in the profile pdftools_sdk.optimization.profiles.archive.Archive .

Returns:: bool

property remove_structure_tree: bool

Whether to remove the data describing the logical structure of a PDF

The logical structure of the document is a description of the content of its pages. It consists of a fine granular hierarchical tagging that distinguishes between the actual content and artifacts (such as page numbers, layout artifacts, etc.). The tagging provides a meaningful description, for example “This is a header”, “This color image shows a small sailing boat at sunset”, etc. This information can be used e.g. to read the document to the visually impaired.

Default is True except in the profile pdftools_sdk.optimization.profiles.archive.Archive .