Rolagem de CollectionView do Xamarin. FormsXamarin.Forms CollectionView Scrolling

Baixar Exemplo Baixar o exemploDownload Sample Download the sample

CollectionViewdefine dois ScrollTo métodos, que rolam itens para o modo de exibição.CollectionView defines two ScrollTo methods, that scroll items into view. Uma das sobrecargas rola o item no índice especificado para a exibição, enquanto o outro rola o item especificado para a exibição.One of the overloads scrolls the item at the specified index into view, while the other scrolls the specified item into view. Ambas as sobrecargas têm argumentos adicionais que podem ser especificados para indicar a posição exata do item após a conclusão da rolagem e se a rolagem deve ser animada.Both overloads have additional arguments that can be specified to indicate the exact position of the item after the scroll has completed, and whether to animate the scroll.

CollectionViewdefine um ScrollToRequested evento que é acionado quando um ScrollTo dos métodos é invocado.CollectionView defines a ScrollToRequested event that is fired when one of the ScrollTo methods is invoked. O ScrollToRequestedEventArgs objeto que acompanha o ScrollToRequested evento tem muitas ScrollToPosition IsAnimated IndexPropriedades, incluindo, ,e.ItemThe ScrollToRequestedEventArgs object that accompanies the ScrollToRequested event has many properties, including IsAnimated, Index, Item, and ScrollToPosition. Essas propriedades são definidas a partir dos argumentos especificados nas ScrollTo chamadas de método.These properties are set from the arguments specified in the ScrollTo method calls.

Quando um usuário passa o dedo para iniciar uma rolagem, a posição final da rolagem pode ser controlada para que os itens sejam totalmente exibidos.When a user swipes to initiate a scroll, the end position of the scroll can be controlled so that items are fully displayed. Esse recurso é conhecido como encaixe, pois os itens se ajustam à posição quando a rolagem é interrompida.This feature is known as snapping, because items snap to position when scrolling stops. Para obter mais informações, consulte snap Points.For more information, see Snap points.

Rolar um item em um índice para a exibiçãoScroll an item at an index into view

A primeira ScrollTo sobrecarga do método rola o item no índice especificado para a exibição.The first ScrollTo method overload scrolls the item at the specified index into view. Dado um CollectionView objeto chamado collectionView, o exemplo a seguir mostra como rolar o item no índice 12 para a exibição:Given a CollectionView object named collectionView, the following example shows how to scroll the item at index 12 into view:

collectionView.ScrollTo(12);

Rolar um item para a exibiçãoScroll an item into view

A sobrecarga ScrollTo do segundo método rola o item especificado para a exibição.The second ScrollTo method overload scrolls the specified item into view. Dado um CollectionView objeto chamado collectionView, o exemplo a seguir mostra como rolar o item especificado para a exibição:Given a CollectionView object named collectionView, the following example shows how to scroll the specified item into view:

MonkeysViewModel viewModel = BindingContext as MonkeysViewModel;
Monkey monkey = viewModel.Monkeys.FirstOrDefault(m => m.Name == "Proboscis Monkey");
collectionView.ScrollTo(monkey);

Posição de rolagem de controleControl scroll position

Ao rolar um item para a exibição, a posição exata do item após a rolagem concluída pode ser especificada com o position argumento ScrollTo dos métodos.When scrolling an item into view, the exact position of the item after the scroll has completed can be specified with the position argument of the ScrollTo methods. Esse argumento aceita um ScrollToPosition membro de enumeração.This argument accepts a ScrollToPosition enumeration member.

MakeVisibleMakeVisible

O ScrollToPosition.MakeVisible membro indica que o item deve ser rolado até que fique visível na exibição:The ScrollToPosition.MakeVisible member indicates that the item should be scrolled until it's visible in the view:

collectionView.ScrollTo(monkey, position: ScrollToPosition.MakeVisible);

Este código de exemplo resulta na rolagem mínima necessária para rolar o item para a exibição:This example code results in the minimal scrolling required to scroll the item into view:

[ Captura de tela de uma lista vertical de CollectionView com um item rolado na exibição, em lista vertical de CollectionView do Android e Ios ] (scrolling-images/scrolltoposition-makevisible-large.png#lightbox "Lista vertical CollectionView com item rolado")Screenshot of a CollectionView vertical list with an item scrolled into view, on iOS and Android

Observação

O ScrollToPosition.MakeVisible membro será usado por padrão, se o position argumento não for especificado ao chamar o ScrollTo método.The ScrollToPosition.MakeVisible member is used by default, if the position argument is not specified when calling the ScrollTo method.

InícioStart

O ScrollToPosition.Start membro indica que o item deve ser rolado até o início da exibição:The ScrollToPosition.Start member indicates that the item should be scrolled to the start of the view:

collectionView.ScrollTo(monkey, position: ScrollToPosition.Start);

Este código de exemplo resulta no item que está sendo rolado para o início da exibição:This example code results in the item being scrolled to the start of the view:

[ Captura de tela de uma lista vertical de CollectionView com um item rolado na exibição, em lista vertical de CollectionView do Android e Ios ] (scrolling-images/scrolltoposition-start-large.png#lightbox "Lista vertical CollectionView com item rolado")Screenshot of a CollectionView vertical list with an item scrolled into view, on iOS and Android

CentralizadoCenter

O ScrollToPosition.Center membro indica que o item deve ser rolado para o centro da exibição:The ScrollToPosition.Center member indicates that the item should be scrolled to the center of the view:

collectionView.ScrollTo(monkey, position: ScrollToPosition.Center);

Este código de exemplo resulta no item que está sendo rolado para o centro da exibição:This example code results in the item being scrolled to the center of the view:

[ Captura de tela de uma lista vertical de CollectionView com um item rolado na exibição, em lista vertical de CollectionView do Android e Ios ] (scrolling-images/scrolltoposition-center-large.png#lightbox "Lista vertical CollectionView com item rolado")Screenshot of a CollectionView vertical list with an item scrolled into view, on iOS and Android

EndEnd

O ScrollToPosition.End membro indica que o item deve ser rolado para o final da exibição:The ScrollToPosition.End member indicates that the item should be scrolled to the end of the view:

collectionView.ScrollTo(monkey, position: ScrollToPosition.End);

Este código de exemplo resulta no item que está sendo rolado para o final da exibição:This example code results in the item being scrolled to the end of the view:

[ Captura de tela de uma lista vertical de CollectionView com um item rolado na exibição, em lista vertical de CollectionView do Android e Ios ] (scrolling-images/scrolltoposition-end-large.png#lightbox "Lista vertical CollectionView com item rolado")Screenshot of a CollectionView vertical list with an item scrolled into view, on iOS and Android

Desabilitar animação de rolagemDisable scroll animation

Uma animação de rolagem é exibida ao rolar um item para a exibição.A scrolling animation is displayed when scrolling an item into view. No entanto, essa animação pode ser desabilitada animate definindo o argumento ScrollTo do método falsecomo:However, this animation can be disabled by setting the animate argument of the ScrollTo method to false:

collectionView.ScrollTo(monkey, animate: false);

Pontos de ajusteSnap points

Quando um usuário passa o dedo para iniciar uma rolagem, a posição final da rolagem pode ser controlada para que os itens sejam totalmente exibidos.When a user swipes to initiate a scroll, the end position of the scroll can be controlled so that items are fully displayed. Esse recurso é conhecido como encaixe, pois os itens se ajustam à posição quando a rolagem é interrompida e é controlado pelas seguintes ItemsLayout Propriedades da classe:This feature is known as snapping, because items snap to position when scrolling stops, and is controlled by the following properties from the ItemsLayout class:

Essas propriedades são apoiadas por BindableProperty objetos, o que significa que as propriedades podem ser destinos de associações de dados.These properties are backed by BindableProperty objects, which means that the properties can be targets of data bindings.

Observação

Quando o ajuste ocorre, ele ocorrerá na direção que produz a menor quantidade de movimentos.When snapping occurs, it will occur in the direction that produces the least amount of motion.

Tipo de pontos de ajusteSnap points type

A SnapPointsType enumeração define os seguintes membros:The SnapPointsType enumeration defines the following members:

  • Noneindica que a rolagem não se ajusta aos itens.None indicates that scrolling does not snap to items.
  • Mandatoryindica que o conteúdo sempre se ajusta ao ponto de ajuste mais próximo para onde a rolagem seria interrompida naturalmente, ao longo da direção de inércia.Mandatory indicates that content always snaps to the closest snap point to where scrolling would naturally stop, along the direction of inertia.
  • MandatorySingleindica o mesmo comportamento que Mandatory, mas apenas rola um item de cada vez.MandatorySingle indicates the same behavior as Mandatory, but only scrolls one item at a time.

Por padrão, a SnapPointsType propriedade é definida como SnapPointsType.None, o que garante que a rolagem não enencaixe itens, conforme mostrado nas capturas de tela a seguir:By default, the SnapPointsType property is set to SnapPointsType.None, which ensures that scrolling does not snap items, as shown in the following screenshots:

[ Captura de tela de uma lista vertical de CollectionView sem pontos de encaixe, na lista vertical de CollectionView do Android e Ios ] (scrolling-images/snappoints-none-large.png#lightbox "Lista vertical CollectionView sem pontos de ajuste")Screenshot of a CollectionView vertical list without snap points, on iOS and Android

Alinhamento dos pontos de ajusteSnap points alignment

A SnapPointsAlignment enumeração define Startos CenterMembros, End e.The SnapPointsAlignment enumeration defines Start, Center, and End members.

Importante

O valor da SnapPointsAlignment propriedade é respeitado somente quando a SnapPointsType propriedade é definida como Mandatory, ou MandatorySingle.The value of the SnapPointsAlignment property is only respected when the SnapPointsType property is set to Mandatory, or MandatorySingle.

InícioStart

O SnapPointsAlignment.Start membro indica que os pontos de ajuste estão alinhados com a borda à esquerda dos itens.The SnapPointsAlignment.Start member indicates that snap points are aligned with the leading edge of items.

Por padrão, a SnapPointsAlignment propriedade é definida como SnapPointsAlignment.Start.By default, the SnapPointsAlignment property is set to SnapPointsAlignment.Start. No entanto, para fins de integridade, o exemplo XAML a seguir mostra como definir esse membro de enumeração:However, for completeness, the following XAML example shows how to set this enumeration member:

<CollectionView x:Name="collectionView"
                ItemsSource="{Binding Monkeys}">
    <CollectionView.ItemsLayout>
        <ListItemsLayout SnapPointsType="MandatorySingle"
                         SnapPointsAlignment="Start">
            <x:Arguments>
                <ItemsLayoutOrientation>Vertical</ItemsLayoutOrientation>
            </x:Arguments>
        </ListItemsLayout>
    </CollectionView.ItemsLayout>
    <CollectionView.ItemTemplate>
        <DataTemplate>
            ...
        </DataTemplate>
    </CollectionView.ItemTemplate>
</CollectionView>

O código C# equivalente é:The equivalent C# code is:

CollectionView collectionView = new CollectionView
{
    ItemsLayout = new ListItemsLayout(ItemsLayoutOrientation.Vertical)
    {
        SnapPointsType = SnapPointsType.MandatorySingle,
        SnapPointsAlignment = SnapPointsAlignment.Start
    },
    ItemTemplate = new DataTemplate(() =>
    {
        return null;
    })
};

Quando um usuário passa o dedo para iniciar uma rolagem, o item superior será alinhado com a parte superior da exibição:When a user swipes to initiate a scroll, the top item will be aligned with the top of the view:

[ Captura de tela de uma lista vertical de CollectionView com pontos de partida de início, na lista vertical de CollectionView do Android e Ios ] (scrolling-images/snappoints-start-large.png#lightbox "Lista vertical CollectionView com pontos de ajuste de início")Screenshot of a CollectionView vertical list with start snap points, on iOS and Android

CentralizadoCenter

O SnapPointsAlignment.Center membro indica que os pontos de ajuste estão alinhados ao centro dos itens.The SnapPointsAlignment.Center member indicates that snap points are aligned with the center of items. O exemplo de XAML a seguir mostra como definir esse membro de enumeração:The following XAML example shows how to set this enumeration member:

<CollectionView x:Name="collectionView"
                ItemsSource="{Binding Monkeys}">
    <CollectionView.ItemsLayout>
        <ListItemsLayout SnapPointsType="MandatorySingle"
                         SnapPointsAlignment="Center">
            <x:Arguments>
                <ItemsLayoutOrientation>Vertical</ItemsLayoutOrientation>
            </x:Arguments>
        </ListItemsLayout>
    </CollectionView.ItemsLayout>
    <CollectionView.ItemTemplate>
        <DataTemplate>
            ...
        </DataTemplate>
    </CollectionView.ItemTemplate>
</CollectionView>

O código C# equivalente é:The equivalent C# code is:

CollectionView collectionView = new CollectionView
{
    ItemsLayout = new ListItemsLayout(ItemsLayoutOrientation.Vertical)
    {
        SnapPointsType = SnapPointsType.MandatorySingle,
        SnapPointsAlignment = SnapPointsAlignment.Center
    },
    ItemTemplate = new DataTemplate(() =>
    {
        return null;
    })
};

Quando um usuário passa o dedo para iniciar uma rolagem, o item superior será alinhado ao centro na parte superior da exibição:When a user swipes to initiate a scroll, the top item will be center aligned at the top of the view:

[ Captura de tela de uma lista vertical de CollectionView com pontos de alinhamento do centro, na lista vertical de CollectionView do Android e Ios ] (scrolling-images/snappoints-center-large.png#lightbox "Lista vertical CollectionView com pontos de alinhamento do centro")Screenshot of a CollectionView vertical list with center snap points, on iOS and Android

EndEnd

O SnapPointsAlignment.End membro indica que os pontos de ajuste estão alinhados com a borda à direita dos itens.The SnapPointsAlignment.End member indicates that snap points are aligned with the trailing edge of items. O exemplo de XAML a seguir mostra como definir esse membro de enumeração:The following XAML example shows how to set this enumeration member:

<CollectionView x:Name="collectionView"
                ItemsSource="{Binding Monkeys}">
    <CollectionView.ItemsLayout>
        <ListItemsLayout SnapPointsType="MandatorySingle"
                         SnapPointsAlignment="End">
            <x:Arguments>
                <ItemsLayoutOrientation>Vertical</ItemsLayoutOrientation>
            </x:Arguments>
        </ListItemsLayout>
    </CollectionView.ItemsLayout>
    <CollectionView.ItemTemplate>
        <DataTemplate>
            ...
        </DataTemplate>
    </CollectionView.ItemTemplate>
</CollectionView>

O código C# equivalente é:The equivalent C# code is:

CollectionView collectionView = new CollectionView
{
    ItemsLayout = new ListItemsLayout(ItemsLayoutOrientation.Vertical)
    {
        SnapPointsType = SnapPointsType.MandatorySingle,
        SnapPointsAlignment = SnapPointsAlignment.End
    },
    ItemTemplate = new DataTemplate(() =>
    {
        return null;
    })
};

Quando um usuário passa o dedo para iniciar uma rolagem, o item inferior será alinhado com a parte inferior da exibição:When a user swipes to initiate a scroll, the bottom item will be aligned with the bottom of the view:

[ Captura de tela de uma lista vertical de CollectionView com pontos de ajuste finais, na lista vertical de CollectionView do Android e Ios ] (scrolling-images/snappoints-end-large.png#lightbox "Lista vertical CollectionView com pontos de ajuste finais")Screenshot of a CollectionView vertical list with end snap points, on iOS and Android