Public Types | |
enum | ZoomMode { ZoomMode.e_ZoomXYZ = 1, ZoomMode.e_ZoomFitPage = 2, ZoomMode.e_ZoomFitHorz = 3, ZoomMode.e_ZoomFitVert = 4, ZoomMode.e_ZoomFitRect = 5, ZoomMode.e_ZoomFitBBox = 6, ZoomMode.e_ZoomFitBHorz = 7, ZoomMode.e_ZoomFitBVert = 8 } |
Enumeration for zoom mode. More... | |
Public Member Functions | |
Destination (PDFArray dest_array) | |
Constructor, with a specified PDF array object. More... | |
Destination (Destination other) | |
Constructor, with another Destination object. More... | |
float | GetBottom () |
Get bottom position value. More... | |
PDFArray | GetDestArray () |
Get the destination PDF array. More... | |
float | GetLeft () |
Get left position value. More... | |
int | GetPageIndex (PDFDoc document) |
Get the index of the destination page. More... | |
float | GetRight () |
Get right position value. More... | |
float | GetTop () |
Get top position value. More... | |
float | GetZoomFactor () |
Get zoom factor. More... | |
Destination.ZoomMode | GetZoomMode () |
Get the zoom mode. More... | |
bool | IsEmpty () |
Check whether current object is empty or not. More... | |
bool | IsLeftNull () |
Check if left value is a null object. More... | |
bool | IsTopNull () |
Check if top value is a null object. More... | |
Static Public Member Functions | |
static Destination | CreateFitBBox (PDFDoc document, int page_index) |
Create a Destination object for zoom mode e_ZoomFitBBox. More... | |
static Destination | CreateFitBHorz (PDFDoc document, int page_index, float top) |
Create a Destination object for zoom mode e_ZoomFitBHorz. More... | |
static Destination | CreateFitBVert (PDFDoc document, int page_index, float left) |
Create a Destination object for zoom mode e_ZoomFitBVert. More... | |
static Destination | CreateFitHorz (PDFDoc document, int page_index, float top) |
Create a Destination object for zoom mode e_ZoomFitHorz. More... | |
static Destination | CreateFitPage (PDFDoc document, int page_index) |
Create a Destination object for zoom mode e_ZoomFitPage. More... | |
static Destination | CreateFitRect (PDFDoc document, int page_index, float left, float bottom, float right, float top) |
Create a Destination object for zoom mode e_ZoomFitRect. More... | |
static Destination | CreateFitVert (PDFDoc document, int page_index, float left) |
Create a Destination object for zoom mode e_ZoomFitVert. More... | |
static Destination | CreateFromPDFArray (PDFDoc document, PDFArray pdf_array) |
Create a Destination object from an existing destination array. More... | |
static Destination | CreateXYZ (PDFDoc document, int page_index, float left, float top, float zoom_factor) |
Create a Destination object for zoom mode e_ZoomXYZ. More... | |
A destination defines a particular view of a PDF document, consisting of the following items:
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.
Destinations may be associated with bookmarks, or some types of actions. In each case, the destination specifies the view of the document to be presented when the bookmark item or link annotation is opened or the action is performed.
This class offers functions to create destination objects for different zoom mode, and get destination data.
|
strong |
Enumeration for zoom mode.
Values of this enumeration should be used alone.
|
inline |
Constructor, with a specified PDF array object.
dest_array | A PDF array object that represents destination data. |
|
inline |
Constructor, with another Destination object.
other | Another Destination object. |
|
inlinestatic |
Create a Destination object for zoom mode e_ZoomFitBBox.
document | A valid PDF document object. |
page_index | The index of the destination page in the PDF document. |
|
inlinestatic |
Create a Destination object for zoom mode e_ZoomFitBHorz.
document | A valid PDF document object. |
page_index | The index of the destination page in the PDF document. |
top | The vertical coordinate of top edge |
|
inlinestatic |
Create a Destination object for zoom mode e_ZoomFitBVert.
document | A valid PDF document object. |
page_index | The index of the destination page in the PDF document. |
left | Horizontal coordinate of left edge. |
|
inlinestatic |
Create a Destination object for zoom mode e_ZoomFitHorz.
document | A valid PDF document object. |
page_index | The index of the destination page in the PDF document. |
top | Vertical coordinate of top edge. |
|
inlinestatic |
Create a Destination object for zoom mode e_ZoomFitPage.
document | A valid PDF document object. |
page_index | The index of the destination page in the PDF document. |
|
inlinestatic |
Create a Destination object for zoom mode e_ZoomFitRect.
document | A valid PDF document object. |
page_index | The index of the destination page in the PDF document. |
left | The coordinate left of a rectangle. |
bottom | The coordinate bottom of a rectangle. |
right | The coordinate right of a rectangle. |
top | The coordinate top of a rectangle. |
|
inlinestatic |
Create a Destination object for zoom mode e_ZoomFitVert.
document | A valid PDF document object. |
page_index | The index of the destination page in the PDF document. |
left | Horizontal coordinate of left edge. |
|
inlinestatic |
Create a Destination object from an existing destination array.
document | A valid PDF document object. |
pdf_array | A destination PDF array. This PDF array can be retrieved from a PDFNameTree in type e_Dests. |
|
inlinestatic |
Create a Destination object for zoom mode e_ZoomXYZ.
document | A valid PDF document object. |
page_index | The index of the destination page in the PDF document. |
left | Horizontal coordinate value of a position as page's left-top position. |
top | Vertical coordinate value of a position as page's left-top position. |
zoom_factor | Zoom factor value. |
|
inline |
Get bottom position value.
This is only useful when zoom mode is e_ZoomFitRect. For other zoom mode, this function will be 0.0f.
|
inline |
Get the destination PDF array.
|
inline |
Get left position value.
This is only useful when zoom mode is e_ZoomXYZ, e_ZoomFitVert, e_ZoomFitRect or e_ZoomFitBVert. Specially for e_ZoomXYZ, e_ZoomFitVert and e_ZoomFitBVert, left value may be a null object, which means that just use current left value of application as the destination's left value. For this case, this function will return 0.0f. In order to check if the left value is just 0 or a null object, user is recommended to call function Destination::IsLeftNull.
For other zoom mode, this function will return 0.0f.
|
inline |
Get the index of the destination page.
document | A valid PDF document object. |
|
inline |
Get right position value.
This is only useful when zoom mode is e_ZoomFitRect. For other zoom mode, this function will be 0.0f.
|
inline |
Get top position value.
This is only useful when zoom mode is e_ZoomXYZ, e_ZoomFitHorz, e_ZoomFitBHorz or e_ZoomFitRect. Specially for e_ZoomXYZ, e_ZoomFitHorz and e_ZoomFitBHorz, top value may be a null object, which means that just use current top value of application as the destination's top value. For this case, this function will return 0.0f. In order to check if the left value is just 0 or a null object, user is recommended to call function Destination::IsTopNull.
For other zoom mode, this function will return 0.0f.
|
inline |
|
inline |
Get the zoom mode.
|
inline |
Check whether current object is empty or not.
When the current object is empty, that means current object is useless.
|
inline |
Check if left value is a null object.
This is only useful when zoom mode is e_ZoomXYZ, e_ZoomFitVert or e_ZoomFitBVert. This function can be used to check if the left value is a null object. For other zoom mode, this function will return false.
|
inline |
Check if top value is a null object.
This is only useful when zoom mode is e_ZoomXYZ, e_ZoomFitHorz, or e_ZoomFitBHorz. This function can be used to check if the top value is a null object. For other zoom mode, this function will return false.