Difference between revisions of "OpenURL"

Latest revision as of 01:57, 8 February 2024

OpenURL(url)

Opens a browser window to the specified «url».

This can be used in the OnClick attribute of button to open supplementary documentation for your model.

Failures

There is no return value -- it always returns Null.

The function does not report failures. If the URL does not exist, this error will appear in your browser window, but no error message will occur within Analytica.

If your computer is unable to open a browser, nothing will happen, and no error is reported.

Examples

OpenURL("http://analytica.com")

OpenURL("analytica.com")

From ADE

When evaluated in the Analytica Decision Engine (ADE) and a dialog needs to be shown to the end-user, it calls IAdeUICallbacks::OpenURL(...). The parent application implements this callback to open the URL for the end-user. To receive this callback, the parent application must have previously registered the callback with ADE using CAEngine::SetCallbackObject( ). If it has not registered a callback, the function does nothing.

History

OpenURL was introduced in Analytica 4.6.

@@ Line 2: / Line 2: @@
 [[category:User-interface functions]]
-''new to [[Analytica 4.6]]''
+== OpenURL(url) ==
-= OpenURL(url) =
 Opens a browser window to the specified «url».
 This can be used in the [[OnClick]] attribute of button to open supplementary documentation for your model.
-= Failures =
+== Failures ==
+There is no return value -- it always returns [[Null]].
-There is no return value -- it always returns Null.
 The function does not report failures. If the URL does not exist, this error will appear in your browser window, but no error message will occur within Analytica.
@@ Line 18: / Line 14: @@
 If your computer is unable to open a browser, nothing will happen, and no error is reported.
-= Examples =
+== Examples ==
+:<code>OpenURL("http://analytica.com")</code>
+:<code>OpenURL("analytica.com")</code>
-:<code>[[OpenURL]]("http://lumina.com")</code>
+== From ADE ==
-:<code>[[OpenURL]]("lumina.com")</code>
+When evaluated in [[ADE|the Analytica Decision Engine (ADE)]] and a dialog needs to be shown to the end-user, it calls [[IAdeUICallbacks::OpenURL]](...). The parent application implements this callback to open the URL for the end-user. To receive this callback, the parent application must have previously registered the callback with ADE using [[CAEngine::SetCallbackObject]]( ). If it has not registered a callback, the function does nothing.
-= See Also =
+==History==
+[[OpenURL]] was introduced in [[Analytica 4.6]].
-* ''Hyperlinks in model documentation'' in Chapter 9 of the Analytica User Guide. (An alternative).
+== See Also ==
+* [[ReadFromUrl]]
+* [[Links or URL in model attributes]]
 * [[ShowPdfFile]] function
+* [[OpenModelFile]]
+* [[Retrieving Content From the Web]]