Destination Class |
A utility method used to set the fist page displayed after
the document is opened. This method is equivalent to
PDFDoc::SetOpenAction(goto_action)
If OpenAction is not specified the document should be
opened to the top of the first page at the default magnification
factor.
A destination defines a particular view of a document, consisting of the
following:
- The page of the document to be displayed
- The location of the document window on that page
- The magnification (zoom) factor to use when displaying the page
Inheritance HierarchyNamespace: pdftron.PDF
Assembly: pdftron (in pdftron.dll) Version: 255.255.255.255
Syntaxpublic sealed class Destination : IClosable
The Destination type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | Destination | Instantiates Destination from given SDF::Obj object
|
Methods| Name | Description | |
|---|---|---|
| Close | |
 | CreateFit | Create a new 'Fit' Destination.
The new Destination displays the page designated by 'page', with its contents
magnified just enough to fit the entire page within the window both
horizontally and vertically. If the required horizontal and vertical
magnification factors are different, use the smaller of the two, centering
the page within the window in the other dimension.
|
| CreateFitB | Create a new 'FitB' Destination.
The new Destination displays the page designated by 'page', with its
contents magnified just enough to fit its bounding box entirely within
the window both horizontally and vertically. If the required
horizontal and vertical magnification factors are different, use the
smaller of the two, centering the bounding box within the window in
the other dimension.
|
| CreateFitBH | Create a new 'FitBH' Destination.
The new Destination displays the page designated by 'page', with
the vertical coordinate 'top' positioned at the top edge of the window
and the contents of the page magnified just enough to fit the entire
width of its bounding box within the window.
|
| CreateFitBV | Create a new 'FitBV' Destination.
The new Destination displays Display the page designated by 'page',
with the horizontal coordinate 'left' positioned at the left edge of
the window and the contents of the page magnified just enough to fit
the entire height of its bounding box within the window.
|
| CreateFitH | Create a new 'FitH' Destination.
The new Destination displays the page designated by 'page', with the
vertical coordinate 'top' positioned at the top edge of the window and
the contents of the page magnified just enough to fit the entire width
of the page within the window.
|
| CreateFitR | Create a new 'FitR' Destination.
The new Destination displays the page designated by 'page', with its
contents magnified just enough to fit the rectangle specified by the
coordinates 'left', 'bottom', 'right', and 'top' entirely within the
window both horizontally and vertically. If the required horizontal
and vertical magnification factors are different, use the smaller of
the two, centering the rectangle within the window in the other
dimension.
|
| CreateFitV | Create a new 'FitV' Destination.
The new Destination displays the page designated by 'page', with the
horizontal coordinate 'left' positioned at the left edge of the window
and the contents of the page magnified just enough to fit the entire
height of the page within the window.
|
| CreateXYZ | Create a new 'XYZ' Destination.
The new Destination displays the page designated by 'page', with the
coordinates ('left', 'top') positioned at the top-left corner of the
window and the contents of the page magnified by the factor 'zoom'.
A null value for any of the parameters 'left', 'top', or 'zoom' specifies
that the current value of that parameter is to be retained unchanged.
A 'zoom' value of 0 has the same meaning as a null value.
|
| Equals | (Inherited from Object.) |
| GetExplicitDestObj | Gets the explicit dest obj.
|
| GetFitType | Gets the fit type.
|
| GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) |
| GetPage | Gets the page.
|
| GetSDFObj | Gets the SDFObj.
|
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| IsValid | Checks if is valid.
|
| Set | Sets value to given Destination object
|
| SetPage | Modify the destination so that it refers to the new 'page' as the destination page.
|
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
ExamplesDestination dest = Destination::CreateFit(page); pdfdoc.GetViewPrefs().SetInitialPage(dest);
See Also