Please enable JavaScript to view this site.

Navigation: Advanced topics > Events

Common event parameters

Scroll Prev Next More

 

You can use the following common parameters in your event code:

pageObject

$pageObject

an RunnerPage class object that represents a current page. For more information, see RunnerPage class.

Example

Before record updated:

 

// Get the current record and display the Make and Model fields' values
$data = $pageObject->getCurrentRecord();
echo $data["Make"] ." ".$data["Model"];

values array

$values

an array with the field values from an Add/Edit form.

Example

Before record updated:

 

echo $values["Field1"];

 

Note: If the field was assigned an alias in the SQL query, then the $values array gets the alias instead of the field name from the database.

E.g., if you have an SQL query SELECT salesrep_id AS Inv_Salesrep ..., you should use $values["Inv_Salesrep"].

keys

$keys

an array with the key columns.

Example

After record added:

 

echo $keys["ID"];

Other useful functions and parameters

 

$templatefile

the name of the template file being displayed.

$xt

a template engine object. Use $xt->assign($name, $val) to assign a value $val to the variable $name.

Example:

Before display event

 

$message = "This message";
$xt->assign("message",$message);

See also:

Page life cycle overview

Event editor

Table Events

Global Events

SQL query screen

About SQLQuery class

 

Created with Help+Manual 7 and styled with Premium Pack Version 3 © by EC Software