Plug-In Scripting

Scripting - Plug-In Scripting

Creating a Plug-In or Add-On to EZSurvey is possible with use of a JavaScript based EZSurvey scripting language. This is different than Server-Side Scripting because it controls the actions of EZSurvey form editor. Creating custom plug-ins allows Raosoft or customers to develop new features for EZSurvey. Custom plug-ins are an advanced development feature and Raosoft cannot always support use of third-party plug-ins. Working with plug-in scripting requires a moderate amount of programing experience in HTML and JavaScript.

Overview:

Create a new resource object in a .plugin file.
Create a JavaScript file with the code that you want to execute.
Create a new script object in the .plugin file that points to the new JavaScript file.

JavaScript::

In addition to JSDB objects, EZSurvey scripting supports standard JavaScript syntax. A guide for this syntax can be found at:

Netscape's Core JavaScript Guide 1.5 or

Netscape's Core JavaScript Reference 1.5

JSDB Objects::

JSDB is the engine that runs scripts in EZSurvey. For a list of objects that JSDB supports, but is not limited to, go to:

JSDB Objects

EZSurvey JSDB Objects::

EZSurvey has extra programming objects within JSDB. For a list of JSDB objects that EZSurvey supports go to:

js_ezs.html

.PLUGIN:

File with the extension .plugin are located in the rsrc directory. You can add the resource object and call the .js file from here, where resourcename is any name you want to give your resource. For example:

Inside the resouce object is the form object. Inside the form object is where you can program a new window to control EZSurvey. You can use these objects:

Fieldset

Name - Required

Style - Optional

Help

Popup - (1 | 0)

Style - Optional

Input - Creates a new input object.

Name - Required

Type -

text, n, number, r, radio, c, checkbox, lr, listrank, lm, listmulti, ls, listsingle, lc, listcombo, w, weighted, hidden, d, date, t, time, section, rt, richtext, image, tb, toolbutton, pt, plaintext, page, password, link

Size - Optional

Style - Optional

Options - Creates an option for the input object.

Value - Required

Style - Optional

Besides creating a window to control EZSurvey. You can create new functions with JavaScript that perform tasks in EZSurvey. EZSurvey supports JSDB objects and standard JavaScript, as mentioned above.

Where scriptname is the name you want to give your script, Function Name is the name of the function as seen in the EZSurvey menu, and 1 is the number of the menu item where you want to put the Function Name.

File Edit Questions Database Publish Analysis Utilities Help

0 1 2 3 4 5 6 7

Other attributes in the script tag are:

name

scriptname

pro

database

validate

context

form

menu

row

Function Name

Examples:

To create a single choice input field, you would write this, where inputname is the name you want to give the input item:

<input name=inputname type=Single><text>My question goes here.</text>
<option value='1'>Response one goes here.</option>
<option value='2'>Response two goes here.</option>
<option value='3'>Response three goes here.</option>
</input>

To create another page, you would write this, where pagetwo is the name of the new page:

This is an example of how to call the form resource in the .js file. Where resourcename is the name of the resource.

var popup = new Form(resource('resourcename'));
var data = new Record;

if (execForm(popup,data))
{
}

File	Edit	Questions	Database	Publish	Analysis	Utilities	Help
0	1	2	3	4	5	6	7

Scripting - Plug-In Scripting

Overview:

JavaScript::

JSDB Objects::

EZSurvey JSDB Objects::

.PLUGIN:

Examples:

See also...