The requested page is not available for the requested platform. You are viewing the content for Default platform.

SwipeButtonEventArgs.ButtonInfo Property

Gets an object that stores information about a swipe button.

Namespace: DevExpress.Mobile.DataGrid

Assembly: DevExpress.Mobile.Grid.v18.2.dll

Declaration

public SwipeButtonInfo ButtonInfo { get; protected set; }
Public Property ButtonInfo As SwipeButtonInfo

Property Value

Type Description
SwipeButtonInfo

A SwipeButtonInfo object.

Remarks

Important

This documentation topic describes legacy technology. We no longer develop new functionality for the GridControl and suggest that you use the new DataGridView control instead.

When handling the GridControl.SwipeButtonClick or GridControl.SwipeButtonShowing event, you can use properties of the SwipeButtonInfo object to obtain the button name (SwipeButtonInfo.ButtonName), or button appearance settings (SwipeButtonInfo.Caption, SwipeButtonInfo.BackgroundColor, SwipeButtonInfo.TextColor or SwipeButtonInfo.Width).

Examples

This example shows how to extend the grid’s UI with additional buttons to be shown when an end-user swipes left to right, or right to left, over a data row – Swipe Buttons. To create a swipe button, add a SwipeButtonInfo object to the GridControl.LeftSwipeButtons or GridControl.RightSwipeButtons collection. Use this object's SwipeButtonInfo.Caption, SwipeButtonInfo.Width, SwipeButtonInfo.BackgroundColor and SwipeButtonInfo.TextColor properties to specify button appearance.

To assign a custom action to a button, handle the GridControl.SwipeButtonClick event. The GridControl.SwipeButtonShowing event allows you to specify when a swipe button should be visible.

In the example, two swipe buttons are created.

  • When an end-user swipes any data row left to right, the Day button is shown on the left side of the row. Tapping this button displays the day of the week when the corresponding order was made.

    GridControl_LeftSwipeButton

  • When an end-user swipes right to left, a data row which corresponds to an order that is already shipped (the value in the Shipped column is true), the Delete button is shown on the right side of the row. Tapping this button removes the corresponding data row.

    GridControl_RightSwipeButton

void OnSwipeButtonShowing(object sender, SwipeButtonShowingEventArgs e)
{
    if ((!(Boolean)grid.GetCellValue(e.RowHandle, "Shipped"))
        && (e.ButtonInfo.ButtonName == "RightButton"))
    {
        e.IsVisible = false;
    }
}

void OnSwipeButtonClick(object sender, SwipeButtonEventArgs e)
{
    if (e.ButtonInfo.ButtonName == "LeftButton")
    {
        DateTime orderDate = (DateTime)grid.GetCellValue(e.RowHandle, "Date");
        string orderDateDay = orderDate.ToString("dddd");
        DisplayAlert("Alert from " + e.ButtonInfo.ButtonName, "Day: " + orderDateDay, "OK");
    }
    if (e.ButtonInfo.ButtonName == "RightButton")
    {
        grid.DeleteRow(e.RowHandle);
    }
}
See Also