GridFieldContext

Purpose

For any field in a grid control, a GridFieldContext object encapsulates state and behavior details for the associated field. The GridFieldContext object is only available in the New UI. You can access a GridFieldContext object using the client-side function rbf_getGridFieldContext(). The interface of GridFieldContext includes all functions defined for FieldContext. See rbf_getGridFieldContext() for an example of accessing a GridFieldContext and executing one of its functions.

Interface

The following functions return information about the state of the field:

• isGridControlField() — Returns true if the associated field is in a grid control. Otherwise returns false.
• getGridRow() — Returns the GridRow object for the associated field.
• getGridFieldData() — Returns a JSON object representing the value of the associated field.
• getGridComponent() — Returns the GridControl object to which this field belongs.