Instance Method

selectItemAtIndexPath:animated:scrollPosition:

Selects the item at the specified index path and optionally scrolls it into view.

Declaration

- (void)selectItemAtIndexPath:(NSIndexPath *)indexPath animated:(BOOL)animated scrollPosition:(UICollectionViewScrollPosition)scrollPosition;

Parameters

indexPath

The index path of the item to select. Specifying nil for this parameter clears the current selection.

animated

Specify YES to animate the change in the selection or NO to make the change without animating it.

scrollPosition

An option that specifies where the item should be positioned when scrolling finishes. For a list of possible values, see UICollectionViewScrollPosition.

Discussion

If the allowsSelection property is NO, calling this method has no effect. If there is an existing selection with a different index path and the allowsMultipleSelection property is NO, calling this method replaces the previous selection.

This method does not cause any selection-related delegate methods to be called.

See Also

Managing the Selection

allowsSelection

A Boolean value that indicates whether users can select items in the collection view.

allowsMultipleSelection

A Boolean value that determines whether users can select more than one item in the collection view.

indexPathsForSelectedItems

The index paths for the selected items.

- deselectItemAtIndexPath:animated:

Deselects the item at the specified index.