Foxit PDF SDK
|
Public Member Functions | |
GetBottom () | |
Get bottom position value. More... | |
GetDestArray () | |
Get the destination PDF array. More... | |
GetLeft () | |
Get left position value. More... | |
GetPageIndex (document) | |
Get the index of the destination page. More... | |
GetRight () | |
Get right position value. More... | |
GetTop () | |
Get top position value. More... | |
GetZoomFactor () | |
Get zoom factor. More... | |
GetZoomMode () | |
Get the zoom mode. More... | |
IsEmpty () | |
Check whether current object is empty or not. More... | |
IsLeftNull () | |
Check if left value is a null object. More... | |
IsTopNull () | |
Check if top value is a null object. More... | |
Static Public Member Functions | |
static | CreateFitBBox (document, page_index) |
Create a destination object for zoom mode FSDK.Destination.e_ZoomFitBBox. More... | |
static | CreateFitBHorz (document, page_index, top) |
Create a destination object for zoom mode FSDK.Destination.e_ZoomFitBHorz. More... | |
static | CreateFitBVert (document, page_index, left) |
Create a destination object for zoom mode FSDK.Destination.e_ZoomFitBVert. More... | |
static | CreateFitHorz (document, page_index, top) |
Create a destination object for zoom mode FSDK.Destination.e_ZoomFitHorz. More... | |
static | CreateFitPage (document, page_index) |
Create a destination object for zoom mode FSDK.Destination.e_ZoomFitPage. More... | |
static | CreateFitRect (document, page_index, left, bottom, right, top) |
Create a destination object for zoom mode FSDK.Destination.e_ZoomFitRect. More... | |
static | CreateFitVert (document, page_index, left) |
Create a destination object for zoom mode FSDK.Destination.e_ZoomFitVert. More... | |
static | CreateFromPDFArray (document, opdf_array) |
Create a destination object from an existing destination array. More... | |
static | CreateXYZ (document, page_index, left, top, zoom_factor) |
Create a destination object for zoom mode FSDK.Destination.e_ZoomXYZ. More... | |
Static Public Attributes | |
static | e_ZoomFitBBox |
Fit the bounding box of page entirely within the display area when display the page. More... | |
static | e_ZoomFitBHorz |
Fit the entire width of the page's bounding box within the display area when display the page. More... | |
static | e_ZoomFitBVert |
Fit the entire height of the page's bounding box within the display area when display the page. More... | |
static | e_ZoomFitHorz |
Fit the entire width of the page within the display area when display the page. More... | |
static | e_ZoomFitPage |
Fit the entire page within the display area when display the page. More... | |
static | e_ZoomFitRect |
Fit the page content in a specified rectangle entirely within the display area when display the page. More... | |
static | e_ZoomFitVert |
Fit the entire height of the page within the display area when display the page. More... | |
static | e_ZoomXYZ |
Enumeration for zoom mode. More... | |
A destination defines a particular view of a PDF document, consisting of the following items:
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 modes, and get destination data.
|
static |
Create a destination object for zoom mode FSDK.Destination.e_ZoomFitBBox.
[in] | document | A valid PDF document object. |
[in] | page_index | The index of the destination page in the PDF document. |
|
static |
Create a destination object for zoom mode FSDK.Destination.e_ZoomFitBHorz.
[in] | document | A valid PDF document object. |
[in] | page_index | The index of the destination page in the PDF document. |
[in] | top | The vertical coordinate of top edge |
|
static |
Create a destination object for zoom mode FSDK.Destination.e_ZoomFitBVert.
[in] | document | A valid PDF document object. |
[in] | page_index | The index of the destination page in the PDF document. |
[in] | left | Horizontal coordinate of left edge. |
|
static |
Create a destination object for zoom mode FSDK.Destination.e_ZoomFitHorz.
[in] | document | A valid PDF document object. |
[in] | page_index | The index of the destination page in the PDF document. |
[in] | top | Vertical coordinate of top edge. |
|
static |
Create a destination object for zoom mode FSDK.Destination.e_ZoomFitPage.
[in] | document | A valid PDF document object. |
[in] | page_index | The index of the destination page in the PDF document. |
|
static |
Create a destination object for zoom mode FSDK.Destination.e_ZoomFitRect.
[in] | document | A valid PDF document object. |
[in] | page_index | The index of the destination page in the PDF document. |
[in] | left | The coordinate left of a rectangle. |
[in] | bottom | The coordinate bottom of a rectangle. |
[in] | right | The coordinate right of a rectangle. |
[in] | top | The coordinate top of a rectangle. |
|
static |
Create a destination object for zoom mode FSDK.Destination.e_ZoomFitVert.
[in] | document | A valid PDF document object. |
[in] | page_index | The index of the destination page in the PDF document. |
[in] | left | Horizontal coordinate of left edge. |
|
static |
Create a destination object from an existing destination array.
[in] | document | A valid PDF document object. |
[in] | pdf_array | A destination PDF array. This PDF array can be retrieved from a FSDK.PDFNameTree in type FSDK.PDFNameTree.e_Dests. |
|
static |
Create a destination object for zoom mode FSDK.Destination.e_ZoomXYZ.
[in] | document | A valid PDF document object. |
[in] | page_index | The index of the destination page in the PDF document. |
[in] | left | Horizontal coordinate value of a position as page's left-top position. |
[in] | top | Vertical coordinate value of a position as page's left-top position. |
[in] | zoom_factor | Zoom factor value. |
FSDK.Destination.GetBottom | ( | ) |
Get bottom position value.
This is only useful when zoom mode is FSDK.Destination.e_ZoomFitRect. For other zoom modes, this function will be 0.0f.
FSDK.Destination.GetDestArray | ( | ) |
Get the destination PDF array.
FSDK.Destination.GetLeft | ( | ) |
Get left position value.
This is only useful when zoom mode is FSDK.Destination.e_ZoomXYZ, FSDK.Destination.e_ZoomFitVert, FSDK.Destination.e_ZoomFitRect or FSDK.Destination.e_ZoomFitBVert. Specially for FSDK.Destination.e_ZoomXYZ, FSDK.Destination.e_ZoomFitVert and FSDK.Destination.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 FSDK.Destination.IsLeftNull.
For other zoom modes, this function will return 0.0f.
FSDK.Destination.GetPageIndex | ( | document | ) |
Get the index of the destination page.
[in] | document | A valid PDF document object. |
FSDK.Destination.GetRight | ( | ) |
Get right position value.
This is only useful when zoom mode is FSDK.Destination.e_ZoomFitRect. For other zoom modes, this function will be 0.0f.
FSDK.Destination.GetTop | ( | ) |
Get top position value.
This is only useful when zoom mode is FSDK.Destination.e_ZoomXYZ, FSDK.Destination.e_ZoomFitHorz, FSDK.Destination.e_ZoomFitBHorz or FSDK.Destination.e_ZoomFitRect. Specially for FSDK.Destination.e_ZoomXYZ, FSDK.Destination.e_ZoomFitHorz and FSDK.Destination.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 FSDK.Destination.IsTopNull.
For other zoom modes, this function will return 0.0f.
FSDK.Destination.GetZoomFactor | ( | ) |
Get zoom factor.
This is only useful when zoom mode is FSDK.Destination.e_ZoomXYZ. For FSDK.Destination.e_ZoomXYZ, if the zoom factor is 0, that means just use current zoom factor of application as the destination zoom factor.
For other zoom modes, this function will be 0.0f.
FSDK.Destination.GetZoomMode | ( | ) |
Get the zoom mode.
FSDK.Destination.IsEmpty | ( | ) |
Check whether current object is empty or not.
When the current object is empty, that means current object is useless.
FSDK.Destination.IsLeftNull | ( | ) |
Check if left value is a null object.
This is only useful when zoom mode is FSDK.Destination.e_ZoomXYZ, FSDK.Destination.e_ZoomFitVert or FSDK.Destination.e_ZoomFitBVert. This function can be used to check if the left value is a null object. For other zoom modes, this function will return false.
FSDK.Destination.IsTopNull | ( | ) |
Check if top value is a null object.
This is only useful when zoom mode is FSDK.Destination.e_ZoomXYZ, FSDK.Destination.e_ZoomFitHorz, or FSDK.Destination.e_ZoomFitBHorz. This function can be used to check if the top value is a null object. For other zoom modes, this function will return false.
|
static |
Fit the bounding box of page entirely within the display area when display the page.
If this is used, that means the contents of the page should be magnified just enough to fit its bounding box entirely within the display area 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 display area in the other dimension.
|
static |
Fit the entire width of the page's bounding box within the display area when display the page.
If this is used, that means the contents of the page should be magnified just enough to fit the entire width of the page's bounding box within the display area.
|
static |
Fit the entire height of the page's bounding box within the display area when display the page.
If this is used, that means the contents of the page should be magnified just enough to fit the entire height of the page's bounding box within the display area.
|
static |
Fit the entire width of the page within the display area when display the page.
If this is used, that means the contents of the page should be magnified just enough to fit the entire width of the page within the display area.
|
static |
Fit the entire page within the display area when display the page.
If this is used, that means the contents of the page should be magnified just enough to fit the entire page within the display area 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.
|
static |
Fit the page content in a specified rectangle entirely within the display area when display the page.
If this is used, that means the contents of the page should be magnified just enough to fit the page content in the specified rectangle entirely within the display area 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 display area in the other dimension.
|
static |
Fit the entire height of the page within the display area when display the page.
If this is used, that means the contents of the page should be magnified just enough to fit the entire height of the page within the display area.
|
static |
Enumeration for zoom mode.
Values of this enumeration should be used alone.
Display page with a specified position and a specified zoom factor.
If this is used, that means the specified position of the page will be treated as the left-top position when the page is rendered and this position should be at the upper-left corner of the display area. Contents of the page should be magnified by the specified zoom factor.