pdftools_toolbox.pdf.page_copy_options

Classes

PageCopyOptions()

The PageCopyOptions determine how page resources are treated when copying a page from an input document to an output document using the pdftools_toolbox.pdf.page.Page.copy() and pdftools_toolbox.pdf.page_list.PageList.copy() methods.

class pdftools_toolbox.pdf.page_copy_options.PageCopyOptions[source]

Bases: _NativeObject

The PageCopyOptions determine how page resources are treated when copying a page from an input document to an output document using the pdftools_toolbox.pdf.page.Page.copy() and pdftools_toolbox.pdf.page_list.PageList.copy() methods.

__init__()[source]

property links: CopyStrategy

Copy strategy for links.

Specifies how links (document internal and external links) are treated when copying a page.

Default value: pdftools_toolbox.pdf.copy_strategy.CopyStrategy.COPY

Returns:: pdftools_toolbox.pdf.copy_strategy.CopyStrategy

property form_fields: FormFieldCopyStrategy

Copy strategy for form fields and widgets.

Specifies how form fields and widgets are treated when copying a page.

Default value: pdftools_toolbox.pdf.forms.form_field_copy_strategy.FormFieldCopyStrategy.COPY

Returns:: pdftools_toolbox.pdf.forms.form_field_copy_strategy.FormFieldCopyStrategy

property signed_signatures: RemovalStrategy

Removal strategy for signed signature fields.

Signed digital signatures are always invalidated when copying a page and therefore have to be removed. This property specifies, whether the visual representation of the signature is preserved.

Default value: pdftools_toolbox.pdf.removal_strategy.RemovalStrategy.REMOVE

Returns:: pdftools_toolbox.pdf.removal_strategy.RemovalStrategy

property unsigned_signatures: CopyStrategy

Copy strategy for unsigned signature fields.

Specifies how signature fields are treated, that are not yet signed.

Default value: pdftools_toolbox.pdf.copy_strategy.CopyStrategy.COPY

Returns:: pdftools_toolbox.pdf.copy_strategy.CopyStrategy

property annotations: CopyStrategy

Copy strategy for annotations.

Specifies how interactive annotations (like sticky notes or text highlights) are treated when copying a page. This does not include links, form fields and signature fields which are not considered annotations in this products.

Default value: pdftools_toolbox.pdf.copy_strategy.CopyStrategy.COPY

Returns:: pdftools_toolbox.pdf.copy_strategy.CopyStrategy

property copy_outline_items: bool

Copy outline items (bookmarks).

Specifies whether outline items (also known as bookmarks) pointing to the copied page should be copied to the target document automatically.

Default value: True

Returns:: bool

property copy_associated_files: bool

Copy associated files.

Specifies whether embedded files associated with a page or any of its subobjects are also copied when copying the page.

Default value: True

Returns:: bool

property copy_logical_structure: bool

Copy the logical structure and tagging information.

Specifies whether the logical structure and tagging information associated with a page or its content is also copied when copying the page.

This is required if the target document conformance is PDF/A Level a.

Default value: True

Returns:: bool

property form_field_conflict_resolution: NameConflictResolution

Resolution of conflicting form field names.

Form field of different files can have the same name (identifier). This property specifies how name conflicts are resolved, when copying pages from multiple source files.

Default value: pdftools_toolbox.pdf.name_conflict_resolution.NameConflictResolution.MERGE

Returns:: pdftools_toolbox.pdf.name_conflict_resolution.NameConflictResolution

property ocg_conflict_resolution: NameConflictResolution

Deprecated:: Deprecated in Version 1.0. Setting this property has no effect. When copying pages from multiple documents, layers (optional content groups, OCG) are always merged.

Returns:: pdftools_toolbox.pdf.name_conflict_resolution.NameConflictResolution

property named_destinations: NamedDestinationCopyStrategy

Copy strategy for named destinations

Specify whether named destinations are resolved when copying a page.

Default value: pdftools_toolbox.pdf.navigation.named_destination_copy_strategy.NamedDestinationCopyStrategy.COPY

Returns:: pdftools_toolbox.pdf.navigation.named_destination_copy_strategy.NamedDestinationCopyStrategy

property optimize_resources: bool

Find and merge redundant resources.

Find and merge redundant resources such as fonts and images. This can lead to much smaller files, especially when copying pages from multiple similar source files. However, it also decreases performance.

Default value: True

Returns:: bool

property do_not_copy_content: bool

Do not copy page content during duplication.

Controls whether graphical content is copied when duplicating pages. When false, all visual elements are copied. When true, only non-graphical content elements (annotations, metadata, etc.) are transferred to the new pages.

Default value: False

Returns:: bool