iText 7 7.1.9 API
iText.Kernel.Pdf.PdfViewerPreferences Class Reference
Inheritance diagram for iText.Kernel.Pdf.PdfViewerPreferences:
iText.Kernel.Pdf.PdfObjectWrapper< PdfDictionary >

Public Types

enum   PdfViewerPreferencesConstants {
  PdfViewerPreferencesConstants.USE_NONE, PdfViewerPreferencesConstants.USE_OUTLINES, PdfViewerPreferencesConstants.USE_THUMBS, PdfViewerPreferencesConstants.USE_OC,
  PdfViewerPreferencesConstants.LEFT_TO_RIGHT, PdfViewerPreferencesConstants.RIGHT_TO_LEFT, PdfViewerPreferencesConstants.MEDIA_BOX, PdfViewerPreferencesConstants.CROP_BOX,
  PdfViewerPreferencesConstants.BLEED_BOX, PdfViewerPreferencesConstants.TRIM_BOX, PdfViewerPreferencesConstants.ART_BOX, PdfViewerPreferencesConstants.VIEW_AREA,
  PdfViewerPreferencesConstants.VIEW_CLIP, PdfViewerPreferencesConstants.PRINT_AREA, PdfViewerPreferencesConstants.PRINT_CLIP, PdfViewerPreferencesConstants.NONE,
  PdfViewerPreferencesConstants.APP_DEFAULT, PdfViewerPreferencesConstants.SIMPLEX, PdfViewerPreferencesConstants.DUPLEX_FLIP_SHORT_EDGE, PdfViewerPreferencesConstants.DUPLEX_FLIP_LONG_EDGE
}
 

Public Member Functions

  PdfViewerPreferences (PdfDictionary pdfObject)
 
virtual PdfViewerPreferences  SetHideToolbar (bool hideToolbar)
  This method sets HideToolBar flag to true or false More...
 
virtual PdfViewerPreferences  SetHideMenubar (bool hideMenubar)
  This method sets HideMenuBar flag to true or false More...
 
virtual PdfViewerPreferences  SetHideWindowUI (bool hideWindowUI)
  This method sets HideWindowUI flag to true or false More...
 
virtual PdfViewerPreferences  SetFitWindow (bool fitWindow)
  This method sets FitWindow flag to true or false More...
 
virtual PdfViewerPreferences  SetCenterWindow (bool centerWindow)
  This method sets CenterWindow flag to true or false More...
 
virtual PdfViewerPreferences  SetDisplayDocTitle (bool displayDocTitle)
  This method sets DisplayDocTitle flag to true or false More...
 
virtual PdfViewerPreferences  SetNonFullScreenPageMode (PdfViewerPreferences.PdfViewerPreferencesConstants nonFullScreenPageMode)
  This method sets NonFullScreenPageMode property. More...
 
virtual PdfViewerPreferences  SetDirection (PdfViewerPreferences.PdfViewerPreferencesConstants direction)
  This method sets predominant reading order of text. More...
 
virtual PdfViewerPreferences  SetViewArea (PdfViewerPreferences.PdfViewerPreferencesConstants pageBoundary)
  This method sets the name of the page boundary representing the area of a page that shall be displayed when viewing the document on the screen. More...
 
virtual PdfViewerPreferences  SetViewClip (PdfViewerPreferences.PdfViewerPreferencesConstants pageBoundary)
  This method sets the name of the page boundary to which the contents of a page shall be clipped when viewing the document on the screen. More...
 
virtual PdfViewerPreferences  SetPrintArea (PdfViewerPreferences.PdfViewerPreferencesConstants pageBoundary)
  This method sets the name of the page boundary representing the area of a page that shall be rendered when printing the document. More...
 
virtual PdfViewerPreferences  SetPrintClip (PdfViewerPreferences.PdfViewerPreferencesConstants pageBoundary)
  This method sets the name of the page boundary to which the contents of a page shall be clipped when printing the document. More...
 
virtual PdfViewerPreferences  SetPrintScaling (PdfViewerPreferences.PdfViewerPreferencesConstants printScaling)
  This method sets the page scaling option that shall be selected when a print dialog is displayed for this document. More...
 
virtual PdfViewerPreferences  SetDuplex (PdfViewerPreferences.PdfViewerPreferencesConstants duplex)
  This method sets the paper handling option that shall be used when printing the file from the print dialog. More...
 
virtual PdfViewerPreferences  SetPickTrayByPDFSize (bool pickTrayByPdfSize)
  This method sets PickTrayByPDFSize flag to true or false. More...
 
virtual PdfViewerPreferences  SetPrintPageRange (int[] printPageRange)
  This method sets the page numbers used to initialize the print dialog box when the file is printed. More...
 
virtual PdfViewerPreferences  SetNumCopies (int numCopies)
  This method sets the number of copies that shall be printed when the print dialog is opened for this file. More...
 
virtual PdfViewerPreferences  SetEnforce (PdfArray enforce)
  PDF 2.0. More...
 
virtual PdfArray  GetEnforce ()
  PDF 2.0. More...
 
virtual PdfViewerPreferences  Put (PdfName key, PdfObject value)
 
- Public Member Functions inherited from iText.Kernel.Pdf.PdfObjectWrapper< PdfDictionary >
virtual T  GetPdfObject ()
 
virtual iText.Kernel.Pdf.PdfObjectWrapper< T >  MakeIndirect (PdfDocument document, PdfIndirectReference reference)
  Marks object behind wrapper to be saved as indirect. More...
 
virtual iText.Kernel.Pdf.PdfObjectWrapper< T >  MakeIndirect (PdfDocument document)
  Marks object behind wrapper to be saved as indirect. More...
 
virtual iText.Kernel.Pdf.PdfObjectWrapper< T >  SetModified ()
 
virtual void  Flush ()
 
virtual bool  IsFlushed ()
 

Member Enumeration Documentation

◆ PdfViewerPreferencesConstants

Enumerator
USE_NONE 

PageMode constant for PdfName.NonFullScreenPageMode.

USE_OUTLINES 

PageMode constant for PdfName.NonFullScreenPageMode.

USE_THUMBS 

PageMode constant for PdfName.NonFullScreenPageMode.

USE_OC 

PageMode constant for PdfName.NonFullScreenPageMode.

LEFT_TO_RIGHT 

Direction constant for PdfName.Direction.

RIGHT_TO_LEFT 

Direction constant for PdfName.Direction.

MEDIA_BOX 

PageBoundary constant for VIEW_AREA , VIEW_CLIP , PRINT_AREA , PRINT_CLIP.

CROP_BOX 

PageBoundary constant for VIEW_AREA , VIEW_CLIP , PRINT_AREA , PRINT_CLIP.

BLEED_BOX 

PageBoundary constant for VIEW_AREA , VIEW_CLIP , PRINT_AREA , PRINT_CLIP.

TRIM_BOX 

PageBoundary constant for VIEW_AREA , VIEW_CLIP , PRINT_AREA , PRINT_CLIP.

ART_BOX 

PageBoundary constant for VIEW_AREA , VIEW_CLIP , PRINT_AREA , PRINT_CLIP.

VIEW_AREA 

ViewArea constant.

VIEW_CLIP 

ViewClip constant.

PRINT_AREA 

PrintArea constant.

PRINT_CLIP 

PrintClip constant.

NONE 

Page scaling option constant for PdfName.PrintScaling.

APP_DEFAULT 

Page scaling option constant for PdfName.PrintScaling.

SIMPLEX 

The paper handling option constant for PdfName.Duplex.

DUPLEX_FLIP_SHORT_EDGE 

The paper handling option constant for PdfName.Duplex.

DUPLEX_FLIP_LONG_EDGE 

The paper handling option constant for PdfName.Duplex.

Member Function Documentation

◆ GetEnforce()

virtual PdfArray iText.Kernel.Pdf.PdfViewerPreferences.GetEnforce ( )
inlinevirtual

PDF 2.0.

PDF 2.0. Gets an array of names of Viewer preference settings that shall be enforced by PDF processors and that shall not be overridden by subsequent selections in the application user interface

Returns
array of names specifying settings to enforce in the PDF processors

◆ SetCenterWindow()

virtual PdfViewerPreferences iText.Kernel.Pdf.PdfViewerPreferences.SetCenterWindow ( bool  centerWindow )
inlinevirtual

This method sets CenterWindow flag to true or false

Parameters
centerWindow

◆ SetDirection()

virtual PdfViewerPreferences iText.Kernel.Pdf.PdfViewerPreferences.SetDirection ( PdfViewerPreferences.PdfViewerPreferencesConstants  direction )
inlinevirtual

This method sets predominant reading order of text.

Parameters
direction

◆ SetDisplayDocTitle()

virtual PdfViewerPreferences iText.Kernel.Pdf.PdfViewerPreferences.SetDisplayDocTitle ( bool  displayDocTitle )
inlinevirtual

This method sets DisplayDocTitle flag to true or false

Parameters
displayDocTitle

◆ SetDuplex()

virtual PdfViewerPreferences iText.Kernel.Pdf.PdfViewerPreferences.SetDuplex ( PdfViewerPreferences.PdfViewerPreferencesConstants  duplex )
inlinevirtual

This method sets the paper handling option that shall be used when printing the file from the print dialog.

This method sets the paper handling option that shall be used when printing the file from the print dialog. The following values are valid: Simplex, DuplexFlipShortEdge, DuplexFlipLongEdge.

Parameters
duplex

◆ SetEnforce()

virtual PdfViewerPreferences iText.Kernel.Pdf.PdfViewerPreferences.SetEnforce ( PdfArray  enforce )
inlinevirtual

PDF 2.0.

PDF 2.0. Sets an array of names of Viewer preference settings that shall be enforced by PDF processors and that shall not be overridden by subsequent selections in the application user interface

Parameters
enforce array of names specifying settings to enforce in the PDF processors
Returns
this PdfViewerPreferences instance

◆ SetFitWindow()

virtual PdfViewerPreferences iText.Kernel.Pdf.PdfViewerPreferences.SetFitWindow ( bool  fitWindow )
inlinevirtual

This method sets FitWindow flag to true or false

Parameters
fitWindow

◆ SetHideMenubar()

virtual PdfViewerPreferences iText.Kernel.Pdf.PdfViewerPreferences.SetHideMenubar ( bool  hideMenubar )
inlinevirtual

This method sets HideMenuBar flag to true or false

Parameters
hideMenubar

◆ SetHideToolbar()

virtual PdfViewerPreferences iText.Kernel.Pdf.PdfViewerPreferences.SetHideToolbar ( bool  hideToolbar )
inlinevirtual

This method sets HideToolBar flag to true or false

Parameters
hideToolbar

◆ SetHideWindowUI()

virtual PdfViewerPreferences iText.Kernel.Pdf.PdfViewerPreferences.SetHideWindowUI ( bool  hideWindowUI )
inlinevirtual

This method sets HideWindowUI flag to true or false

Parameters
hideWindowUI

◆ SetNonFullScreenPageMode()

virtual PdfViewerPreferences iText.Kernel.Pdf.PdfViewerPreferences.SetNonFullScreenPageMode ( PdfViewerPreferences.PdfViewerPreferencesConstants  nonFullScreenPageMode )
inlinevirtual

This method sets NonFullScreenPageMode property.

This method sets NonFullScreenPageMode property. Allowed values are UseNone, UseOutlines, useThumbs, UseOC. This entry is meaningful only if the value of the PageMode entry in the Catalog dictionary is FullScreen

Parameters
nonFullScreenPageMode

◆ SetNumCopies()

virtual PdfViewerPreferences iText.Kernel.Pdf.PdfViewerPreferences.SetNumCopies ( int  numCopies )
inlinevirtual

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

Parameters
numCopies

◆ SetPickTrayByPDFSize()

virtual PdfViewerPreferences iText.Kernel.Pdf.PdfViewerPreferences.SetPickTrayByPDFSize ( bool  pickTrayByPdfSize )
inlinevirtual

This method sets PickTrayByPDFSize flag to true or false.

Parameters
pickTrayByPdfSize

◆ SetPrintArea()

virtual PdfViewerPreferences iText.Kernel.Pdf.PdfViewerPreferences.SetPrintArea ( PdfViewerPreferences.PdfViewerPreferencesConstants  pageBoundary )
inlinevirtual

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

This method sets the name of the page boundary representing the area of a page that shall be rendered when printing the document. Deprecated in PDF 2.0.

Parameters
pageBoundary

◆ SetPrintClip()

virtual PdfViewerPreferences iText.Kernel.Pdf.PdfViewerPreferences.SetPrintClip ( PdfViewerPreferences.PdfViewerPreferencesConstants  pageBoundary )
inlinevirtual

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

This method sets the name of the page boundary to which the contents of a page shall be clipped when printing the document. Deprecated in PDF 2.0.

Parameters
pageBoundary

◆ SetPrintPageRange()

virtual PdfViewerPreferences iText.Kernel.Pdf.PdfViewerPreferences.SetPrintPageRange ( int[]  printPageRange )
inlinevirtual

This method sets the page numbers used to initialize the print dialog box when the file is printed.

Parameters
printPageRange

◆ SetPrintScaling()

virtual PdfViewerPreferences iText.Kernel.Pdf.PdfViewerPreferences.SetPrintScaling ( PdfViewerPreferences.PdfViewerPreferencesConstants  printScaling )
inlinevirtual

This method sets the page scaling option that shall be selected when a print dialog is displayed for this document.

This method sets the page scaling option that shall be selected when a print dialog is displayed for this document. Valid values are None and AppDefault.

Parameters
printScaling

◆ SetViewArea()

virtual PdfViewerPreferences iText.Kernel.Pdf.PdfViewerPreferences.SetViewArea ( PdfViewerPreferences.PdfViewerPreferencesConstants  pageBoundary )
inlinevirtual

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

This method sets the name of the page boundary representing the area of a page that shall be displayed when viewing the document on the screen. Deprecated in PDF 2.0.

Parameters
pageBoundary

◆ SetViewClip()

virtual PdfViewerPreferences iText.Kernel.Pdf.PdfViewerPreferences.SetViewClip ( PdfViewerPreferences.PdfViewerPreferencesConstants  pageBoundary )
inlinevirtual

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

This method sets the name of the page boundary to which the contents of a page shall be clipped when viewing the document on the screen. Deprecated in PDF 2.0.

Parameters
pageBoundary