Difference between revisions of "ShowPdfFile"

Revision as of 22:54, 25 January 2016

ShowPdfFile(filename, bookmark, search, bookmarks)

Opens a Pdf file (on computers where Adobe Acrobat or Acrobat Reader is installed). If acrobat exchange is installed on the computer, optional parameters can be used to specify which bookmark to open to, whether to show a search dialog, and whether to show the bookmark window. In ADE, or if «filename» is an empty string, no PDF is opened. Returns 0 if acrobat is not installed, 1 if acrobat but not xchange is installed, and 2 if both are installed.

ShowPdfFile is typically called from a button event (i.e., create a button, and place a call to ShowPdfFile in the OnClick attribute).

Full declaration:

ShowPdfFile(filename: textual; bookmark: optional textual; search, bookmarks: optional boolean)

Example

The following opens the Analytica User Guide:

ShowPdfFile(GetRegistryValue("HKLM","ANAVER","UserGuide"))

History

ShowPdfFile was introduced in Analytica 4.0.

@@ Line 3: / Line 3: @@
 [[Category:Doc Status C]] <!-- For Lumina use, do not change -->
-(new to 4.0)
-= ShowPdfFile( filename, ''bookmark, search, bookmarks'' ) =
+== ShowPdfFile(filename, ''bookmark, search, bookmarks'') ==
-Opens a Pdf file (on computers where Adobe Acrobat or Acrobat Reader is installed).  If acrobat exchange is installed on the computer, optional parameters can be used to specify which bookmark to open to, whether to show a search dialog, and whether to show the bookmark window.  In ADE, or if the filename is an empty string, no PDF is opened.  Returns 0 if acrobat is not installed, 1 if acrobat but not xchange is installed, and 2 if both are installed.
+Opens a Pdf file (on computers where Adobe Acrobat or Acrobat Reader is installed).  If acrobat exchange is installed on the computer, optional parameters can be used to specify which bookmark to open to, whether to show a search dialog, and whether to show the bookmark window.  In [[ADE]], or if «filename» is an empty string, no PDF is opened.  Returns 0 if acrobat is not installed, 1 if acrobat but not xchange is installed, and 2 if both are installed.
-[[ShowPdfFile]] is typically called from a button event (i.e., create a button, and place a call to [[ShowPdfFile]] in the [[OnClick]] attribute).
+[[ShowPdfFile]] is typically called from a [[button]] event (i.e., create a button, and place a call to [[ShowPdfFile]] in the [[OnClick]] attribute).
-= Full declaration =
+Full declaration:
+:[[ShowPdfFile]](filename: textual; bookmark: optional textual; search, bookmarks: optional boolean)
- [[ShowPdfFile]]( filename : textual ; bookmark : optional textual ; search, bookmarks: optional boolean )
-= Example =
+== Example ==
 The following opens the Analytica User Guide:
+:<code>ShowPdfFile(GetRegistryValue("HKLM","ANAVER","UserGuide"))</code>
- [[ShowPdfFile]]([[GetRegistryValue]]("HKLM","ANAVER","UserGuide"))
+==History==
+[[ShowPdfFile]] was introduced in Analytica 4.0.
-= See Also =
+== See Also ==
 * [[Hyperlinks in Descriptions]]
+* [[Links or URL in model attributes]]
 * [[CurrentDataFolder]]
 * [[GetRegistryValue]]
+* [[OpenURL]]