ASPxVerticalGrid.CustomRowDisplayText Event
Enables custom display text to be provided for any cell.
Namespace: DevExpress.Web
Assembly: DevExpress.Web.v24.2.dll
Declaration
Event Data
The CustomRowDisplayText event's data class is ASPxVerticalGridRowDisplayTextEventArgs. The following properties provide information specific to this event:
| Property | Description |
|---|---|
| DisplayText | Enables you to set a custom text for the cell currently being processed. Inherited from ASPxGridColumnDisplayTextEventArgs. |
| EncodeHtml | Gets or sets a value that specifies whether the cell display text keeps any of its values that are HTML as HTML, or instead, strips out the HTML markers. Inherited from ASPxGridColumnDisplayTextEventArgs. |
| Kind | Gets the type of operations with grid data. Inherited from ASPxGridColumnDisplayTextEventArgs. |
| Row | Gets the row that contains the cell currently being processed. |
| Value | Gets the edit value of the cell currently being processed. Inherited from ASPxGridColumnDisplayTextEventArgs. |
| VisibleIndex | Gets the visible index of the data item (row, card or record) where the processed cell resides. Inherited from ASPxGridColumnDisplayTextEventArgs. |
The event data class exposes the following methods:
| Method | Description |
|---|---|
| GetFieldValue(Int32, String) | Returns the value of the specified data source field in the specified data item (row, card or record). Inherited from ASPxGridColumnDisplayTextEventArgs. |
| GetFieldValue(String) | Returns the value of the specified data source field in the current data item (row, card or record). Inherited from ASPxGridColumnDisplayTextEventArgs. |
Remarks
The CustomRowDisplayText event can be used to provide custom display text for any cell. This event is fired for both bound and unbound rows. The text provided via this event will be used when the ASPxVerticalGrid is printed or exported.
Initially, the ASPxGridColumnDisplayTextEventArgs.DisplayText parameter returns null. To provide custom display text, assign the required string to this parameter. To get the current cell value, use the ASPxGridColumnDisplayTextEventArgs.Value parameter.
The CustomRowDisplayText event fires in two cases.
- When the control hierarchy is being built.
- When a grid is filtered or sorted by display text (the GridDataColumnSettings.FilterMode or the ASPxGridBehaviorSettings.SortMode property is set to DisplayText). In this case, the grid record visible indexes are not identified when the event fires. The ASPxGridColumnDisplayTextEventArgs.VisibleIndex argument property returns -1. Therefore, you cannot use the GetFieldValue(int visibleIndex, string fieldName) overload of the ASPxGridColumnDisplayTextEventArgs.GetFieldValue method to get the value of the non-processed record.
Note
The CustomRowDisplayText event should not be handled for template rows.