[]
        
(Showing Draft Content)

GrapeCity.Documents.Pdf.ViewerPreferences

Class ViewerPreferences

Namespace
GrapeCity.Documents.Pdf
Assembly
GcDocs.Pdf.dll

Represents viewer preferences to be used when displaying the document.

public class ViewerPreferences : PdfDictWrapper, IPdfDict
Inheritance
object
ViewerPreferences
Implements
Inherited Members
object.ToString()
object.Equals(object)
object.Equals(object, object)
object.ReferenceEquals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
Extension Methods

Properties

CenterWindow

Gets or sets whether to position the document's window in the center of the screen.

public bool CenterWindow { get; set; }

Property Value

bool

Direction

Gets or sets the predominant reading order for text.

public ReadingDirection Direction { get; set; }

Property Value

ReadingDirection

Remarks

This property 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.

DisplayDocTitle

Gets or sets whether the window's title bar should display the document title taken from the Title entry of the document information dictionary.

Default value: false.

public bool DisplayDocTitle { get; set; }

Property Value

bool

Doc

Gets the owning GcPdfDocument object.

public GcPdfDocument Doc { get; }

Property Value

GcPdfDocument

Duplex

Specifies the page scaling option to be selected when a print dialog is displayed for this document.

public Duplex? Duplex { get; set; }

Property Value

Duplex?

FitWindow

Gets or sets whether to resize the document's window to fit the size of the first displayed page.

public bool FitWindow { get; set; }

Property Value

bool

HideMenubar

Gets or sets whether to hide the viewer menu bar when the document is active.

public bool HideMenubar { get; set; }

Property Value

bool

HideToolbar

Gets or sets whether to hide the viewer tool bars when the document is active.

public bool HideToolbar { get; set; }

Property Value

bool

HideWindowUI

Gets or sets 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.

public bool HideWindowUI { get; set; }

Property Value

bool

NonFullScreenPageMode

Specifies how to display the document on exiting full-screen mode. Ignored unless PageMode is FullScreen.

public NonFullScreenPageMode NonFullScreenPageMode { get; set; }

Property Value

NonFullScreenPageMode

NumCopies

(PDF 1.7) 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.

public int? NumCopies { get; set; }

Property Value

int?

PageLayout

Gets or sets the page layout to be used when the document is opened.

[Obsolete("Use GcPdfDocument.PageLayout instead")]
public PageLayout? PageLayout { get; set; }

Property Value

PageLayout?

PageMode

Gets or sets how the document should be displayed when opened.

[Obsolete("Use GcPdfDocument.PageMode instead")]
public PageMode PageMode { get; set; }

Property Value

PageMode

PickTrayByPDFSize

(PDF 1.7) A flag specifying whether the PDF page size is used to select the input paper tray.

public bool? PickTrayByPDFSize { get; set; }

Property Value

bool?

PrintArea

Gets or sets the name of the page boundary representing the area of a page to be rendered when printing the document.

Default value: CropBox.

public PageBoundary PrintArea { get; set; }

Property Value

PageBoundary

PrintClip

Gets or sets the name of the page boundary to which the contents of a page are to be clipped when printing the document.

Default value: CropBox.

public PageBoundary PrintClip { get; set; }

Property Value

PageBoundary

PrintPageRange

(PDF 1.7) The page numbers used to initialize the print dialog box when the file is printed. This is a comma-delimited list of individual page numbers and/or dash-delimited page ranges.

Setting this property to a value that cannot be parsed will be ignored.

public OutputRange PrintPageRange { get; set; }

Property Value

OutputRange

PrintScaling

Specifies the page scaling option to be selected when a print dialog is displayed for this document.

public PrintScaling PrintScaling { get; set; }

Property Value

PrintScaling

ViewArea

Gets or sets 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.

public PageBoundary ViewArea { get; set; }

Property Value

PageBoundary

ViewClip

Gets or sets 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.

public PageBoundary ViewClip { get; set; }

Property Value

PageBoundary

Methods

Reset()

Resets properties of this ViewerPreferences to default values.

public void Reset()