ViewerPreferences Class

Contains viewer preference settings for a PDF document.

Declaration

public class ViewerPreferences extends JavaObject

Inherited Members

com.devexpress.system.JavaObject.clone()

com.devexpress.system.JavaObject.equals(java.lang.Object)

com.devexpress.system.JavaObject.hashCode()

com.devexpress.system.JavaObject.initFields()

com.devexpress.system.JavaObject.memberwiseClone()

com.devexpress.system.JavaObject.toString()

java.lang.Object.finalize()

java.lang.Object.getClass()

java.lang.Object.notify()

java.lang.Object.notifyAll()

java.lang.Object.wait()

java.lang.Object.wait(long)

java.lang.Object.wait(long,int)

Inheritance

Object

com.devexpress.system.JavaObject

ViewerPreferences

ViewerPreferences()

Initializes a new instance of the ViewerPreferences class.

Declaration

public ViewerPreferences()

Methods

getCenterWindow() Method

Returns whether the viewer centers the document window on screen.

Declaration

public boolean getCenterWindow()

Returns

Type	Description
boolean	true if the viewer centers the document window on screen; otherwise, false.

getDirection() Method

Returns the document reading direction.

Declaration

public ReadingDirection getDirection()

Returns

Type	Description
ReadingDirection	The document reading direction.

getDisplayDocTitle() Method

Returns whether the viewer displays the document title in the title bar.

Declaration

public boolean getDisplayDocTitle()

Returns

Type	Description
boolean	true if the viewer displays the document title in the title bar; otherwise, false.

getFitWindow() Method

Returns whether the viewer resizes the document window to fit the first page.

Declaration

public boolean getFitWindow()

Returns

Type	Description
boolean	true if the viewer resizes the document window to fit the first page; otherwise, false.

getHideMenuBar() Method

Returns whether the viewer hides the menu bar.

Declaration

public boolean getHideMenuBar()

Returns

Type	Description
boolean	true if the viewer hides the menu bar; otherwise, false.

getHideToolbar() Method

Returns whether the viewer hides the toolbar.

Declaration

public boolean getHideToolbar()

Returns

Type	Description
boolean	true if the viewer hides the toolbar; otherwise, false.

getHideWindowUI() Method

Returns whether the viewer hides user interface elements in the document window.

Declaration

public boolean getHideWindowUI()

Returns

Type	Description
boolean	true if the viewer hides user interface elements in the document window; otherwise, false.

getNonFullScreenPageMode() Method

Returns the page mode used after the viewer exits full-screen mode.

Declaration

public NonFullScreenPageMode getNonFullScreenPageMode()

Returns

Type	Description
NonFullScreenPageMode	The page mode used after the viewer exits full-screen mode.

getPickTrayByPDFSize() Method

Returns whether the viewer selects the print tray by PDF page size.

Declaration

public boolean getPickTrayByPDFSize()

Returns

Type	Description
boolean	true if the viewer selects the print tray by PDF page size; otherwise, false.

getPrintArea() Method

Returns the page boundary used as the print area.

Declaration

public ViewAreaBox getPrintArea()

Returns

Type	Description
ViewAreaBox	The page boundary used as the print area.

getPrintClip() Method

Returns the page boundary used as the print clipping area.

Declaration

public ViewAreaBox getPrintClip()

Returns

Type	Description
ViewAreaBox	The page boundary used as the print clipping area.

getPrintMode() Method

Returns the duplex print mode.

Declaration

public PrintDuplexMode getPrintMode()

Returns

Type	Description
PrintDuplexMode	The duplex print mode.

getPrintNumCopies() Method

Returns the number of print copies.

Declaration

public int getPrintNumCopies()

Returns

Type	Description
int	The number of print copies.

getPrintPageRange() Method

Returns the print page ranges.

Declaration

public List<PrintPageRange> getPrintPageRange()

Returns

Type	Description
java.util.List<PrintPageRange>	The print page ranges.

getPrintScaling() Method

Returns the print scaling mode.

Declaration

public PrintScalingMode getPrintScaling()

Returns

Type	Description
PrintScalingMode	The print scaling mode.

getViewArea() Method

Returns the page boundary used as the view area.

Declaration

public ViewAreaBox getViewArea()

Returns

Type	Description
ViewAreaBox	The page boundary used as the view area.

getViewClip() Method

Returns the page boundary used as the view clipping area.

Declaration

public ViewAreaBox getViewClip()

Returns

Type	Description
ViewAreaBox	The page boundary used as the view clipping area.

setCenterWindow(boolean value) Method

Sets whether the viewer centers the document window on screen.

Declaration

public void setCenterWindow(boolean value)

Parameters

Name	Type	Description
value	boolean	true to center the document window on screen; otherwise, false.

setDirection(ReadingDirection value) Method

Sets the document reading direction.

Declaration

public void setDirection(ReadingDirection value)

Parameters

Name	Type	Description
value	ReadingDirection	The document reading direction.

setDisplayDocTitle(boolean value) Method

Sets whether the viewer displays the document title in the title bar.

Declaration

public void setDisplayDocTitle(boolean value)

Parameters

Name	Type	Description
value	boolean	true to display the document title in the title bar; otherwise, false.

setFitWindow(boolean value) Method

Sets whether the viewer resizes the document window to fit the first page.

Declaration

public void setFitWindow(boolean value)

Parameters

Name	Type	Description
value	boolean	true to resize the document window to fit the first page; otherwise, false.

setHideMenuBar(boolean value) Method

Sets whether the viewer hides the menu bar.

Declaration

public void setHideMenuBar(boolean value)

Parameters

Name	Type	Description
value	boolean	true to hide the menu bar; otherwise, false.

setHideToolbar(boolean value) Method

Sets whether the viewer hides the toolbar.

Declaration

public void setHideToolbar(boolean value)

Parameters

Name	Type	Description
value	boolean	true to hide the toolbar; otherwise, false.

setHideWindowUI(boolean value) Method

Sets whether the viewer hides user interface elements in the document window.

Declaration

public void setHideWindowUI(boolean value)

Parameters

Name	Type	Description
value	boolean	true to hide user interface elements in the document window; otherwise, false.

setNonFullScreenPageMode(NonFullScreenPageMode value) Method

Sets the page mode used after the viewer exits full-screen mode.

Declaration

public void setNonFullScreenPageMode(NonFullScreenPageMode value)

Parameters

Name	Type	Description
value	NonFullScreenPageMode	The page mode used after the viewer exits full-screen mode.

setPickTrayByPDFSize(boolean value) Method

Sets whether the viewer selects the print tray by PDF page size.

Declaration

public void setPickTrayByPDFSize(boolean value)

Parameters

Name	Type	Description
value	boolean	true to select the print tray by PDF page size; otherwise, false.

setPrintArea(ViewAreaBox value) Method

Sets the page boundary used as the print area.

Declaration

public void setPrintArea(ViewAreaBox value)

Parameters

Name	Type	Description
value	ViewAreaBox	The page boundary used as the print area.

setPrintClip(ViewAreaBox value) Method

Sets the page boundary used as the print clipping area.

Declaration

public void setPrintClip(ViewAreaBox value)

Parameters

Name	Type	Description
value	ViewAreaBox	The page boundary used as the print clipping area.

setPrintMode(PrintDuplexMode value) Method

Sets the duplex print mode.

Declaration

public void setPrintMode(PrintDuplexMode value)

Parameters

Name	Type	Description
value	PrintDuplexMode	The duplex print mode.

setPrintNumCopies(int value) Method

Sets the number of print copies.

Declaration

public void setPrintNumCopies(int value)

Parameters

Name	Type	Description
value	int	The number of print copies.

setPrintPageRange(List<PrintPageRange> value) Method

Sets print page ranges.

Declaration

public void setPrintPageRange(List<PrintPageRange> value)

Parameters

Name	Type	Description
value	java.util.List<PrintPageRange>	Print page ranges.

setPrintScaling(PrintScalingMode value) Method

Sets the print scaling mode.

Declaration

public void setPrintScaling(PrintScalingMode value)

Parameters

Name	Type	Description
value	PrintScalingMode	The print scaling mode.

setViewArea(ViewAreaBox value) Method

Sets the page boundary used as the view area.

Declaration

public void setViewArea(ViewAreaBox value)

Parameters

Name	Type	Description
value	ViewAreaBox	The page boundary used as the view area.

setViewClip(ViewAreaBox value) Method

Sets the page boundary used as the view clipping area.

Declaration

public void setViewClip(ViewAreaBox value)

Parameters

Name	Type	Description
value	ViewAreaBox	The page boundary used as the view clipping area.