Foxit PDF SDK
fsdk.DocViewerPrefs Class Reference

Public Member Functions

def GetDict ()
 Get PDF dictionary from current object.
More...
 
def GetNonFullScreenPageMode ()
 Get display mode which specifies how to display the document on exiting full-screen mode when document's display mode is full-screen.
More...
 
def GetPrintArea ()
 Get the page boundary representing the area of a page to be rendered when printing the document.
More...
 
def GetPrintClip ()
 Get the page boundary to which the contents of a page are to be clipped when printing the document.
More...
 
def GetPrintCopies ()
 Get the number of copies to be printed when the print dialog is opened for PDF document.
More...
 
def GetPrintRange ()
 Get page range information which is used to initialize the print dialog when the print dialog is opened for the PDF document.
More...
 
def GetPrintScale ()
 Get page scaling option to be selected when a print dialog is displayed for PDF document.
More...
 
def GetReadingDirection ()
 Get the predominant reading direction for text.
More...
 
def GetUIDisplayStatus (pref)
 Get UI display status of a specified viewer preference item type.
More...
 
def GetViewArea ()
 Get the page boundary representing the area of a page to be displayed when viewing the document on the screen.
More...
 
def GetViewClip ()
 Get the page boundary to which the contents of a page are to be clipped when viewing the document on the screen.
More...
 
def IsEmpty ()
 Check whether current object is empty or not.
More...
 
def SetNonFullScreenPageMode (display_mode)
 Set display mode which specifies how to display the document on exiting full-screen mode when document's display mode is full-screen.
More...
 
def SetPrintArea (box_type)
 Set the page boundary representing the area of a page to be rendered when printing the document.
More...
 
def SetPrintClip (box_type)
 Set the page boundary to which the contents of a page are to be clipped when printing the document.
More...
 
def SetPrintCopies (print_copies)
 Set the number of copies to be printed when the print dialog is opened for PDF document.
More...
 
def SetPrintRange (page_range)
 Set the page range which is used to initialize the print dialog when the print dialog is opened for the PDF document.
More...
 
def SetPrintScale (print_scale)
 Set page scaling option to be selected when a print dialog is displayed for PDF document.
More...
 
def SetReadingDirection (is_left_to_right)
 Set the predominant reading direction for text.
More...
 
def SetUIDisplayStatus (pref, value)
 Set UI display status of a specified viewer preference item type.
More...
 
def SetViewArea (box_type)
 Set the page boundary representing the area of a page to be displayed when viewing the document on the screen.
More...
 
def SetViewClip (box_type)
 Set the page boundary to which the contents of a page are to be clipped when viewing the document on the screen.
More...
 

Detailed Description

Viewer preferences defines the way that a document is to be presented on the screen or in print. This class should be constructed by a valid PDF document object. This class offers functions to get/set different part of a PDF document's viewer preferences, such as UI visibility, display mode for non full-screen mode, reading direction, the type of box item for specified purpose, some preference options used for print and so on.

See also
PDFDoc

Member Function Documentation

◆ GetDict()

def fsdk.DocViewerPrefs.GetDict ( )

Get PDF dictionary from current object.

Returns
The PDF dictionary. If there is any error, this function will return null.

◆ GetNonFullScreenPageMode()

def fsdk.DocViewerPrefs.GetNonFullScreenPageMode ( )

Get display mode which specifies how to display the document on exiting full-screen mode when document's display mode is full-screen.

This display mode is only useful when document's display mode is full-screen. Function fsdk.PDFDoc.GetDisplayMode can be used to check document's displaying mode.

Returns
Value of non full-screen mode. It would be one of following values:

◆ GetPrintArea()

def fsdk.DocViewerPrefs.GetPrintArea ( )

Get the page boundary representing the area of a page to be rendered when printing the document.

Returns
The page box type. Please refer to values starting from fsdk.PDFPageE_MediaBox and this would be one of these values.

◆ GetPrintClip()

def fsdk.DocViewerPrefs.GetPrintClip ( )

Get the page boundary to which the contents of a page are to be clipped when printing the document.

Returns
The page box type. Please refer to values starting from fsdk.PDFPageE_MediaBox and this would be one of these values.

◆ GetPrintCopies()

def fsdk.DocViewerPrefs.GetPrintCopies ( )

Get the number of copies to be printed when the print dialog is opened for PDF document.

Returns
The number of copies.

◆ GetPrintRange()

def fsdk.DocViewerPrefs.GetPrintRange ( )

Get page range information which is used to initialize the print dialog when the print dialog is opened for the PDF document.

All the indexes specified in the page range is from 0 to (pagecount - 1). If page range information is invalid, this function will throw exception fsdk.E_ErrFormat .

Returns
Page range.

◆ GetPrintScale()

def fsdk.DocViewerPrefs.GetPrintScale ( )

Get page scaling option to be selected when a print dialog is displayed for PDF document.

Returns
Page scaling option string value. Please refer to values starting from fsdk.DocViewerPrefsE_PrintScaleNone and this would be one of these values.

◆ GetReadingDirection()

def fsdk.DocViewerPrefs.GetReadingDirection ( )

Get the predominant reading direction for text.

The reading direction information has no direct effect on the document's contents or page numbering but can be used to determine the relative positioning of pages when displayed side by side or printed n-up (that is, multiple PDF pages are printed on a single page).

Returns
true means left-to-right reading order, while false means right-to-left reading order.

◆ GetUIDisplayStatus()

def fsdk.DocViewerPrefs.GetUIDisplayStatus (   pref)

Get UI display status of a specified viewer preference item type.

Parameters
[in]prefA viewer preference item type. Please refer to values starting from fsdk.DocViewerPrefsE_HideToolbar and this should be one of these values.
Returns
The value of the specified viewer preference item type.

◆ GetViewArea()

def fsdk.DocViewerPrefs.GetViewArea ( )

Get the page boundary representing the area of a page to be displayed when viewing the document on the screen.

Returns
The page box type. Please refer to values starting from fsdk.PDFPageE_MediaBox and this would be one of these values.

◆ GetViewClip()

def fsdk.DocViewerPrefs.GetViewClip ( )

Get the page boundary to which the contents of a page are to be clipped when viewing the document on the screen.

Returns
The page box type. Please refer to values starting from fsdk.PDFPageE_MediaBox and this would be one of these values.

◆ IsEmpty()

def fsdk.DocViewerPrefs.IsEmpty ( )

Check whether current object is empty or not.

When the current object is empty, that means current object is useless.

Returns
true means current object is empty, while false means not.

◆ SetNonFullScreenPageMode()

def fsdk.DocViewerPrefs.SetNonFullScreenPageMode (   display_mode)

Set display mode which specifies how to display the document on exiting full-screen mode when document's display mode is full-screen.

This display mode is only useful when document's display mode is full-screen. Function fsdk.PDFDoc.GetDisplayMode can be used to document's displaying mode.

Parameters
[in]display_modeNew display mode when exiting full-screen mode. It should be one of following values:
Returns
None.

◆ SetPrintArea()

def fsdk.DocViewerPrefs.SetPrintArea (   box_type)

Set the page boundary representing the area of a page to be rendered when printing the document.

Parameters
[in]box_typeThe page box type. Please refer to values starting from fsdk.PDFPageE_MediaBox and this should be one of these values.
Returns
None.

◆ SetPrintClip()

def fsdk.DocViewerPrefs.SetPrintClip (   box_type)

Set the page boundary to which the contents of a page are to be clipped when printing the document.

Parameters
[in]box_typeThe page box type. Please refer to values starting from fsdk.PDFPageE_MediaBox and this should be one of these values.
Returns
None.

◆ SetPrintCopies()

def fsdk.DocViewerPrefs.SetPrintCopies (   print_copies)

Set the number of copies to be printed when the print dialog is opened for PDF document.

Parameters
[in]print_copiesNew integer value for number of copies. Valid range: from 1 to 5. If input value is outside the valid range, Foxit PDF SDK will use 1 by default.
Returns
None.

◆ SetPrintRange()

def fsdk.DocViewerPrefs.SetPrintRange (   page_range)

Set the page range which is used to initialize the print dialog when the print dialog is opened for the PDF document.

Parameters
[in]page_rangeA range object that represents the new page range information. It should contain at least one valid range segment. All the indexes specified by this range should be from 0 to (pagecount - 1). pagecount is returned by function fsdk.PDFDoc.GetPageCount .
Returns
None.

◆ SetPrintScale()

def fsdk.DocViewerPrefs.SetPrintScale (   print_scale)

Set page scaling option to be selected when a print dialog is displayed for PDF document.

Parameters
[in]print_scaleNew page scaling option string. Please refer to values starting from fsdk.DocViewerPrefsE_PrintScaleNone and this should be one of these values.
Returns
None.

◆ SetReadingDirection()

def fsdk.DocViewerPrefs.SetReadingDirection (   is_left_to_right)

Set the predominant reading direction for text.

The reading direction information has no direct effect on the document's contents or page numbering but can be used to determine the relative positioning of pages when displayed side by side or printed n-up (that is, multiple PDF pages are printed on a single page).

Parameters
[in]is_left_to_rightThe new reading direction: true means left-to-right reading order, while false means right-to-left reading order.
Returns
None.

◆ SetUIDisplayStatus()

def fsdk.DocViewerPrefs.SetUIDisplayStatus (   pref,
  value 
)

Set UI display status of a specified viewer preference item type.

If the viewer preference item type does not existed before and has never been set, the value would be false by default.

Parameters
[in]prefA viewer preference item type. Please refer to values starting from fsdk.DocViewerPrefsE_HideToolbar and this should be one of these values.
[in]valueThe new value for the specified viewer preference item type.
Returns
None.

◆ SetViewArea()

def fsdk.DocViewerPrefs.SetViewArea (   box_type)

Set the page boundary representing the area of a page to be displayed when viewing the document on the screen.

Parameters
[in]box_typeThe page box type. Please refer to values starting from fsdk.PDFPageE_MediaBox and this should be one of these values.
Returns
None.

◆ SetViewClip()

def fsdk.DocViewerPrefs.SetViewClip (   box_type)

Set the page boundary to which the contents of a page are to be clipped when viewing the document on the screen.

Parameters
[in]box_typeThe page box type. Please refer to values starting from fsdk.PDFPageE_MediaBox and this should be one of these values.
Returns
None.