NAME¶

PDF::API2::ViewerPreferences - How the PDF should be displayed or printed

METHODS¶

$self = $class->new($pdf)

Creates a new ViewerPreferences object from a PDF::API2 object.

%preferences = $self->get_preferences()

Returns a hash containing all of the viewer preferences that are defined in the PDF.

$value = $self->get_preference($name)

Returns the value of the specified viewer preference if present, or "undef" if not.

$self->set_preferences(%values)

Sets one or more viewer preferences, as described in the preferences section below.

PREFERENCES¶

Viewer Preferences describe how the document should be presented on screen or in print. Not all PDF viewers will respect these preferences.

Boolean preferences default to false and take (or return) 0 or 1 as arguments.

Bounding Box preferences take (or return) one of "media_box", "crop_box", "bleed_box", "trim_box", or "art_box".

hide_toolbar (boolean)

A flag specifying whether to hide the tool bars when the document is active.

hide_menubar (boolean)

A flag specifying whether to hide the menu bar when the document is active.

hide_window_ui (boolean)

A flag specifying whether to hide the user interface elements in the document's window (such as scroll bars and navigation controls), leaving only the document's contents displayed.

fit_window (boolean)

A flag specifying whether to resize the document's window to fit the size of the first displayed page.

center_window (boolean)

A flag specifying whether to position the document's window in the center of the screen.

display_doc_title (boolean)

A flag specifying whether the window's title bar should display the document title taken from the Title entry of the document information directory. If false, the title bar should instead display the name of the PDF file containing the document.

non_full_screen_page_mode (name)

The document's page mode, specifying how to display the document on exiting full-screen mode. Options are the same as "page_mode" in PDF::API2 except that the "attachments" and "full_screen" options aren't supported.

direction ('l2r' or 'r2l')

The predominant reading order for text (left-to-right or right-to-left).

This entry has no direct effect on the document's contents or page numbering but may be used to determine the relative positioning of pages when displayed side-by-side or printed n-up.

view_area (bounding box)

The name of the page boundary representing the area of a page that shall be displayed when viewing the document on the screen.

view_clip (bounding box)

The name of the page boundary to which the contents of a page shall be clipped when viewing the document on the screen.

print_area (bounding box)

The name of the page boundary representing the area of a page that shall be rendered when printing the document.

print_clip (bounding box)

The name of the page boundary to which the contents of a page shall be clipped when printing the document.

print_scaling ('none' or 'app_default')

The page scaling option that shall be selected when a print dialog is displayed for this document. "none" represents no page scaling, and "app_default" represents the reader's default print scaling.

duplex ('simplex', 'duplex_short', or 'duplex_long')

The paper handling option that shall be used when printing the file from the print dialog. The duplex values represent whether the page should be flipped on its short edge or long edge, respectively.

pick_tray_by_pdf_size (boolean)

A flag specifying whether the PDF page size shall be used to select the input paper tray. This setting influences only the preset values used to populate the print dialog presented by the reader.

print_page_rage (an array of integer pairs)

The page numbers used to initialize the print dialog box when the file is printed. The array shall contain an even number of integers to be interpreted in pairs, with each pair specifying the first and last pages in a sub-range of pages to be printed. The first page of the PDF file shall be denoted by 1.

num_copies (integer)

The number of copies that shall be printed when the print dialog is opened for this file.