OnTitlesRender Event

Description

This event allows you to inject HTML into the Grid part as the Grid titles row is being rendered on the server.

Discussion

Allows you to inject custom HTML into the Grid when the Grid Titles are rendered.

The following variables are available to you in the event:

Variable
Description
e.tmpl

The grid component definition

e.rtc

You can put any data in this variable that you want to pass to other events. e.g. e.rtc.mydata = 'value1'

e.gridColumnCount

The total number of columns in the Grid <table>, including any system columns.

e.gridSystemColumnCount

The number of system columns in the Grid <table>. System columns are used for objects such as system buttons, row expander icon, etc.

e.gridTitles

Computed Grid Titles row. Your event handler can define HTML to prepend or append to this row.

Your event must set these properties:

Property
Description
e.htmlPrefix

The HTML markup that you want to add before the Grid Titles row is rendered. Must be wrapped in <td>...</td> tags.

e.htmlSuffix

The HTML markup that you want to add after the Grid Titles row is rendered. Must be wrapped in <td>...</td> tags.

e.javascript

(optional) Any Javascript that you want to execute

Setting State Variables 

You can also set state variables in this event. The value of any state variables will be available in all subsequent ajax callbacks (in the e.__si2 object).

To set a state variable:

e._state.myvar1 = "value1"
e._state.myvar2 = "value2"