Foxit PDF SDK
|
Public Member Functions | |
def | Destination (other) |
Constructor, with another destination object. More... | |
def | GetBottom () |
Get bottom position value. More... | |
def | GetDestArray () |
Get the destination PDF array. More... | |
def | GetLeft () |
Get left position value. More... | |
def | GetPageIndex (document) |
Get the index of the destination page. More... | |
def | GetRight () |
Get right position value. More... | |
def | GetTop () |
Get top position value. More... | |
def | GetZoomFactor () |
Get zoom factor. More... | |
def | GetZoomMode () |
Get the zoom mode. More... | |
def | IsEmpty () |
Check whether current object is empty or not. More... | |
def | IsLeftNull () |
Check if left value is a null object. More... | |
def | IsTopNull () |
Check if top value is a null object. More... | |
Static Public Member Functions | |
def | CreateFitBBox (document, page_index) |
Create a destination object for zoom mode FoxitPDFSDKPython3.Destination.e_ZoomFitBBox . More... | |
def | CreateFitBHorz (document, page_index, top) |
Create a destination object for zoom mode FoxitPDFSDKPython3.Destination.e_ZoomFitBHorz . More... | |
def | CreateFitBVert (document, page_index, left) |
Create a destination object for zoom mode FoxitPDFSDKPython3.Destination.e_ZoomFitBVert . More... | |
def | CreateFitHorz (document, page_index, top) |
Create a destination object for zoom mode FoxitPDFSDKPython3.Destination.e_ZoomFitHorz . More... | |
def | CreateFitPage (document, page_index) |
Create a destination object for zoom mode FoxitPDFSDKPython3.Destination.e_ZoomFitPage . More... | |
def | CreateFitRect (document, page_index, left, bottom, right, top) |
Create a destination object for zoom mode FoxitPDFSDKPython3.Destination.e_ZoomFitRect . More... | |
def | CreateFitVert (document, page_index, left) |
Create a destination object for zoom mode FoxitPDFSDKPython3.Destination.e_ZoomFitVert . More... | |
def | CreateFromPDFArray (document, pdf_array) |
Create a destination object from an existing destination array. More... | |
def | CreateXYZ (document, page_index, left, top, zoom_factor) |
Create a destination object for zoom mode FoxitPDFSDKPython3.Destination.e_ZoomXYZ . More... | |
Static Public Attributes | |
e_ZoomFitBBox = _fsdk.Destination_e_ZoomFitBBox | |
Fit the bounding box of page entirely within the display area when display the page. More... | |
e_ZoomFitBHorz = _fsdk.Destination_e_ZoomFitBHorz | |
Fit the entire width of the page's bounding box within the display area when display the page. More... | |
e_ZoomFitBVert = _fsdk.Destination_e_ZoomFitBVert | |
Fit the entire height of the page's bounding box within the display area when display the page. More... | |
e_ZoomFitHorz = _fsdk.Destination_e_ZoomFitHorz | |
Fit the entire width of the page within the display area when display the page. More... | |
e_ZoomFitPage = _fsdk.Destination_e_ZoomFitPage | |
Fit the entire page within the display area when display the page. More... | |
e_ZoomFitRect = _fsdk.Destination_e_ZoomFitRect | |
Fit the page content in a specified rectangle entirely within the display area when display the page. More... | |
e_ZoomFitVert = _fsdk.Destination_e_ZoomFitVert | |
Fit the entire height of the page within the display area when display the page. More... | |
e_ZoomXYZ = _fsdk.Destination_e_ZoomXYZ | |
Display page with a specified position and a specified zoom factor. 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.
def FoxitPDFSDKPython3.Destination.Destination | ( | other | ) |
Constructor, with another destination object.
[in] | other | Another destination object. |
|
static |
Create a destination object for zoom mode FoxitPDFSDKPython3.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 FoxitPDFSDKPython3.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 FoxitPDFSDKPython3.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 FoxitPDFSDKPython3.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 FoxitPDFSDKPython3.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 FoxitPDFSDKPython3.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 FoxitPDFSDKPython3.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 FoxitPDFSDKPython3.PDFNameTree in type FoxitPDFSDKPython3.PDFNameTree.e_Dests . |
|
static |
Create a destination object for zoom mode FoxitPDFSDKPython3.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. |
def FoxitPDFSDKPython3.Destination.GetBottom | ( | ) |
Get bottom position value.
This is only useful when zoom mode is FoxitPDFSDKPython3.Destination.e_ZoomFitRect . For other zoom modes, this function will be 0.0f.
def FoxitPDFSDKPython3.Destination.GetDestArray | ( | ) |
Get the destination PDF array.
def FoxitPDFSDKPython3.Destination.GetLeft | ( | ) |
Get left position value.
This is only useful when zoom mode is FoxitPDFSDKPython3.Destination.e_ZoomXYZ , FoxitPDFSDKPython3.Destination.e_ZoomFitVert , FoxitPDFSDKPython3.Destination.e_ZoomFitRect or FoxitPDFSDKPython3.Destination.e_ZoomFitBVert . Specially for FoxitPDFSDKPython3.Destination.e_ZoomXYZ , FoxitPDFSDKPython3.Destination.e_ZoomFitVert and FoxitPDFSDKPython3.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 FoxitPDFSDKPython3.Destination.IsLeftNull .
For other zoom modes, this function will return 0.0f.
def FoxitPDFSDKPython3.Destination.GetPageIndex | ( | document | ) |
Get the index of the destination page.
[in] | document | A valid PDF document object. |
def FoxitPDFSDKPython3.Destination.GetRight | ( | ) |
Get right position value.
This is only useful when zoom mode is FoxitPDFSDKPython3.Destination.e_ZoomFitRect . For other zoom modes, this function will be 0.0f.
def FoxitPDFSDKPython3.Destination.GetTop | ( | ) |
Get top position value.
This is only useful when zoom mode is FoxitPDFSDKPython3.Destination.e_ZoomXYZ , FoxitPDFSDKPython3.Destination.e_ZoomFitHorz , FoxitPDFSDKPython3.Destination.e_ZoomFitBHorz or FoxitPDFSDKPython3.Destination.e_ZoomFitRect . Specially for FoxitPDFSDKPython3.Destination.e_ZoomXYZ , FoxitPDFSDKPython3.Destination.e_ZoomFitHorz and FoxitPDFSDKPython3.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 FoxitPDFSDKPython3.Destination.IsTopNull .
For other zoom modes, this function will return 0.0f.
def FoxitPDFSDKPython3.Destination.GetZoomFactor | ( | ) |
Get zoom factor.
This is only useful when zoom mode is FoxitPDFSDKPython3.Destination.e_ZoomXYZ . For FoxitPDFSDKPython3.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.
def FoxitPDFSDKPython3.Destination.GetZoomMode | ( | ) |
Get the zoom mode.
def FoxitPDFSDKPython3.Destination.IsEmpty | ( | ) |
Check whether current object is empty or not.
When the current object is empty, that means current object is useless.
def FoxitPDFSDKPython3.Destination.IsLeftNull | ( | ) |
Check if left value is a null object.
This is only useful when zoom mode is FoxitPDFSDKPython3.Destination.e_ZoomXYZ , FoxitPDFSDKPython3.Destination.e_ZoomFitVert or FoxitPDFSDKPython3.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.
def FoxitPDFSDKPython3.Destination.IsTopNull | ( | ) |
Check if top value is a null object.
This is only useful when zoom mode is FoxitPDFSDKPython3.Destination.e_ZoomXYZ , FoxitPDFSDKPython3.Destination.e_ZoomFitHorz , or FoxitPDFSDKPython3.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 |
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.