Global

Table-Specific

Other

Global

Table-Specific

Other

Database_Connecting

This event will be called by all PHP pages before connecting to the database. Note: This is a global function.

If MySQL/PostgreSQL, the argument is an array with the following keys: host, port, user, pass, db. If Access/MSSQL, the argument is the connection string for ADO. You can use this event to change the connection string (e.g. changing connection info with server, or even connect to other databases).

Example

// MySQL/PostgreSQL
function Database_Connecting(&$info) {
    //var_dump($info);
    if (ew_CurrentUserIP() == "127.0.0.1") { // testing on local PC
        $info["host"] = "locahost";
        $info["user"] = "root";
        $info["pass"] = "";
    }
}

Page_Loading

This event will be called by all PHP pages at the beginning of the page. If the pages involves database connection, it will be called after connecting to the database and before the Page_Load event. Note: This is a global function.

Page_Unloaded

Global Code

User_Validated

For use with security. (See Security Settings) This event is fired after successful user login. The user info is passed to the event as a recordset, you can get more info of the user and use it as you need. Note: This event is a security class member.

Note: This event is not fired for the hard-coded administrator.

Example

Add current user's country to session variable

// Note: This event is a Security class member, so you can refer to other members of the Security class directly
function User_Validated(&$rs) {
    $_SESSION["UserCountry"] = $rs->fields('Country');
}

UserLevel_Loaded

For use with User Level security. (See Security Settings) This event is fired after successful user login and after the User Level settings are loaded. It is possible to do actions such as changing or adding User Level permissions. Note: This event is a security class member.

Example

Change the permissions of an User Level for a table

// Note: This event is a Security class member, so you can refer to other members of the Security class directly
function UserLevel_Loaded() {
    $this->DeleteUserPermission("Sales", "orders", EW_ALLOW_ADD);
    $this->AddUserPermission("Sales", "orders", EW_ALLOW_EDIT);
}

MenuItem_Adding

This event is fired for custom menu items before it is added to the menu. The menu item info is passed to the event as an instance of the cMenuItem object, refer to phpfn*.php for members of the object. Return False if you don't want to show the menu item. Note: This is a global function.

Example

Only show a menu item after the user has logged in

function MenuItem_Adding(&$Item) {
    //var_dump($Item);
    // Return False if menu item not allowed
    global $Security;
    if ($Item->Text == "Download") {
        return $Security->IsLoggedIn();
    } else {
        return TRUE;
    }
}

TablePermission_Loading

For use with User Level security. (See Security Settings) This event is fired before the user permission for the table of the current page is loaded. It is possible to do actions such as changing or adding more User Level permissions to the current user. Note: This event is a security class member.

Note: This is an event fired for the current table only. If you change the permissions of the other tables in this event, there will be no effect. Use the UserLevel_Loaded event if you need to change permissions of other tables.

Example

Grant another User Level to the user and let the user have permissions of more than one User Level for the current table.

// Note: This event is a Security class member, so you can refer to other members of the Security class directly
function TablePermission_Loading() {
    if (CurrentUserName() == "nancy") {
        $this->AddUserLevel("Manager");
    }
}

TablePermission_Loaded

For use with User Level security. (See Security Settings) This event is fired after the user permission for the table of the current page is loaded. It is possible to to change the permission by using the CanXXX properties of the Security class. Note: This event is a security class member.

Note: This is an event fired for the current table only. If you change the permissions of the other tables in this event, there will be no effect. Use the UserLevel_Loaded event if you need to change permissions of other tables.

Example

Grant more permissions to the user and let the user have more permissions than his/her User Level allows for the current table.

// Note: This event is a Security class member, so you can refer to other members of the Security class directly
function TablePermission_Loaded() {
    global $Page;
    if ($Page && $Page->TableName == "orders" && CurrentUserName() == "nancy") {
        $this->setCanEdit(TRUE);
    }
}

UserID_Loading

For use with User ID security. (See Security Settings) This event is fired after successful user login and before loading the User ID and its child User IDs of the current user. These User IDs determine which records the current user can access. It is possible to do actions such as changing the User ID of the current user so the user can access records that he/she can access by its original User ID. Note: This event is a security class member.

Example

Change the user's User ID to his parent user's user ID and let the user access more records (accessible by the parent user).

// Note: This event is a Security class member, so you can refer to other members of the Security class directly
function UserID_Loading() {
    if (CurrentParentUserID() <> "") {
        $this->CurrentUserID = CurrentParentUserID();
    }
}

UserID_Loaded

For use with User ID security. (See Security Settings) This event is fired after loading the User ID and its child User IDs of the current user. These User IDs determine which records the current user can access. It is possible to do actions such as adding or deleting the loaded User IDs for the current user so the user can access more or less records that he/she can access by its originally loaded User IDs. Note: This event is a security class member.

Example

Add more User IDs to the user and let the user access more records

// Note: This event is a Security class member, so you can refer to other members of the Security class directly
function UserID_Loaded() {
    if (CurrentUserName() == "nancy") {
        $this->AddUserID($this->GetUserIDByUserName("janet"));
    }
}

User_PasswordExpired

RecordSet_Selecting

This event will be called before selecting records. Note: This event is a table class member. The argument of the event is the filter (part of the WHERE clause of the SQL) for selecting records, you can customize the filter to change the records to be selected.

Example

Add your own filter. Note that the $filter may have value, append your filter to it, not replace it.

function Recordset_Selecting(&$filter) {
    if ($filter <> "")
        $filter = "(" . $filter . ") AND ";
    $filter .= "(Field1 = 1234)"; // Add your own filter    
}

RecordSet_Selected

RecordSet_SearchValidated

This event will be called after the Form_CustomValidate event and the search criteria is assigned to the table/field objects. You can modify the search criteria in this event.

This event is a member of the table class. There is no arguments for this event. To change the Quick Search criiteria, change the BasicSearchKeyword and BasicSearchType property of the table object. To change the Advanced Search criiteria, change the AdvancedSearch property (which is an object of the cAdvancedSearch class) of the field object.

RecordSet_Searching

Row_Deleting

Row_Deleted

This event will be called after deleting a record. The argument of the event is the record deleted as as an array.

Example

Delete detail records

function Row_Deleted(&$rs) {
    global $conn;
    // Assume MyForeignKeyField is of integer type
    $conn->Execute("DELETE * FROM MyDetailTable WHERE MyForeignKeyField=" . rs["MyPrimaryKeyField"]);
}

Row_Inserting

This event will be called before inserting a record. The argument of the event is the recordset of the new record to be inserted. Note: This event is a table class member.

Example

Make sure a field value is valid

function Row_Inserting(&$rs) {
    if ($rs["Percentage"] > 100) {
        $rs["Percentage"] = 100;
    }
    // To cancel, set return value to False
    return TRUE;
}

Row_Inserted

This event will be called after inserting a record. The argument of the event is the recordset of the new record inserted. Note: This event is a table class member.

Example

Get the ID (autoincrement field) of the just inserted record

function Row_Inserted(&$rs) {
    global $Page;
    $Page->setMessage("The ID of the new record is " . $rs["ID"]);    
}

Row_Rendering

Row_Rendered

This event will be called after rendering a record.

This is an extremely useful event for conditional formatting, you can do a lot of things with this event, such as changing font color, font styles, row background color, cell background color, etc. by changing the table or field class properties in the event according to field values.

The table class has a RowAttrs property which is an associative array of HTML attribites for the table row. The field class has CellAttrs, ViewAttrs and EditAttrs for the table cell, View Tag and Edit Tag of the field respectively. The keys of these arrays must be valid HTML attributes for the HTML tag, always use lowercase for the keys. The attribute values will be outputted as double quoted attributes, so if you have double quotes in your values, try to use single quotes if possible, or use "&quot;".

Note: This event is a table class member, so you can refer to the fields using $this-><field>.

To view the properties of the field class for development or debugging, you can use the PHP's var_dump function in the server event, e.g.

var_dump($this->RowAttrs);
var_dump($this->Trademark);
var_dump($this->Trademark->CellAttrs);
var_dump($this->Trademark->EditAttrs);
var_dump($this->Trademark->ViewAttrs);

Example

Click "Cars" node on the database panel, select [Server Events/Client Scripts], and click [Table Specific] - > [Common] - > [Row_Rendered] server event. The default Row_Rendered event code is shown. Change as follow:

function Row_Rendered() {
    // Change the row color
    if ($this->Trademark->ViewValue == "BMW") {
        $this->RowAttrs["style"] = "color: red; background-color: #ccffcc";
    }

    // Change the cell color
    if ($this->Cyl->CurrentValue == 4) {
        $this->Cyl->CellAttrs["style"] = "background-color: #ffcccc";
    } elseif ($this->Cyl->CurrentValue == 6) {
        $this->Cyl->CellAttrs["style"] = "background-color: #ffcc99";
    } elseif ($this->Cyl->CurrentValue == 8) {
        $this->Cyl->CellAttrs["style"] = "background-color: #ffccff";
    }

    // Change text style
    if ($this->Category->CurrentValue == "SPORTS") {
        $this->Category->ViewAttrs["style"] = "color: #00cc00; font-weight: bold; background-color: #ffff99";
    }
}

Row_Selecting

This event will be called before selecting a record. Note: This event is a table class member. The argument of the event is the filter (part of the WHERE clause of the SQL) for selecting the record, you can customize the filter to change the record to be selected.

Row_Selected

Row_UpdateConflict

This event will be called if conflicts is found before updating a record (if Check Conflicts is enabled, see Table Setup). The arguments of the event are the recordsets of the old and new record updated.

You can use this event to resolve the conflicts according to your own criteria. If you want to ignore conflicts or you have resolved the conflicts in the event (by setting new values to the argument rsnew) and want to continue update, return FALSE. Otherwise, return TRUE. By default the event returns TRUE.

Row_Updating

This event will be called before updating a record. The arguments of the event are the recordsets of the old and new record to be updated. Note: This event is a table class member.

Example

Make sure a field value is not changed

function Row_Updating(&$rsold, &$rsnew) {
    if ($rsnew["Qty"] < $rsold["Qty"]) {
        // To cancel, set return value to False
        $this->CancelMessage = "The new quantity must be larger than the old quantity.";
        return FALSE;
    } else {         
        return TRUE;
    }
}

Row_Updated

Email_Sending

This event is fired before the email notification is sent. You can customize the email content using this event. Email_Sending event has the following parameters:

Email - the email object instance which contain all the information about the email to be sent. It is an instance of the cEmail class, refer to phpfn*.php for members of the object.

Args - an array which contains additional information. For Add, the new record(s) in the format of array of array can be access by $Args["rs"]. If Edit/Update, the old data of the records in the format of array of array can be access by $Args["rsold"], the new data of the records in the format of array of array can be access by $Args["rsnew"].

Return False in the event if you want to cancel the email sending.

Note: This event is a table class member.

Example

Use a field value of the the new record in the email

function Email_Sending(&$Email, &$Args) {
    //var_dump($Email);
    //var_dump($Args);
    //exit();
    global $Page;
    if ($Page->PageID == "add") { // if Add page
        $Email->Content .= "\nAdded by " . CurrentUserName();
    }
    return TRUE;
}

Page_Load

Page_Load

Page_Redirecting

This event will be called before redirecting to other page. The argument is the URL to be redirected to.

By default after inserting a record user is redirected back to the List page. You can change that by using Return Page (see Table Setup). However, If you want to change by code, you can also use this event.

Form_CustomValidate

This event is fired after the normal form validation. You can use this event to do your own custom validation. In general, the form data can be accessed by $<Table>-><Field>->FormValue (e.g. $Cars->HP->FormValue). Refer to the generated code for actual variable names.

A parameter CustomError is passed to the event, add your error message and return False if the form values do not pass your validation.

Note: This event is a page class member.

Example

Make sure an integer field value meet a certain requirement

function Form_CustomValidate(&$CustomError) {
    global $orders;
    if (intval($orders->Qty->FormValue) % 10 <> 0) {
        // Return error message in CustomError
        $CustomError = "Order quantity must be multiples of 10.";
        return FALSE;
    } else {         
        return TRUE;
    }    
}

Page_Load

Page_Unload

Page_Redirecting

This event will be called before redirecting to other page. Event argument is the URL to be redirected to.

By default after deleting record(s) user is redirected back to the List page. You can change that using this event.

Page_Load

Page_Unload

Page_Redirecting

This event will be called before redirecting to other page. Event argument is the URL to be redirected to.

By default after updating a record user is redirected back to the List page. You can change that by using Return Page (see Table Setup). However, If you want to change by code, you can use this event.

Page_Load

Page_Unload

Page_Redirecting

This event will be called before redirecting to other page. Event argument is the URL to be redirected to.

Form_CustomValidate

This event is fired after the normal form validation. You can use this event to do your own custom validation. In general, the form data can be accessed by $<Table>-><Field>->FormValue (e.g. $Cars->HP->FormValue). Refer to the generated code for actual variable names.

A parameter CustomError is passed to the event, add your error message and return False if the form values do not pass your validation.

Note: This event is a page class member.

This event will be called before the main table is rendered. Use this event to modify the non data columns of the main table (i.e. the links and the checkbox for each record). You can modify these columns or add your own columns using this event. You can get a column by name using $this->ListOptions->Item["name"], the following predefined names are reserved, do not use them for your own columns:

• copy
• delete
• edit
• detail_<DetailTable>
• checkbox

Note: This event is a page class member.

Example

Add a new column.

function ListOptions_Load() {
    $this->ListOptions->Add("new");
    $this->ListOptions->Items["new"]->OnLeft = TRUE; // Link on left
    $this->ListOptions->MoveItem("new", 0); // Move to first column
}

This event will be called before a record is rendered. Use this event to modify content of the non data columns for the record.

Note: This event is a page class member.

Example

Set the content of the new column.

function ListOptions_Rendered() {
    $this->ListOptions->Items["new"]->Body = "xxx";
}

Page_Load

Page_Unload

Page_Redirecting

This event will be called before redirecting to other page. Event argument is the URL to be redirected to.

By default after updating records user is redirected back to the List page. You can change that by using this event.

Page_Load

Page_Unload

Page_Redirecting

This event will be called before redirecting to other page. Event argument is the URL to be redirected to.

Page_Load

Page_Unload

Page_Redirecting

This event will be called before redirecting to other page. Event argument is the URL to be redirected to.

By default user is redirected to the List page after the search criteia is processed. You can change that by using this event.

Page_Load

Page_Unload

Page_Redirecting

This event will be called before redirecting to other page. Event argument is the URL to be redirected to.

Page_Load

Page_Unload

Page_Redirecting

This event will be called before redirecting to other page. Event argument is the URL to be redirected to.

By default user is redirected to the default page (e.g. index.php) after successful login. You can change that by using this event.

User_LoggingIn

User_LoggedIn

Form_CustomValidate

This event is fired after the normal form validation. You can use this event to do your own custom validation. In general, the form data can be accessed by $<Table>-><Field>->FormValue (e.g. $Cars->HP->FormValue). Refer to the generated code for actual variable names.

A parameter CustomError is passed to the event, add your error message and return False if the form values do not pass your validation.

Note: This event is a page class member.

User_LoginError

Page_Load

Page_Unload

Page_Redirecting

This event will be called before redirecting to other page. Event argument is the URL to be redirected to.

By default user is redirected to the default page (e.g. index.php) after successful login. You can change that by using this event.

User_LoggingOut

This event will be called before user logout. Note: This event is a page class member.

User_LoggedOut

This event will be called after user logout. Note: This event is a page class member.

Page_Load

Page_Unload

Page_Redirecting

This event will be called before redirecting to other page. Event argument is the URL to be redirected to.

By default user is redirected to the default page (e.g. index.php) after successful login. You can change that by using this event.

Email_Sending

This event is fired before the email notification is sent. You can customize the email content using this event. Email_Sending event has the following parameters:

Email - the email object instance which contain all the information about the email to be sent. It is an instance of the cEmail class, refer to phpfn*.php for members of the object.

Args - an array which contains additional information. For registration page, the new record in the data type of a recordset can be accessed by $Args["rs"].

Return FALSE in the event if you want to cancel the email sending.

Note: This event is a page class member.

Form_CustomValidate

This event is fired after the normal form validation. You can use this event to do your own custom validation. In general, the form data can be accessed by $<Table>-><Field>->FormValue (e.g. $Cars->HP->FormValue). Refer to the generated code for actual variable names.

A parameter CustomError is passed to the event, add your error message and return FALSE if the form values do not pass your validation.

Note: This event is a page class member.

User_Registered

This event is fired after successful regsitration of a new user. Argument is a recordset of the new record in the user table.

User_Activated

This event is fired after activating a new user (if user activation is required, see Security Settings). Argument is a recordset of the new record in the user table.

Page_Load

Page_Unload

Page_Redirecting

This event will be called before redirecting to other page. Event argument is the URL to be redirected to.

By default user is redirected to the default page (e.g. index.php) after successful login. You can change that by using this event.

Email_Sending

This event is fired before the email notification is sent. You can customize the email content using this event. Email_Sending event has the following parameters:

Email - the email object instance which contain all the information about the email to be sent. It is an instance of the cEmail class, refer to phpfn*.php for members of the object.

Args - an instance of Dictionary object which contains additional information. For Change Password page, the old data of the records in the data type of recordset can be accessed by $Args["rsold"], the new data of the records in the data type of recordset can be accessed by $Args["rsnew"].

Return False in the event if you want to cancel the email sending.

Note: This event is a page class member.

Form_CustomValidate

This event is fired after the normal form validation. You can use this event to do your own custom validation. In general, the form data can be accessed by $<Table>-><Field>->FormValue (e.g. $Cars->HP->FormValue). Refer to the generated code for actual variable names.

A parameter CustomError is passed to the event, add your error message and return False if the form values do not pass your validation.

Note: This event is a page class member.

Page_Load

Page_Unload

Page_Redirecting

This event will be called before redirecting to other page. Event argument is the URL to be redirected to.

By default user is redirected to the login page after successful login. You can change that by using this event.

Email_Sending

This event is fired before the email notification is sent. You can customize the email content using this event. Email_Sending event has the following parameters:

Email - the email object instance which contain all the information about the email to be sent. It is an instance of the cEmail class, refer to phpfn*.php for members of the object.

Args - an instance of Dictionary object which contains additional information. For Password Recovery Page, the old data of the records in the data type of recordset can be accessed by $Args["rs"].

Return False in the event if you want to cancel the email sending.

Note: This event is a page class member.

Form_CustomValidate

This event is fired after the normal form validation. You can use this event to do your own custom validation. In general, the form data can be accessed by $<Table>-><Field>->FormValue (e.g. $Cars->HP->FormValue). Refer to the generated code for actual variable names.

A parameter CustomError is passed to the event, add your error message and return False if the form values do not pass your validation.

Note: This event is a page class member.

User_RecoverPassword

This event is fired after the password is recovered. Argument is a recordset of the user's record in the user table.

Client Script

The script will be placed in the header and therefore included in all pages with header.

Startup Script

Global Code

Client Script

Startup Script

Form_CustomValidate

This function is called after the normal form validation. You can use this event to do your own custom validation. The form object can be accessed by the parameter fobj. In general, the field can be referred to as fobj.elements["x_FieldName"]. (The element names have different names in Inline/Grid Add/Edit of List page, always refer to the generated code for the actual form element names.) Return False if the form values do not pass your validation.

Note: This function is a member of the JavaScript page class.

Example

Make sure an integer field value meet a certain requirement

function(fobj) { // DO NOT CHANGE THIS LINE!
    var qty = parseInt(fobj.elements["x_Qty"].value);
    if (qty % 10 != 0) {         
        return ew_OnError(this, fobj.elements["x_Qty"], "Order quantity must be multiples of 10."); // return false if invalid
    }
    return true;
}

Client Script

Startup Script

Client Script

Startup Script

Form_CustomValidate

This function is called after the normal form validation. You can use this event to do your own custom validation. The form object can be accessed by the parameter fobj. Return False if the form values do not pass your validation.

Client Script

Startup Script

Form_CustomValidate

This function is called after the normal form validation. You can use this event to do your own custom validation. The form object can be accessed by the parameter fobj. Return False if the form values do not pass your validation.

Client Script

Startup Script

Form_CustomValidate

This function is called after the normal form validation. You can use this event to do your own custom validation. The form object can be accessed by the parameter fobj. Return False if the form values do not pass your validation.

Client Script

Startup Script

Client Script

Startup Script

Form_CustomValidate

This function is called after the normal form validation. You can use this event to do your own custom validation. The form object can be accessed by the parameter fobj. Return False if the form values do not pass your validation.

Client Script

Startup Script

Client Script

Startup Script

Form_CustomValidate

This function is called after the normal form validation. You can use this event to do your own custom validation. The form object can be accessed by the parameter fobj. Return False if the form values do not pass your validation.

Client Script

Startup Script

Form_CustomValidate

This function is called after the normal form validation. You can use this event to do your own custom validation. The form object can be accessed by the parameter fobj. Return False if the form values do not pass your validation.

Client Script

Startup Script

Form_CustomValidate

This function is called after the normal form validation. You can use this event to do your own custom validation. The form object can be accessed by the parameter fobj. Return False if the form values do not pass your validation.

Client Script

Startup Script

Form_CustomValidate

This function is called after the normal form validation. You can use this event to do your own custom validation. The form object can be accessed by the parameter fobj. Return False if the form values do not pass your validation.