Call Script Procedure/Function

Applies to HTML Viewer, IE Browser publications.

Scripts have multiple possible uses: you can assign them to

HTML pages
security profiles (Boolean conditions)
HTML links
JavaScript functions
global publication events

In this topic, you will learn how to call functions/procedures from HEScript scripts. You also have live demonstrations with detailed samples.

The internal HTML editor has a tool that lets you visually add links and JavaScript code to HTML page that call HEScript functions.

Script associated to HTML pages

With scripts associated to HTML pages, the runtime module will automatically call some pre-defined procedures or functions called events when a related event occurs (when the page is loaded or a HTML link is clicked for instance). You can use these events to add your own actions using script commands.

Scripts and security profiles

With security profiles, you can add "Boolean function result" conditions that actually call a Boolean function from a given script: you are prompted to select the Boolean function you want when you add such a condition to a security profile. If the function returns true, the condition is considered as fulfilled and its associated actions/restrictions are executed.

Using HTML Links

You can call HEScript procedures and functions independently via HTML links.
You need to use the hescript:// prefix instead of http:// to inform the runtime module that it should execute a HEScript procedure/function.
The hescript:// prefix is followed by the script name + dot + procedure/function name, i.e. hescript://[scriptname].[functionprocedurename]

Examples: hescript://MyScript.Procedure1 or hescript://UserMain.OnNavigateComplete

In HTML code:

<a href="hescript://MyScript.Procedure1">Click here to execute my first function</a>

Live Demonstration: try it yourself!

We wrote a small script called "demo1" in the Script Manager which contains the following procedure:

procedure MyFirstDemo;
begin
MessageBox("This is a simple message.", "First Demo", MB_OK+MB_ICONINFORMATION);
end;

Then the following HTML code was put below:

<a href="hescript://demo1.MyFirstDemo">Click here to execute this function</a>

So click the link to see what happens:

Click here to execute this function

Example: hescript://MyScript.ProcedureA|test

Live Demonstration:

We are using a second example. The script procedure in "demo1" is:

procedure MySecondDemo(cond: String);
var
S: String;
begin
S := "first";
if cond="2" then S := "second";
MessageBox("The " + S + " link was clicked", "Second Demo", MB_OK+MB_ICONINFORMATION);
end;

It takes one string parameter.

We use two links where we only change the parameter from "1" to "2":

First link:

This is the 1st link

And the second link:

This is the 2nd link

String parameters should only be used in links and JavaScript calls.

Using JavaScript

You may finally use HEScript together with JavaScript (in IE browser publications).

The Internet Explorer JavaScript model has a special function window.external that allows JavaScript scripts to communicate with HEScript scripts.

Window.external methods are described here. We will only introduce one of the method called runHEScriptCom.

JavaScript syntax:

window.external.runHEScriptCom('[scriptname].[functionprocedurename]|param1|param2|....|paramN');

This exactly works like the hescript:// method for HTML links; you have just to replace it by window.external.runHEScriptCom('.......');

Example: window.external.runHEScriptCom('hescript://MyScript.Procedure1');

You can therefore call any HEScript procedure or function at any time from JavaScript.

You can also use this JavaScript function:

function executecom(sname)
{
window.external.runHEScriptCom(sname);
return 0;
}

Live Demonstration:

Instead of using a link, we use a button:

The result is:

It exactly behaves like the link of the previous example.