ViewDestination Class

class ViewDestination : SystemIDisposable

Namespace:Datalogics::PDFL

Inherits from:: SystemIDisposable

Detailed Description

Represents a particular view of a page in a document.

A destination describes a place in the PDF document where the user will be taken in response to clicking a hyperlink. The destination defines where a bookmark or hyperlink points to.

The ViewDestination contains a reference to a page, a place (rectangle) on that page, and information specifying how to adjust the view to fit the window's size and shape.

Referenced by

Bookmark GoToAction LinkAnnotation

Uses types

Document PDFArray Rect

Constructor & Destructor Documentation

ViewDestination(Document doc, int pageNum, string fitType, Rect r, double zoom)

Parameters

doc: Document: Containing document
pageNum: int: Target page number
fitType: string: Fit Type must be: "XYZ", "Fit", "FitH", "FitV", "FitR", "FitB", "FitBH", or "FitBV".
r: Rect: Target rectangle
zoom: double: Zoom level

General purpose constructor: construct with all elements

Exceptions

ApplicationException: fitType could not be converted to a legal fit type atom.

Property Documentation

Rect DestRect[get, set]

The destination rectangle.

Coordinates with a value of NullValue indicate that the corresponding coordinate is not specified in the destination.

string FitType[get, set]

The fit type describing how the destination page is displayed.

The fit type determines how the page content is fitted into the window. Valid fit types are: "XYZ", "Fit", "FitH", "FitV", "FitR", "FitB", "FitBH", and "FitBV".

Exceptions

ApplicationException: fitType could not be converted to a legal fit type atom.

PDFArray PDFArray[get]

Retrieve the PDFArray representation of this ViewDestination.

int PageNumber[get, set]

The page number of the destination.

double Zoom[get, set]

The zoom factor for the destination.

A value of NullValue indicates that the zoom factor is not specified.

Field Documentation

static CViewDestination_NullValue

Constant used for "null" values in destination rectangles or zoom.

static NULL_VALUE

static NullValue

Member Function Documentation

void Dispose()

Returns:

void

override bool Equals(object obj)

Parameters

obj: object

Returns:

override bool

override string ToString()

Returns:

override string

A formatted string describing this ViewDestination.

Return a string representation of the ViewDestination.

The string includes the page number, fit type, destination rectangle, and zoom factor.