Click or drag to resize

PdfDestination Class

A destination defines a particular view of a document, consisting of the following items:

  • The page of the document that shall be displayed.
  • The location of the document window on that page.
  • The magnification (zoom) factor.
Inheritance Hierarchy

Namespace:  GemBox.Pdf
Assembly:  GemBox.Pdf (in GemBox.Pdf.dll) Version: 10.0.35.1002
Syntax
public sealed class PdfDestination : PdfObject

The PdfDestination type exposes the following members.

Properties
  NameDescription
Public propertyBottom
Gets or sets the vertical coordinate of the bottom-right corner of the window expressed in the default user space coordinate system or if the value is to be retained unchanged.
Public propertyLeft
Gets or sets the horizontal coordinate of the upper-left corner of the window expressed in the default user space coordinate system or if the value is to be retained unchanged.
Public propertyPage

Gets or sets the destination PdfPage object.

Specifying a destination explicitly in a PDF file, page is an indirect reference to a page object.

Public propertyPageNumber

Gets or sets the destination page number.

Should be used only in a context of a remote go-to action (see 12.6.4.3 Remote Go-To Actions).

Public propertyRight
Gets or sets the horizontal coordinate of the bottom-right corner of the window expressed in the default user space coordinate system or if the value is to be retained unchanged.
Public propertyTop
Gets or sets the vertical coordinate of the upper-left corner of the window expressed in the default user space coordinate system or if the value is to be retained unchanged.
Public propertyViewType
Gets the PdfDestinationViewType of this PdfDestination instance.
Public propertyZoom

Gets or sets the zoom factor or if the value is to be retained unchanged.

Value 1 represents 100%, 0.5 represents 50%, 1.5 represents 150%, etc.

Top
Methods
  NameDescription
Public methodSetView

Sets the view and the view's parameters where parameters represent the following values depending on the viewType parameter:

FitRectangle
Left, Bottom, Right and Top.
LeftTopZoom
Left, Top and Zoom.
FitPageVertical and FitContentVertical
Left.
FitPageHorizontal and FitContentHorizontal
Top.
FitPage and FitContent
None.
Public methodToString
Returns a String that represents this PdfDestination instance.
(Overrides ObjectToString.)
Top
Extension Methods
  NameDescription
Public Extension MethodGetDictionary
Gets the PdfDictionary that serves as a backing storage of the specified PdfObject.
(Defined by PdfObjectExtensions.)
Top
See Also