Please enable JavaScript to view this site.

Navigation: Advanced topics > Programming topics > Grid Row Javascript API

About Grid Row Javascript API

Scroll Prev Next More

 

The GridRow object represents a row in the grid on the List page. It provides useful functions such as reading and modifying field values.

 

It is available as a row parameter in:

 

AJAX snippets used in the Click actions;

Custom buttons inserted into the data grid on the List page;

In the Inline Add/Edit mode of the Field events.

 

You can also obtain GridRow objects for the grid records from any JavaScript event on the List page using these functions:

 

RunnerPage.getAllRecords

RunnerPage.getSelectedRecords

Methods

Method

Description

row.fieldCell()

Returns the jQuery object of the table cell with this field.

row.getFieldValue()

Returns a raw field value without formatting applied.

row.getFieldText()

Returns the field value with formatting applied. In other words, returns the HTML code of this table cell.

row.setFieldText()

Sets the field's HTML as it appears in grid.

row.setFieldValue()

The field value set this way does not appear in the grid and only applies to the consequent getFieldValue calls.

row.record()

Returns the jQuery object representing the table row.

row.setMessage()

Prints a message in one of the cells in the row. Useful to debug/troubleshoot your click action code.

row.getMessage()

Gets the previously added message.

row.getKeys()

Returns an array of key field values of the record.

row.recordId()

Returns the record ID.

See also

Page Designer: Grid type

Page Designer: Insert button into datagrid

Tri-part events

Buttons: rowData object

Event: ListGetRowCount

Change the row background color

 

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