Global

The events are applicable to all pages.

Table-Specific

Other

Global

Table-Specific

Other

Database_Connecting

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

The argument is the connection string. You can use this event to change the connection string (e.g. changing connection info with server, or even connect to other databases).

Example

Page_Loading

This event will be called by all 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.

Page_Unloaded

Global Code

Server code to be included in all pages. This may contain your constants, variables and functions.

Note: The code will be generated as part of the base class of all (almost) pages, it should include shared members such as shared variables or shared methods only.

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 DbDataReader, you can get more info of the user and use it as you need.

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
Public Sub User_Validated(rs As DbDataReader)
    HttpContext.Current.Session("UserCountry") = rs("Country")
End Sub

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.

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
Public Sub UserLevel_Loaded()
    DeleteUserPermission("Sales", "Order", EW_ALLOW_ADD)
    AddUserPermission("Sales", "Order", EW_ALLOW_EDIT)
End Sub

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 aspxfn*.vb/cs for members of the object. Return False if you don't want to show the menu item.

Example

Only show a menu item after the user has logged in

Public Function MenuItem_Adding(ByRef Item As cMenuItem) As Boolean
    'Response.Write Item.AsString
    ' Return False if menu item not allowed
    If Item.Text = "Download" Then
        Return IsLoggedIn()
    Else
        Return True
    End If
End Function

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 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
Public Sub TablePermission_Loading(Page As AspNetMakerPage)
    If CurrentUserName = "nancy" Then
        AddUserLevel("Manager")
    End If
End Sub

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 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
Public Sub TablePermission_Loaded(Page As AspNetMakerPage)
    If CurrentUserName = "nancy" And Page.TableName = "Orders" Then
        CanEdit = True
    End If
End Sub

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.

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
Public Sub UserID_Loading()
    If CurrentParentUserID <> "" Then
        CurrentUserID = CurrentParentUserID
    End If
End Sub

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.

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
Public Sub UserID_Loaded()
    If CurrentUserName = "nancy" Then
        AddUserID(GetUserIDByUserName("janet"))
    End If
End Sub

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.

Public Sub Recordset_Selecting(ByRef filter As String)
    If filter <> "" Then filter = "(" & filter & ") AND "
    filter &= "(Field1 = 1234)" ' Add your own filter    
End Sub

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 criteria, change the BasicSearchKeyword and BasicSearchType property of the table object. To change the Advanced Search criteria, change the AdvancedSearch property (which is an object of the cAdvancedSearch class) of the field object.

RecordSet_Searching

This event will be called before the search criteria is saved for the session.

This event is a member of the table class. The argument of the event is the part of WHERE clause built from the Quick/Extended Quick/Advanced search criteria. You can modify the WHERE clause in this event.

Row_Deleting

Row_Deleted

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

Example

Delete detail records

Public Sub Row_Deleted(rs As OrderedDictionary)
    Conn.Execute("DELETE * FROM MyDetailTable WHERE MyForeignKeyField=" & rs("ID"))
End Function

Row_Inserting

This event will be called before inserting a record. The argument of the event is the new record as OrderedDictionary object.

Example

Make sure a field value is valid

Public Function Row_Inserting(ByRef rs As OrderedDictionary) As Boolean
    If rs("Percentage") > 100 Then
        rs("Percentage") = 100
    End If
    ' To cancel, set return value to False
    Return True
End Function

Row_Inserted

This event will be called after inserting a record. The argument of the event is the new record as OrderedDictionary object.

Example

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

Public Sub Row_Inserted(rs As OrderedDictionary)
    Page.Message = "The ID of the new record is " & rs("ID")    
End Sub

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 hashtable of HTML attributes 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 hashtables 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 directly.

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:

' Note: Row_Rendered is a table class member, so you can refer to the fields (also table class members) directly
Public Sub Row_Rendered()
    ' Change the row color
    If Convert.ToString(Trademark.ViewValue) = "BMW" Then
        RowAttrs("style") = "color: red; background-color: #ccffcc"
    End If

    ' Change the cell color
    If Convert.ToInt32(Cyl.CurrentValue) = 4 Then
        Cyl.CellAttrs("style") = "background-color: #ffcccc"
    ElseIf Convert.ToInt32(Cyl.CurrentValue) = 6 Then
        Cyl.CellAttrs("style") = "background-color: #ffcc99"
    ElseIf Convert.ToInt32(Cyl.CurrentValue) = 8 Then
        Cyl.CellAttrs("style") = "background-color: #ffccff"
    End If

    ' Change text style
    If Convert.ToString(Category.CurrentValue) = "SPORTS" Then
        Category.ViewAttrs("style") = "color: #00cc00; font-weight: bold; background-color: #ffff99"
    End If

End Sub

Row_Selecting

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 old and new record to be updated as OrderedDictionary objects.

Example

Make sure a field value is not changed

Public Function Row_Updating(rsold As OrderedDictionary, ByRef rsnew As OrderedDictionary) As Boolean
    If rsnew("Date") < rsold("Date") Then
        CancelMessage = "The new date must be later than the old date."
        ' To cancel, set return value to False
        Return False         
    Else        
        Return True
    End If
End Function

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 aspxfn*.vb/cs for members of the object.

Args - an instance of hashtable object which contains additional information. For Add, the new record in the data type of an OrderedDictionary can be access by Args("Rs"). If Edit/Update, the old record in the data type of an OrderedDictionary can be access by Args("RsOld"), the new record in the data type of an OrderedDictionary 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

Public Function Email_Sending(ByRef Email As cEmail, Args As Hashtable) As Boolean
    If Page.PageID = "add" Then ' if Add page
        Dim rs As OrderedDictionary = Args("Rs")
        Email.Content = Email.Content & vbCrLf & "Added by " & rs("UserID")
    End If
    Return True
End Function

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

Public Function Form_CustomValidate(ByRef CustomError As String) As Boolean
    If CInt(Orders.Qty.FormValue) Mod 10 <> 0 Then
        ' Return error message in CustomError
        CustomError = "Order quantity must be multiples of 10."
        Return False
    Else        
        Return True
    End If    
End Function

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.

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 the ListOptions.GetItem(name) method, 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

Sub ListOptions_Load()
    Dim Col ' New Column
    Set Col = ListOptions.Add("new") ' Add a new column
    Col.OnLeft = True ' Show on left
    Col.Header = "My HTML Caption" ' Caption of the column
    ListOptions.MoveItem "new", 0 ' Move to first column
End Sub

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.

Sub ListOptions_Rendered()
    ListOptions.GetItem("new").Body = "My HTML content for the column"
End Sub

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. default.aspx) 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. default.aspx) 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. default.aspx) 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 aspxfn*.vb/cs for members of the object.

Args - an dictionary object 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.

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. default.aspx) 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 aspxfn*.vb/cs 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 OrderedDictionary 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 aspxfn*.vb/cs 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 OrderedDictionary 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"]);
    if (qty % 10 != 0) {         
        alert("Order quantity must be multiples of 10.");
        return false; // 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.