ListViewPersistenceHelper Class

Definition

Represents a helper class to save and retrieve the relative scroll position of the ListView.

public ref class ListViewPersistenceHelper sealed
/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 65536)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
class ListViewPersistenceHelper final
[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 65536)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
public sealed class ListViewPersistenceHelper
Public NotInheritable Class ListViewPersistenceHelper
Inheritance
Object IInspectable ListViewPersistenceHelper
Attributes

Windows requirements

Device family
Windows 10 (introduced in 10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced in v1.0)

Examples

For a complete implementation, see the [Restore scroll position sample]https://github.com/microsoft/Windows-universal-samples/blob/main/Samples/XamlListView/cs/Scenario5_RestoreScrollPosition.xaml.cs) in the ListView and GridView sample repository.

Remarks

If the ItemsStackPanel.ItemsUpdatingScrollMode property is set to KeepItemsInView, ListViewPersistenceHelper attempts to restore the scroll position using the key of the first visible item. If ItemsUpdatingScrollMode is KeepLastItemInView, it attempts to restore the scroll position using the key of the last visible item.

Methods

GetRelativeScrollPosition(ListViewBase, ListViewItemToKeyHandler)

Retrieves the relative scroll position of the ListView.

SetRelativeScrollPositionAsync(ListViewBase, String, ListViewKeyToItemHandler)

Begins an asynchronous action to set the relative scroll position of the ListView.

Applies to