PdfiumFPDF_GetViewerPreferences Method

public static bool FPDF_GetViewerPreferences(
	IntPtr document,
	out bool hideToolbar,
	out bool hideMenubar,
	out bool hideWindowUI,
	out bool fitWindow,
	out bool centerWindow,
	out bool displayDocTitle,
	out bool pickTrayByPDFSize,
	out int numCopies,
	out string nonFullScreenPageMode,
	out string direction,
	out string viewArea,
	out string viewClip,
	out string printArea,
	out string printClip,
	out string printScaling,
	out string duplex,
	out int[] printPageRange
)

Public Shared Function FPDF_GetViewerPreferences ( 
	document As IntPtr,
	<OutAttribute> ByRef hideToolbar As Boolean,
	<OutAttribute> ByRef hideMenubar As Boolean,
	<OutAttribute> ByRef hideWindowUI As Boolean,
	<OutAttribute> ByRef fitWindow As Boolean,
	<OutAttribute> ByRef centerWindow As Boolean,
	<OutAttribute> ByRef displayDocTitle As Boolean,
	<OutAttribute> ByRef pickTrayByPDFSize As Boolean,
	<OutAttribute> ByRef numCopies As Integer,
	<OutAttribute> ByRef nonFullScreenPageMode As String,
	<OutAttribute> ByRef direction As String,
	<OutAttribute> ByRef viewArea As String,
	<OutAttribute> ByRef viewClip As String,
	<OutAttribute> ByRef printArea As String,
	<OutAttribute> ByRef printClip As String,
	<OutAttribute> ByRef printScaling As String,
	<OutAttribute> ByRef duplex As String,
	<OutAttribute> ByRef printPageRange As Integer()
) As Boolean

public:
static bool FPDF_GetViewerPreferences(
	IntPtr document, 
	[OutAttribute] bool% hideToolbar, 
	[OutAttribute] bool% hideMenubar, 
	[OutAttribute] bool% hideWindowUI, 
	[OutAttribute] bool% fitWindow, 
	[OutAttribute] bool% centerWindow, 
	[OutAttribute] bool% displayDocTitle, 
	[OutAttribute] bool% pickTrayByPDFSize, 
	[OutAttribute] int% numCopies, 
	[OutAttribute] String^% nonFullScreenPageMode, 
	[OutAttribute] String^% direction, 
	[OutAttribute] String^% viewArea, 
	[OutAttribute] String^% viewClip, 
	[OutAttribute] String^% printArea, 
	[OutAttribute] String^% printClip, 
	[OutAttribute] String^% printScaling, 
	[OutAttribute] String^% duplex, 
	[OutAttribute] array<int>^% printPageRange
)

static member FPDF_GetViewerPreferences : 
        document : IntPtr * 
        hideToolbar : bool byref * 
        hideMenubar : bool byref * 
        hideWindowUI : bool byref * 
        fitWindow : bool byref * 
        centerWindow : bool byref * 
        displayDocTitle : bool byref * 
        pickTrayByPDFSize : bool byref * 
        numCopies : int byref * 
        nonFullScreenPageMode : string byref * 
        direction : string byref * 
        viewArea : string byref * 
        viewClip : string byref * 
        printArea : string byref * 
        printClip : string byref * 
        printScaling : string byref * 
        duplex : string byref * 
        printPageRange : int[] byref -> bool 

public static boolean FPDF_GetViewerPreferences(
	IntPtr document,
	/** @attribute OutAttribute */ /** @ref */boolean hideToolbar,
	/** @attribute OutAttribute */ /** @ref */boolean hideMenubar,
	/** @attribute OutAttribute */ /** @ref */boolean hideWindowUI,
	/** @attribute OutAttribute */ /** @ref */boolean fitWindow,
	/** @attribute OutAttribute */ /** @ref */boolean centerWindow,
	/** @attribute OutAttribute */ /** @ref */boolean displayDocTitle,
	/** @attribute OutAttribute */ /** @ref */boolean pickTrayByPDFSize,
	/** @attribute OutAttribute */ /** @ref */int numCopies,
	/** @attribute OutAttribute */ /** @ref */String nonFullScreenPageMode,
	/** @attribute OutAttribute */ /** @ref */String direction,
	/** @attribute OutAttribute */ /** @ref */String viewArea,
	/** @attribute OutAttribute */ /** @ref */String viewClip,
	/** @attribute OutAttribute */ /** @ref */String printArea,
	/** @attribute OutAttribute */ /** @ref */String printClip,
	/** @attribute OutAttribute */ /** @ref */String printScaling,
	/** @attribute OutAttribute */ /** @ref */String duplex,
	/** @attribute OutAttribute */ /** @ref */int[] printPageRange
)

Patagames.Pdf.Pdfium.FPDF_GetViewerPreferences = function(document, hideToolbar, hideMenubar, hideWindowUI, fitWindow, centerWindow, displayDocTitle, pickTrayByPDFSize, numCopies, nonFullScreenPageMode, direction, viewArea, viewClip, printArea, printClip, printScaling, duplex, printPageRange);

Parameters

document  IntPtr

Handle to document. Returned by FPDF_LoadDocument(String, String) or FPDF_CreateNewDocument.

hideToolbar  Boolean

A flag specifying whether to hide the viewer application’s tool bars when the document is active. Default value: false.

hideMenubar  Boolean

A flag specifying whether to hide the viewer application’s menu bar when the document is active. Default value: false.

hideWindowUI  Boolean

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

fitWindow  Boolean

A flag specifying whether to resize the document’s window to fit the size of the first displayed page.Default value: false.

centerWindow  Boolean

A flag specifying whether to position the document’s window in the center of the screen.Default value: false.

displayDocTitle  Boolean

A flag specifying whether the window’s title bar should display the document title. If false, the title bar should instead display the name of the PDF file containing the document. Default value: false.

pickTrayByPDFSize  Boolean

A flag specifying whether the PDF page size is used to select the input paper tray. This setting influences only the preset values used to populate the print dialog presented by a PDF viewer application. If pickTrayByPDFSize is true, the check box in the print dialog associated with input paper tray is checked. This setting has no effect on Mac OS systems, which do not provide the ability to pick the input tray by size. Default value: as defined by the PDF viewer application

numCopies  Int32

The number of copies to be printed when the print dialog is opened for this file. Supported values are the integers 2 through 5. Values outside this range are ignored. Default value: as defined by PDF viewer application, but typically 1.

nonFullScreenPageMode  String

The document’s page mode, specifying how to display the document on exiting full-screen mode:

The nonFullScreenPageMode is meaningful only in the FullScreen mode; it is ignored otherwise. Default value: UseNone.

direction  String

The predominant reading order for text:

The direction 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. Default value: L2R.

viewArea  String

The name of the page boundary representing the area of a page to be displayed when viewing the document on the screen. Default value: CropBox.

Note
This parameter is intended primarily for use by prepress applications that interpret or manipulate the page boundaries. Most PDF consumer applications disregard it.

viewClip  String

The name of the page boundary to which the contents of a page are to be clipped when viewing the document on the screen. Default value: CropBox.

Note
This parameter is intended primarily for use by prepress applications that interpret or manipulate the page boundaries. Most PDF consumer applications disregard it.

printArea  String

The name of the page boundary representing the area of a page to be rendered when printing the document. Default value: CropBox.

Note
This parameter is intended primarily for use by prepress applications that interpret or manipulate the page boundaries. Most PDF consumer applications disregard it.

printClip  String

The name of the page boundary to which the contents of a page are to be clipped when printing the document. Default value: CropBox.

Note
This parameter is intended primarily for use by prepress applications that interpret or manipulate the page boundaries. Most PDF consumer applications disregard it.

printScaling  String

The page scaling option to be selected when a print dialog is displayed for this document. Valid values are None, which indicates that the print dialog should reflect no page scaling, and AppDefault, which indicates that applications should use the current print scaling. If this entry has an unrecognized value, applications should use the current print scaling. Default value: AppDefault.

Note
If the print dialog is suppressed and its parameters are provided directly by the application, the value of this parameter should still be used.

duplex  String

The paper handling option to use when printing the file from the print dialog.The following values are valid:

Default value: none.

printPageRange  Int32

The page numbers used to initialize the print dialog box when the file is printed. The first page of the PDF file is denoted by 1. Each pair consists of the first and last pages in the sub-range. An odd number of integers causes this parameter to be ignored. Negative numbers cause the entire array to be ignored. Default value: as defined by PDF viewer application.

Return Value

Reference