Difference between revisions of "IAdeUICallbacks::ShowPdfFile"
(Marked this version for translation) |
|||
Line 3: | Line 3: | ||
<languages /> | <languages /> | ||
<translate> | <translate> | ||
− | = void [[IAdeUICallbacks]]::ShowPdfFile([in] string filepath, [in] string bookmark, [in] bool bSearch, [in] bool bBookmarks) = | + | = void [[IAdeUICallbacks]]::ShowPdfFile([in] string filepath, [in] string bookmark, [in] bool bSearch, [in] bool bBookmarks) = <!--T:1--> |
+ | <!--T:2--> | ||
Called when the [[ShowPdfFile]]() function is evaluated. | Called when the [[ShowPdfFile]]() function is evaluated. | ||
+ | <!--T:3--> | ||
You implement this method to display a PDF file to the user when requested to do so by the model logic. | You implement this method to display a PDF file to the user when requested to do so by the model logic. | ||
− | == Parameters == | + | == Parameters == <!--T:4--> |
+ | <!--T:5--> | ||
* «filepath»: the PDF file to display | * «filepath»: the PDF file to display | ||
* «bookmark»: the bookmark to jump to (if any) | * «bookmark»: the bookmark to jump to (if any) | ||
Line 16: | Line 19: | ||
* «bBookmarks»: True if the user has requested the list-of-bookmarks pane to be visible. | * «bBookmarks»: True if the user has requested the list-of-bookmarks pane to be visible. | ||
− | = Examples = | + | = Examples = <!--T:6--> |
− | == Return value == | + | == Return value == <!--T:7--> |
+ | <!--T:8--> | ||
None | None | ||
− | = See Also = | + | = See Also = <!--T:9--> |
+ | <!--T:10--> | ||
* [[ShowPdfFile]]() function | * [[ShowPdfFile]]() function | ||
* [[OpenURL]]() function and [[IAdeUICallbacks::OpenURL]] method. | * [[OpenURL]]() function and [[IAdeUICallbacks::OpenURL]] method. | ||
</translate> | </translate> |
Latest revision as of 01:41, 16 June 2015
ADE User Guide > ADE Server Class Reference > IAdeUICallbacks
void IAdeUICallbacks::ShowPdfFile([in] string filepath, [in] string bookmark, [in] bool bSearch, [in] bool bBookmarks)
Called when the ShowPdfFile() function is evaluated.
You implement this method to display a PDF file to the user when requested to do so by the model logic.
Parameters
- «filepath»: the PDF file to display
- «bookmark»: the bookmark to jump to (if any)
- «bSearch»: True if user has requested the search panel to be visible in the PDF reader.
- «bBookmarks»: True if the user has requested the list-of-bookmarks pane to be visible.
Examples
Return value
None
See Also
- ShowPdfFile() function
- OpenURL() function and IAdeUICallbacks::OpenURL method.
Comments
Enable comment auto-refresher