GridControl.SwipeButtonShowing Event
Occurs before a swipe button is shown when an end-user swipes left to right, or right to left, over a data row.
Namespace: DevExpress.Mobile.DataGrid
Assembly: DevExpress.Mobile.Grid.v18.2.dll
Declaration
Event Data
The SwipeButtonShowing event's data class is SwipeButtonShowingEventArgs. The following properties provide information specific to this event:
| Property | Description |
|---|---|
| ButtonInfo | Gets an object that stores information about a swipe button. Inherited from SwipeButtonEventArgs. |
| IsVisible | Gets or sets the swipe button visibility. |
| RowHandle | Gets the row handle. Inherited from RowEventArgs. |
| SourceRowIndex | Gets the index of the record in a data source to which the processed row corresponds. Inherited from SourceRowEventArgs. |
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.
Handle the SwipeButtonShowing event and set the e.IsVisible property to false to restrict a swipe button added to the GridControl.LeftSwipeButtons or GridControl.RightSwipeButtons collection from being displayed when an end-user swipes left to right, or right to left, over a data row.
Example
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.
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.
