Foxit::PDF::Destination Class Reference

Class to represent destination data. More...

Public Member Functions

 Destination (Int32 pageIndex, ZoomMode zoomMode, const List< float >^params)
 Constructor to initialize a new instance of class PDF::Destination with specific values.
 

Properties

Int32 PageIndex
 A zero-based index for page.
 
ZoomMode ZoomMode
 Zoom mode. More...
 
List< float >^ Params
 A float array that represents parameters (at most 4 elements) used as the position and zoom factor inside the page. More...
 

Detailed Description

Class to represent destination data.

Property Documentation

List< float>^ Foxit::PDF::Destination::Params

A float array that represents parameters (at most 4 elements) used as the position and zoom factor inside the page.

In this array, there are at most 4 elements. "How many elements are in this array and what do they represent" depends on the value of Destination::ZoomMode:

  • ZoomMode::Factor: There are three elements in this array: The first element represents horizontal coordinate value of upper-left corner; the second element represents vertical coordinate value of upper-left corner; the third element represents the zoom factor.
    Specially, if value of the third element is 0, it means the zoom factor (which is currently used) should not be changed.
  • ZoomMode::FitPage: There is no element in this array and this array should be ignored and could be nullptr.
  • ZoomMode::FitWidth: There are only one element in this array and this element represents vertical coordinate of top edge.
  • ZoomMode::FitHeight: There are only one element in this array and this element represents horizontal coordinate of left edge.
  • ZoomMode::FitRect: There are four elements in this array. They represent the coordinate left/bottom/right/top in order of a rectangle, to which the page needs to be fit.
  • ZoomMode::FitContent: There is no element in this array and this array should be ignored and could be nullptr.
  • ZoomMode::FitContentWidth: There are only one element in this array and this element represents vertical coordinate of top edge.
  • ZoomMode::FitContentHeight: There are only one element in this array and this element represents horizontal coordinate of left edge.
ZoomMode Foxit::PDF::Destination::ZoomMode

Zoom mode.

Please refer to enumeration PDF::ZoomMode and this should be one of the values in this class.

Foxit Corporation