Back to Devexpress

ASPxCardView.SummaryDisplayText Event

aspnet-devexpress-dot-web-dot-aspxcardview-da1c99a4.md

latest4.6 KB
Original Source

ASPxCardView.SummaryDisplayText Event

Enables custom display text to be provided for any summary value.

Namespace : DevExpress.Web

Assembly : DevExpress.Web.v25.2.dll

NuGet Package : DevExpress.Web

Declaration

csharp
public event ASPxCardViewSummaryDisplayTextEventHandler SummaryDisplayText
vb
Public Event SummaryDisplayText As ASPxCardViewSummaryDisplayTextEventHandler

Event Data

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

PropertyDescription
EncodeHtmlGets or sets a value that specifies whether the summary display text keeps any of its values that are HTML as HTML, or instead, strips out the HTML markers. Inherited from ASPxGridSummaryDisplayTextEventArgs.
ItemGets a summary item whose value is being processed.
TextGets or sets the display text for the summary value currently being processed. Inherited from ASPxGridSummaryDisplayTextEventArgs.
ValueGets the processed summary value. Inherited from ASPxGridSummaryDisplayTextEventArgs.

Remarks

The SummaryDisplayText event is raised for total summaries.

Initialy, the event parameter’s ASPxGridSummaryDisplayTextEventArgs.Text property contains the text currently displayed in the summary panel. To provide custom text, assign it to this property.

Example

The following example calculates a summary in the CategoryID column based on the value in the ASPxSpinEdit below it.

When an end user changes a spin editor value, the editor sends a custom callback to the server in the client-side NumberChanged event handler. In the server-side SummaryDisplayText event handler, the grid calculates the summary value and sets it to the e.Text parameter.

aspx
<dx:ASPxCardView ID="ASPxCardView1" KeyFieldName="CategoryID" ClientInstanceName="grid" 
                 OnSummaryDisplayText="ASPxCardView1_SummaryDisplayText" 
                 AutoGenerateColumns="False"DataSourceID="AccessDataSource1" runat="server">
    <Settings ShowSummaryPanel="True" />
    <Columns>
        <dx:CardViewTextColumn FieldName="CategoryID" ReadOnly="True" />
        <dx:CardViewTextColumn FieldName="CategoryName" />
        <dx:CardViewTextColumn FieldName="Description" />
    </Columns>
    <TotalSummary>
        <dx:ASPxCardViewSummaryItem FieldName="CategoryID" SummaryType="Sum" />
    </TotalSummary>
</dx:ASPxCardView>

<dx:ASPxSpinEdit ID="ASPxSpinEdit1" runat="server" Number="0" Height="21">
    <ClientSideEvents NumberChanged="function(s, e) {
        grid.PerformCallback();
    }" />
</dx:ASPxSpinEdit>
csharp
protected void ASPxCardView1_SummaryDisplayText(object sender, DevExpress.Web.ASPxCardViewSummaryDisplayTextEventArgs e) {
    if (e.Item.FieldName == "CategoryID")
        e.Text = string.Format("Sum = {0}", Convert.ToDouble(e.Value) * Convert.ToDouble(ASPxSpinEdit1.Value));
}
vb
Protected Sub ASPxCardView1_SummaryDisplayText(ByVal sender As Object, ByVal e As DevExpress.Web.ASPxCardViewSummaryDisplayTextEventArgs)
    If e.Item.FieldName = "CategoryID" Then
        e.Text = String.Format("Sum = {0}", Convert.ToDouble(e.Value) * Convert.ToDouble(ASPxSpinEdit1.Value))
    End If
End Sub

See Also

Card View

ASPxCardView Class

ASPxCardView Members

DevExpress.Web Namespace