Skip to main content

BootstrapCardView.CustomColumnDisplayText Event

Enables custom display text to be provided for any cell.

Namespace: DevExpress.Web.Bootstrap

Assembly: DevExpress.Web.Bootstrap.v24.1.dll

NuGet Package: DevExpress.Web.Bootstrap

Declaration

public event BootstrapCardViewColumnDisplayTextEventHandler CustomColumnDisplayText

Event Data

The CustomColumnDisplayText event's data class is BootstrapCardViewColumnDisplayTextEventArgs. The following properties provide information specific to this event:

Property Description
Column Gets the data column that refers to the card currently being processed.
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.
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 CustomColumnDisplayText event can be used to provide custom display text for any cell. This event is fired for both bound and unbound columns. The text provided via this event will be used when the CardView 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 example below demonstrates how to display the “empty” string within the Discount column’s cells if they contain zero values.

protected void CardView_CustomColumnDisplayText(object sender, BootstrapCardViewColumnDisplayTextEventArgs e)
{
    if (e.Column.FieldName != "Discount") return;
    if (Convert.ToInt32(e.Value) == 0)
        e.DisplayText = "empty";
}
See Also