Scripts on pages with data

It is possible to use scripts on pages with data (Datas.aspx and DataDetail.aspx) for class or query. In this way you can easily extend by your required functionality:

• you cab add a new button to the toolbar for execution of your actions
• respond to actions on the page
• add a new control to a page for displaying further information
• influence column behaviour (hide the column or set it in read-only mode)

Scripting is not intended for supressing ObjectGears system functionality, but for extension by your functions.

Each event can be defined in the script only once. It is not wrong if some event is not defined. You can create further functions for better transparency. However, these functions cannot collide with event names.

There are available following events for scripts:

In Datas.aspx:

In DataDetail.aspx:

Description of events

All the events are in the script defined in the same way, just with a different name of function.

Example of event definition:

function OnPreRender()
{
    ...
}

Script objects

There are various properties available available for various events. These objects are described in the following table.

In Datas.aspx:

In DataDetail.aspx:

You can disable record creation, saving or deletion on page  DataDetail.aspx by means of object OGEditOptions. It is possible only to disable these operations. It is not possible to enabůe these operations in case user does not have necessary access rights.

Control elements

It is necessary to know names of the controls in order to use them in scripts. The following table contains the list of available names.

In Datas.aspx:

In DataDetail.aspx:

Examples

Inserting a control in the page

The script inserts a button into the toolbar, that will display an information text after clicking on it.

function OnLoad()
{
    OGForm.Toolbar.CreateButton( 'b1', 'Button', './imagesdata/archive.png');
}

function b1_Click()
{
    OGForm.SetSuccess( 'You have clicked on B1 button');
}

Set up of button Back

You can suppress default behaviour of the button by its set up. You can change the text in the button, its icon, URL (used when clicking on button) and visibility.

Set the properties in the event OnLoad.

function OnLoad()
{
    var b = OGForm.GetControl('backButton');
    b.Visible = true;
    b.Text = 'Back to start';
    b.NavigateUrl = 'Datas.aspx?CId=85';
}

Page properties settings

function OnLoad()
{
  OGPageSetting.PageTitle = 'My name of the page';
  OGPageSetting.BackgroundColor = 'red';
  OGPageSetting.PageKeyword = 'keyword,another key word';
  OGPageSetting.PageDescription = 'Page description';
}