CollectionView.MoveCurrentTo Method (Object)

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Sets the specified item to be the CurrentItem in the view.

Namespace:   System.Windows.Data
Assembly:  PresentationFramework (in PresentationFramework.dll)

Public Overridable Function MoveCurrentTo (
	item As Object
) As Boolean

Parameters

item
Type: System.Object

The item to set as the CurrentItem.

Return Value

Type: System.Boolean

true if the resulting CurrentItem is within the view; otherwise, false.

If the specified item is not found, the method returns false and the CurrentItem is positioned before the beginning of the collection in the view.

Collection views support the concept of a current record pointer. As you navigate through the objects in a collection view, you are moving a record pointer that allows you to retrieve the object that exists at that particular location in the collection. For more information, see "Binding to Collections" in Data Binding Overview.

For more information about the current item of a view, see CurrentItem.

The following example demonstrates the use of this method.

' Event handler for the NewColor button
Private Sub OnNewColorClicked(ByVal sender As Object, ByVal args As RoutedEventArgs)
  Dim button As Button = CType(sender, Button)
  Dim colorList As ColorItemList = CType(button.DataContext, ColorItemList)
  Dim cv As CollectionView = CType(CollectionViewSource.GetDefaultView(CType(colorList, IEnumerable)), CollectionView)

  ' add a new color based on the current one, then select the new one
  Dim newItem As New ColorItem(CType(cv.CurrentItem, ColorItem))
  colorList.Add(newItem)
  cv.MoveCurrentTo(newItem)
End Sub

.NET Framework
Available since 3.0
Return to top
Show: