Vanilla.PDF  2.0.0
Cross-platform toolkit for creating and modifying PDF documents

A destination defines a particular view of a document. More...

Classes

class  DestinationHandle
 Base class for all destinations. More...
 
class  NamedDestinationsHandle
 A map of unique names mapped to their associated a DestinationHandle. More...
 

Enumerations

enum  DestinationType {
  DestinationType_Undefined = 0 , DestinationType_XYZ , DestinationType_Fit , DestinationType_FitHorizontal ,
  DestinationType_FitVertical , DestinationType_FitRectangle , DestinationType_FitBoundingBox , DestinationType_FitBoundingBoxHorizontal ,
  DestinationType_FitBoundingBoxVertical
}
 Available destination types. More...
 

Detailed Description

A destination defines a particular view of a document.

Consisting of the following items:

For more details please visit section 12.3.2 - Destinations.

Enumeration Type Documentation

◆ DestinationType

Available destination types.

Enumerator
DestinationType_XYZ 

Display the page designated by page, with the coordinates (left, top) positioned at the upper-left corner of the window and the contents of the page magnified by the factor zoom.

DestinationType_Fit 

Display 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.

DestinationType_FitHorizontal 

Display 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.

DestinationType_FitVertical 

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 the page within the window.

DestinationType_FitRectangle 

Display 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.

DestinationType_FitBoundingBox 

Display 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.

DestinationType_FitBoundingBoxHorizontal 

Display 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.

DestinationType_FitBoundingBoxVertical 

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.