Interactividad de ListViewListView interactivity

Descargar ejemplo Descargar el ejemploDownload Sample Download the sample

La clase de ListView de Xamarin. Forms admite la interacción del usuario con los datos que presenta.The Xamarin.Forms ListView class supports user interaction with the data it presents.

Selección y pulsacionesSelection and taps

El modo de selección de ListView se controla estableciendo la propiedad ListView.SelectionMode en un valor de la enumeración ListViewSelectionMode :The ListView selection mode is controlled by setting the ListView.SelectionMode property to a value of the ListViewSelectionMode enumeration:

  • Single indica que se puede seleccionar un solo elemento, con el elemento seleccionado resaltado.Single indicates that a single item can be selected, with the selected item being highlighted. Este es el valor predeterminado.This is the default value.
  • None indica que no se pueden seleccionar elementos.None indicates that items cannot be selected.

Cuando un usuario puntea un elemento, se activan dos eventos:When a user taps an item, two events are fired:

Si puntea dos veces en el mismo elemento, se activarán dos ItemTapped eventos, pero solo se activará un evento de ItemSelected .Tapping the same item twice will fire two ItemTapped events, but will only fire a single ItemSelected event.

Nota

La clase ItemTappedEventArgs , que contiene los argumentos de evento para el evento ItemTapped , tiene Group y Item propiedades, y una propiedad ItemIndex cuyo valor representa el índice en el ListView del elemento punteado.The ItemTappedEventArgs class, which contains the event arguments for the ItemTapped event, has Group and Item properties, and an ItemIndex property whose value represents the index in the ListView of the tapped item. Del mismo modo, la clase SelectedItemChangedEventArgs , que contiene los argumentos de evento para el evento ItemSelected , tiene una propiedad SelectedItem y una propiedad SelectedItemIndex cuyo valor representa el índice en el ListView del elemento seleccionado.Similarly, the SelectedItemChangedEventArgs class, which contains the event arguments for the ItemSelected event, has a SelectedItem property, and a SelectedItemIndex property whose value represents the index in the ListView of the selected item.

Cuando la propiedad SelectionMode está establecida en Single, se pueden seleccionar los elementos de la ListView , se activarán los eventos ItemSelected y ItemTapped y la propiedad SelectedItem se establecerá en el valor del elemento seleccionado.When the SelectionMode property is set to Single, items in the ListView can be selected, the ItemSelected and ItemTapped events will be fired, and the SelectedItem property will be set to the value of the selected item.

Cuando la propiedad SelectionMode está establecida en None, no se pueden seleccionar los elementos de la ListView , no se desencadenará el evento de ItemSelected y la propiedad SelectedItem permanecerá null.When the SelectionMode property is set to None, items in the ListView cannot be selected, the ItemSelected event will not be fired, and the SelectedItem property will remain null. Sin embargo, se seguirán activando ItemTapped eventos y el elemento punteado se resaltará brevemente durante la derivación.However, ItemTapped events will still be fired and the tapped item will be briefly highlighted during the tap.

Cuando se ha seleccionado un elemento y se cambia la propiedad SelectionMode de Single a None, la propiedad SelectedItem se establecerá en null y el evento ItemSelected se desencadenará con un elemento null.When an item has been selected and the SelectionMode property is changed from Single to None, the SelectedItem property will be set to null and the ItemSelected event will be fired with a null item.

Las capturas de pantallas siguientes muestran un ListView con el modo de selección predeterminada:The following screenshots show a ListView with the default selection mode:

Deshabilitar selecciónDisable selection

Para deshabilitar ListView selección, establezca la propiedad SelectionMode en None:To disable ListView selection set the SelectionMode property to None:

<ListView ... SelectionMode="None" />
var listView = new ListView { ... SelectionMode = ListViewSelectionMode.None };

Acciones de contextoContext actions

A menudo, los usuarios quieren tomar medidas en un elemento de un ListView.Often, users will want to take action on an item in a ListView. Por ejemplo, considere la posibilidad de obtener una lista de mensajes de correo electrónico en la aplicación de correo.For example, consider a list of emails in the Mail app. En iOS, puede deslizar rápidamente para eliminar un mensaje:On iOS, you can swipe to delete a message:

Acciones de contexto se pueden implementar en C# y XAML.Context actions can be implemented in C# and XAML. A continuación encontrará guías específicas para ambos, pero primero vamos a Eche un vistazo a algunos detalles de implementación clave para ambos.Below you'll find specific guides for both, but first let's take a look at some key implementation details for both.

Las acciones de contexto se crean mediante elementos MenuItem.Context Actions are created using MenuItem elements. Los eventos TAP para los objetos MenuItems los genera el MenuItem mismo, no los ListView.Tap events for MenuItems objects are raised by the MenuItem itself, not the ListView. Esto es diferente de cómo se controlan los eventos TAP para las celdas, donde el ListView genera el evento en lugar de la celda.This is different from how tap events are handled for cells, where the ListView raises the event rather than the cell. Dado que el ListView está provocando el evento, su controlador de eventos proporciona información de clave, como qué elemento se ha seleccionado o punteado.Because the ListView is raising the event, its event handler is given key information, like which item was selected or tapped.

De forma predeterminada, un MenuItem no tiene ninguna manera de saber a qué celda pertenece.By default, a MenuItem has no way of knowing which cell it belongs to. La propiedad CommandParameter está disponible en MenuItem para almacenar objetos, como el objeto situado detrás del ViewCelldel MenuItem.The CommandParameter property is available on MenuItem to store objects, such as the object behind the MenuItem's ViewCell. La propiedad CommandParameter se puede establecer en XAML y C#.The CommandParameter property can be set in both XAML and C#.

XAMLXAML

MenuItem elementos se pueden crear en una colección XAML.MenuItem elements can be created in a XAML collection. El XAML siguiente muestra una celda personalizada con dos acciones de contexto implementadas:The XAML below demonstrates a custom cell with two context actions implemented:

<ListView x:Name="ContextDemoList">
  <ListView.ItemTemplate>
    <DataTemplate>
      <ViewCell>
         <ViewCell.ContextActions>
            <MenuItem Clicked="OnMore"
                      CommandParameter="{Binding .}"
                      Text="More" />
            <MenuItem Clicked="OnDelete"
                      CommandParameter="{Binding .}"
                      Text="Delete" IsDestructive="True" />
         </ViewCell.ContextActions>
         <StackLayout Padding="15,0">
              <Label Text="{Binding title}" />
         </StackLayout>
      </ViewCell>
    </DataTemplate>
  </ListView.ItemTemplate>
</ListView>

En el archivo de código subyacente, asegúrese de que se implementan los métodos de Clicked:In the code-behind file, ensure the Clicked methods are implemented:

public void OnMore (object sender, EventArgs e)
{
    var mi = ((MenuItem)sender);
    DisplayAlert("More Context Action", mi.CommandParameter + " more context action", "OK");
}

public void OnDelete (object sender, EventArgs e)
{
    var mi = ((MenuItem)sender);
    DisplayAlert("Delete Context Action", mi.CommandParameter + " delete context action", "OK");
}

Nota

El NavigationPageRenderer para Android tiene un método de UpdateMenuItemIcon reemplazable que se puede usar para cargar iconos desde un Drawablepersonalizado.The NavigationPageRenderer for Android has an overridable UpdateMenuItemIcon method that can be used to load icons from a custom Drawable. Esta invalidación permite usar imágenes SVG como iconos en instancias de MenuItem en Android.This override makes it possible to use SVG images as icons on MenuItem instances on Android.

CódigoCode

Las acciones de contexto se pueden implementar en cualquier subclase de Cell (siempre y cuando no se use como encabezado de grupo) creando instancias de MenuItem y agregándolas a la colección de ContextActions para la celda.Context actions can be implemented in any Cell subclass (as long as it isn't being used as a group header) by creating MenuItem instances and adding them to the ContextActions collection for the cell. Tiene las siguientes propiedades se pueden configurar para la acción de contexto:You have the following properties can be configured for the context action:

  • Texto – la cadena que aparece en el elemento de menú.Text – the string that appears in the menu item.
  • Haga clic en – el evento cuando se haga clic en el elemento.Clicked – the event when the item is clicked.
  • IsDestructive – (opcional) si es true, el elemento se representa de forma diferente en iOS.IsDestructive – (optional) when true the item is rendered differently on iOS.

Se pueden agregar varias acciones de contexto a una celda, pero solo una debe tener IsDestructive establecida en true.Multiple context actions can be added to a cell, however only one should have IsDestructive set to true. En el código siguiente se muestra cómo se agregarán acciones de contexto a un ViewCell:The following code demonstrates how context actions would be added to a ViewCell:

var moreAction = new MenuItem { Text = "More" };
moreAction.SetBinding (MenuItem.CommandParameterProperty, new Binding ("."));
moreAction.Clicked += async (sender, e) =>
{
    var mi = ((MenuItem)sender);
    Debug.WriteLine("More Context Action clicked: " + mi.CommandParameter);
};

var deleteAction = new MenuItem { Text = "Delete", IsDestructive = true }; // red background
deleteAction.SetBinding (MenuItem.CommandParameterProperty, new Binding ("."));
deleteAction.Clicked += async (sender, e) =>
{
    var mi = ((MenuItem)sender);
    Debug.WriteLine("Delete Context Action clicked: " + mi.CommandParameter);
};
// add to the ViewCell's ContextActions property
ContextActions.Add (moreAction);
ContextActions.Add (deleteAction);

Extraer para actualizarPull to refresh

Los usuarios han llegado a esperar que extraer en una lista de datos se actualizará esa lista.Users have come to expect that pulling down on a list of data will refresh that list. El control ListView es compatible con esta plataforma.The ListView control supports this out-of-the-box. Para habilitar la funcionalidad de extracción para actualizar, establezca IsPullToRefreshEnabled en true:To enable pull-to-refresh functionality, set IsPullToRefreshEnabled to true:

<ListView ...
          IsPullToRefreshEnabled="true" />

El código de C# equivalente es el siguiente:The equivalent C# code is:

listView.IsPullToRefreshEnabled = true;

Aparece un control de número durante la actualización, que es negro de forma predeterminada.A spinner appears during the refresh, which is black by default. Sin embargo, el color del control de número se puede cambiar en iOS y Android estableciendo la propiedad RefreshControlColor en un Color:However, the spinner color can be changed on iOS and Android by setting the RefreshControlColor property to a Color:

<ListView ...
          IsPullToRefreshEnabled="true"
          RefreshControlColor="Red" />

El código de C# equivalente es el siguiente:The equivalent C# code is:

listView.RefreshControlColor = Color.Red;

Las siguientes capturas de pantallas muestran la incorporación de cambios a la actualización cuando el usuario extrae:The following screenshots show pull-to-refresh as the user is pulling:

Las siguientes capturas de pantallas muestran la extracción a la actualización después de que el usuario haya lanzado la extracción, con el control de número que se muestra mientras se actualiza el ListView :The following screenshots show pull-to-refresh after the user has released the pull, with the spinner being shown while the ListView is updating:

ListView activa el evento Refreshing para iniciar la actualización y la propiedad IsRefreshing se establecerá en true.ListView fires the Refreshing event to initiate the refresh, and the IsRefreshing property will be set to true. Cualquier código necesario para actualizar el contenido de la ListView debe ser ejecutado por el controlador de eventos para el evento Refreshing, o por el método ejecutado por el RefreshCommand.Whatever code is required to refresh the contents of the ListView should then be executed by the event handler for the Refreshing event, or by the method executed by the RefreshCommand. Una vez actualizado el ListView, la propiedad IsRefreshing se debe establecer en false, o se debe llamar al método EndRefresh para indicar que la actualización se ha completado.Once the ListView is refreshed, the IsRefreshing property should be set to false, or the EndRefresh method should be called, to indicate that the refresh is complete.

Nota

Al definir un RefreshCommand, se puede especificar el método de CanExecute del comando para habilitar o deshabilitar el comando.When defining a RefreshCommand, the CanExecute method of the command can be specified to enable or disable the command.

Detectar desplazamientoDetect scrolling

ListView define un evento de Scrolled que se desencadena para indicar que se ha producido el desplazamiento.ListView defines a Scrolled event that's fired to indicate that scrolling occurred. En el ejemplo de XAML siguiente se muestra un ListView que establece un controlador de eventos para el evento Scrolled:The following XAML example shows a ListView that sets an event handler for the Scrolled event:

<ListView Scrolled="OnListViewScrolled">
    ...
</ListView>

El código de C# equivalente es el siguiente:The equivalent C# code is:

ListView listView = new ListView();
listView.Scrolled += OnListViewScrolled;

En este ejemplo de código, se ejecuta el controlador de eventos OnListViewScrolled cuando se activa el evento Scrolled:In this code example, the OnListViewScrolled event handler is executed when the Scrolled event fires:

void OnListViewScrolled(object sender, ScrolledEventArgs e)
{
    Debug.WriteLine("ScrollX: " + e.ScrollX);
    Debug.WriteLine("ScrollY: " + e.ScrollY);  
}

El controlador de eventos OnListViewScrolled devuelve los valores del objeto ScrolledEventArgs que acompaña al evento.The OnListViewScrolled event handler outputs the values of the ScrolledEventArgs object that accompanies the event.