PdfDestination Class

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

Inheritance Hierarchy

SystemObject
SautinSoft.PdfPdfObject
SautinSoft.PdfPdfDestination

Namespace: SautinSoft.Pdf
Assembly: SautinSoft.Pdf (in SautinSoft.Pdf.dll) Version: 2024.8.8

Syntax

public sealed class PdfDestination : PdfObject

Public NotInheritable Class PdfDestination
	Inherits PdfObject

The PdfDestination type exposes the following members.

Properties

	Name	Description
	Bottom	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.
	Left	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.
	Metadata	(Optional; PDF 1.4) A metadata stream containing metadata for the component. (Inherited from PdfObject)
	Page	Gets or sets the destination PdfPage object. Specifying a destination explicitly in a PDF file, page is an indirect reference to a page object.
	PageNumber	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).
	Right	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.
	Top	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.
	ViewType	Gets the PdfDestinationViewType of this PdfDestination instance.
	Zoom	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.

Methods

	Name	Description
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object)
	GetHashCode	Serves as the default hash function. (Inherited from Object)
	GetType	Gets the Type of the current instance. (Inherited from Object)
	SetView	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.
	ToString	Returns a String that represents this PdfDestination instance. (Overrides ObjectToString)

Extension Methods

	Name	Description
	GetArray	Gets the PdfArray that serves as a backing storage of the specified PdfObject or if no PdfArray serves as a backing storage of the specified PdfObject. (Defined by PdfObjectExtensions)
	GetDictionary	Gets the PdfDictionary that serves as a backing storage of the specified PdfObject. (Defined by PdfObjectExtensions)
	GetOrAddDictionary	Gets the PdfDictionary that serves as a backing storage of the specified PdfObject. (Defined by PdfObjectExtensions)