Share via


IUICollectionViewSource Interface

Definition

This interface represents the Objective-C protocol UICollectionViewSource.

[Foundation.Protocol(IsInformal=true, Name="UICollectionViewSource", WrapperType=typeof(UIKit.UICollectionViewSourceWrapper))]
public interface IUICollectionViewSource : IDisposable, UIKit.IUICollectionViewDataSource, UIKit.IUICollectionViewDelegate
[<Foundation.Protocol(IsInformal=true, Name="UICollectionViewSource", WrapperType=typeof(UIKit.UICollectionViewSourceWrapper))>]
type IUICollectionViewSource = interface
    interface INativeObject
    interface IDisposable
    interface IUICollectionViewDataSource
    interface IUICollectionViewDelegate
    interface IUIScrollViewDelegate
Derived
Attributes
Implements

Remarks

A class that implements this interface (and subclasses NSObject) will be exported to Objective-C as implementing the Objective-C protocol this interface represents.

A class may also implement members from this interface to implement members from the protocol.

Properties

Name Description
Handle

Handle (pointer) to the unmanaged object representation.

(Inherited from INativeObject)

Methods

Name Description
CanEditItem(UICollectionView, NSIndexPath) (Inherited from IUICollectionViewDelegate)
CanFocusItem(UICollectionView, NSIndexPath)

Whether the item at indexPath can be focused.

(Inherited from IUICollectionViewDelegate)
CanMoveItem(UICollectionView, NSIndexPath) (Inherited from IUICollectionViewDataSource)
CanPerformAction(UICollectionView, Selector, NSIndexPath, NSObject)

Whether the cell at the specified indexPath supports the specified action.

(Inherited from IUICollectionViewDelegate)
CanPerformPrimaryActionForItem(UICollectionView, NSIndexPath) (Inherited from IUICollectionViewDelegate)
CellDisplayingEnded(UICollectionView, UICollectionViewCell, NSIndexPath)

Indicates that the cell at the specified indexPath has been removed.

(Inherited from IUICollectionViewDelegate)
DecelerationEnded(UIScrollView)

Indicates that deceleration relating to a scroll event has ended.

(Inherited from IUIScrollViewDelegate)
DecelerationStarted(UIScrollView)

Indicates that deceleration of a scrolling event has begun.

(Inherited from IUIScrollViewDelegate)
DidBeginMultipleSelectionInteraction(UICollectionView, NSIndexPath) (Inherited from IUICollectionViewDelegate)
DidChangeAdjustedContentInset(UIScrollView)

Method that is called when the inset values change.

(Inherited from IUIScrollViewDelegate)
DidEndMultipleSelectionInteraction(UICollectionView) (Inherited from IUICollectionViewDelegate)
DidUpdateFocus(UICollectionView, UICollectionViewFocusUpdateContext, UIFocusAnimationCoordinator)

Indicates that the focus changed as detailed in the context.

(Inherited from IUICollectionViewDelegate)
DidZoom(UIScrollView)

Indicates that the specified scrollView has zoomed.

(Inherited from IUIScrollViewDelegate)
DraggingEnded(UIScrollView, Boolean)

Indicates that dragging has completed.

(Inherited from IUIScrollViewDelegate)
DraggingStarted(UIScrollView)

Indicates that dragging has begun.

(Inherited from IUIScrollViewDelegate)
GetCell(UICollectionView, NSIndexPath)

Gets a cell.

(Inherited from IUICollectionViewDataSource)
GetContextMenuConfiguration(UICollectionView, NSIndexPath, CGPoint) (Inherited from IUICollectionViewDelegate)
GetContextMenuConfiguration(UICollectionView, NSIndexPath[], CGPoint) (Inherited from IUICollectionViewDelegate)
GetContextMenuConfigurationDismissalPreview(UICollectionView, UIContextMenuConfiguration, NSIndexPath) (Inherited from IUICollectionViewDelegate)
GetContextMenuConfigurationHighlightPreview(UICollectionView, UIContextMenuConfiguration, NSIndexPath) (Inherited from IUICollectionViewDelegate)
GetIndexPath(UICollectionView, String, IntPtr)

Requests the index path for the item in the collection view at the specified index with the specified title.

(Inherited from IUICollectionViewDataSource)
GetIndexPathForPreferredFocusedView(UICollectionView)

When overridden, allows the developer to specify the item that should initially receive focus.

(Inherited from IUICollectionViewDelegate)
GetIndexTitles(UICollectionView)

Requests the index titles for the items in the specified collection view.

(Inherited from IUICollectionViewDataSource)
GetItemsCount(UICollectionView, IntPtr)

Returns the number of items in the specified section.

(Inherited from IUICollectionViewDataSource)
GetPreviewForDismissingContextMenu(UICollectionView, UIContextMenuConfiguration) (Inherited from IUICollectionViewDelegate)
GetPreviewForHighlightingContextMenu(UICollectionView, UIContextMenuConfiguration) (Inherited from IUICollectionViewDelegate)
GetSceneActivationConfigurationForItem(UICollectionView, NSIndexPath, CGPoint) (Inherited from IUICollectionViewDelegate)
GetSelectionFollowsFocusForItem(UICollectionView, NSIndexPath) (Inherited from IUICollectionViewDelegate)
GetTargetContentOffset(UICollectionView, CGPoint)

When overridden, allows the developer to modify the content offset for layout and animation changes.

(Inherited from IUICollectionViewDelegate)
GetTargetIndexPathForMove(UICollectionView, NSIndexPath, NSIndexPath)

When overridden, allows the developer to modify the final location of a moved item. (For instance, to disallow a move to a particular proposedIndexPath.)

(Inherited from IUICollectionViewDelegate)
GetTargetIndexPathForMoveOfItemFromOriginalIndexPath(UICollectionView, NSIndexPath, NSIndexPath, NSIndexPath) (Inherited from IUICollectionViewDelegate)
GetViewForSupplementaryElement(UICollectionView, NSString, NSIndexPath)

The reusable view used for the supplementary element at the specified indexPath.

(Inherited from IUICollectionViewDataSource)
ItemDeselected(UICollectionView, NSIndexPath)

Indicates that the cell at the specified indexPath has been deselected.

(Inherited from IUICollectionViewDelegate)
ItemHighlighted(UICollectionView, NSIndexPath)

Indicates that the cell at the specified indexPath has been highlighted.

(Inherited from IUICollectionViewDelegate)
ItemSelected(UICollectionView, NSIndexPath)

Indicates that the cell at the specified indexPath has been selected.

(Inherited from IUICollectionViewDelegate)
ItemUnhighlighted(UICollectionView, NSIndexPath)

Indicates that the cell at the specified indexPath has been unhighlighted.

(Inherited from IUICollectionViewDelegate)
MoveItem(UICollectionView, NSIndexPath, NSIndexPath) (Inherited from IUICollectionViewDataSource)
NumberOfSections(UICollectionView)

The number of sections in this UICollectionViewDataSource.

(Inherited from IUICollectionViewDataSource)
PerformAction(UICollectionView, Selector, NSIndexPath, NSObject)

Whether the cell at the specified indexPath supports the specified Copy or Paste action.

(Inherited from IUICollectionViewDelegate)
PerformPrimaryActionForItem(UICollectionView, NSIndexPath) (Inherited from IUICollectionViewDelegate)
ScrollAnimationEnded(UIScrollView)

Indicates that all animations relating to scrolling have completed.

(Inherited from IUIScrollViewDelegate)
Scrolled(UIScrollView)

Indicates that the specified scrollView has scrolled.

(Inherited from IUIScrollViewDelegate)
ScrolledToTop(UIScrollView)

Indicates that the specified scrollView's scrolling has ended at the top.

(Inherited from IUIScrollViewDelegate)
ShouldBeginMultipleSelectionInteraction(UICollectionView, NSIndexPath) (Inherited from IUICollectionViewDelegate)
ShouldDeselectItem(UICollectionView, NSIndexPath)

Whether the cell at the specified indexPath should allow itself to be deselected.

(Inherited from IUICollectionViewDelegate)
ShouldHighlightItem(UICollectionView, NSIndexPath)

Whether the cell at the specified indexPath should allow itself to be highlighted.

(Inherited from IUICollectionViewDelegate)
ShouldScrollToTop(UIScrollView)

Whether a scroll to the beginning of the scrollView should be permitted.

(Inherited from IUIScrollViewDelegate)
ShouldSelectItem(UICollectionView, NSIndexPath)

Whether the cell at the specified indexPath allows itself to be selected.

(Inherited from IUICollectionViewDelegate)
ShouldShowMenu(UICollectionView, NSIndexPath)

Whether the cell at the specified indexPath should show an Action menu.

(Inherited from IUICollectionViewDelegate)
ShouldSpringLoadItem(UICollectionView, NSIndexPath, IUISpringLoadedInteractionContext)

Method that is called to indicate whether the identified item should springload in the specified context.

(Inherited from IUICollectionViewDelegate)
ShouldUpdateFocus(UICollectionView, UICollectionViewFocusUpdateContext)

When overridden, allows the developer to prevent the focus change specified in context.

(Inherited from IUICollectionViewDelegate)
SupplementaryViewDisplayingEnded(UICollectionView, UICollectionReusableView, NSString, NSIndexPath)

Indicates that the supplementary view at the specified indexPath has been removed.

(Inherited from IUICollectionViewDelegate)
TransitionLayout(UICollectionView, UICollectionViewLayout, UICollectionViewLayout)

The UICollectionViewTransitionLayout to be used when moving from the specified fromLayout to the toLayout.

(Inherited from IUICollectionViewDelegate)
ViewForZoomingInScrollView(UIScrollView)

The UIView to scale when zooming is requested.

(Inherited from IUIScrollViewDelegate)
WillDisplayCell(UICollectionView, UICollectionViewCell, NSIndexPath)

The cell is about to be displayed.

(Inherited from IUICollectionViewDelegate)
WillDisplayContextMenu(UICollectionView, UIContextMenuConfiguration, IUIContextMenuInteractionAnimating) (Inherited from IUICollectionViewDelegate)
WillDisplaySupplementaryView(UICollectionView, UICollectionReusableView, String, NSIndexPath)

The supplementary view is about to be displayed.

(Inherited from IUICollectionViewDelegate)
WillEndContextMenuInteraction(UICollectionView, UIContextMenuConfiguration, IUIContextMenuInteractionAnimating) (Inherited from IUICollectionViewDelegate)
WillEndDragging(UIScrollView, CGPoint, CGPoint)

Indicates that dragging is about to end.

(Inherited from IUIScrollViewDelegate)
WillPerformPreviewAction(UICollectionView, UIContextMenuConfiguration, IUIContextMenuInteractionCommitAnimating) (Inherited from IUICollectionViewDelegate)
ZoomingEnded(UIScrollView, UIView, NFloat)

Indicates that zooming has completed.

(Inherited from IUIScrollViewDelegate)
ZoomingStarted(UIScrollView, UIView)

Indicates that zooming has begun.

(Inherited from IUIScrollViewDelegate)

Extension Methods

Name Description
GetHandle(INativeObject)
GetNonNullHandle(INativeObject, String)
CanMoveItem(IUICollectionViewDataSource, UICollectionView, NSIndexPath)
GetIndexPath(IUICollectionViewDataSource, UICollectionView, String, IntPtr)

Requests the index path for the item in the collection view at the specified index with the specified title.

GetIndexTitles(IUICollectionViewDataSource, UICollectionView)

Requests the index titles for the items in the specified collection view.

GetViewForSupplementaryElement(IUICollectionViewDataSource, UICollectionView, NSString, NSIndexPath)

The reusable view used for the supplementary element at the specified indexPath.

MoveItem(IUICollectionViewDataSource, UICollectionView, NSIndexPath, NSIndexPath)
NumberOfSections(IUICollectionViewDataSource, UICollectionView)

The number of sections in this UICollectionViewDataSource.

CanEditItem(IUICollectionViewDelegate, UICollectionView, NSIndexPath)
CanFocusItem(IUICollectionViewDelegate, UICollectionView, NSIndexPath)

Whether the item at indexPath can be focused.

CanPerformAction(IUICollectionViewDelegate, UICollectionView, Selector, NSIndexPath, NSObject)

Whether the cell at the specified indexPath supports the specified action.

CanPerformPrimaryActionForItem(IUICollectionViewDelegate, UICollectionView, NSIndexPath)
CellDisplayingEnded(IUICollectionViewDelegate, UICollectionView, UICollectionViewCell, NSIndexPath)

Indicates that the cell at the specified indexPath has been removed.

DidBeginMultipleSelectionInteraction(IUICollectionViewDelegate, UICollectionView, NSIndexPath)
DidEndMultipleSelectionInteraction(IUICollectionViewDelegate, UICollectionView)
DidUpdateFocus(IUICollectionViewDelegate, UICollectionView, UICollectionViewFocusUpdateContext, UIFocusAnimationCoordinator)

Indicates that the focus changed as detailed in the context.

GetContextMenuConfiguration(IUICollectionViewDelegate, UICollectionView, NSIndexPath, CGPoint)
GetContextMenuConfiguration(IUICollectionViewDelegate, UICollectionView, NSIndexPath[], CGPoint)
GetContextMenuConfigurationDismissalPreview(IUICollectionViewDelegate, UICollectionView, UIContextMenuConfiguration, NSIndexPath)
GetContextMenuConfigurationHighlightPreview(IUICollectionViewDelegate, UICollectionView, UIContextMenuConfiguration, NSIndexPath)
GetIndexPathForPreferredFocusedView(IUICollectionViewDelegate, UICollectionView)

When overridden, allows the developer to specify the item that should initially receive focus.

GetPreviewForDismissingContextMenu(IUICollectionViewDelegate, UICollectionView, UIContextMenuConfiguration)
GetPreviewForHighlightingContextMenu(IUICollectionViewDelegate, UICollectionView, UIContextMenuConfiguration)
GetSceneActivationConfigurationForItem(IUICollectionViewDelegate, UICollectionView, NSIndexPath, CGPoint)
GetSelectionFollowsFocusForItem(IUICollectionViewDelegate, UICollectionView, NSIndexPath)
GetTargetContentOffset(IUICollectionViewDelegate, UICollectionView, CGPoint)

When overridden, allows the developer to modify the content offset for layout and animation changes.

GetTargetIndexPathForMove(IUICollectionViewDelegate, UICollectionView, NSIndexPath, NSIndexPath)

When overridden, allows the developer to modify the final location of a moved item. (For instance, to disallow a move to a particular proposedIndexPath.)

GetTargetIndexPathForMoveOfItemFromOriginalIndexPath(IUICollectionViewDelegate, UICollectionView, NSIndexPath, NSIndexPath, NSIndexPath)
ItemDeselected(IUICollectionViewDelegate, UICollectionView, NSIndexPath)

Indicates that the cell at the specified indexPath has been deselected.

ItemHighlighted(IUICollectionViewDelegate, UICollectionView, NSIndexPath)

Indicates that the cell at the specified indexPath has been highlighted.

ItemSelected(IUICollectionViewDelegate, UICollectionView, NSIndexPath)

Indicates that the cell at the specified indexPath has been selected.

ItemUnhighlighted(IUICollectionViewDelegate, UICollectionView, NSIndexPath)

Indicates that the cell at the specified indexPath has been unhighlighted.

PerformAction(IUICollectionViewDelegate, UICollectionView, Selector, NSIndexPath, NSObject)

Whether the cell at the specified indexPath supports the specified Copy or Paste action.

PerformPrimaryActionForItem(IUICollectionViewDelegate, UICollectionView, NSIndexPath)
ShouldBeginMultipleSelectionInteraction(IUICollectionViewDelegate, UICollectionView, NSIndexPath)
ShouldDeselectItem(IUICollectionViewDelegate, UICollectionView, NSIndexPath)

Whether the cell at the specified indexPath should allow itself to be deselected.

ShouldHighlightItem(IUICollectionViewDelegate, UICollectionView, NSIndexPath)

Whether the cell at the specified indexPath should allow itself to be highlighted.

ShouldSelectItem(IUICollectionViewDelegate, UICollectionView, NSIndexPath)

Whether the cell at the specified indexPath allows itself to be selected.

ShouldShowMenu(IUICollectionViewDelegate, UICollectionView, NSIndexPath)

Whether the cell at the specified indexPath should show an Action menu.

ShouldSpringLoadItem(IUICollectionViewDelegate, UICollectionView, NSIndexPath, IUISpringLoadedInteractionContext)

Method that is called to indicate whether the identified item should springload in the specified context.

ShouldUpdateFocus(IUICollectionViewDelegate, UICollectionView, UICollectionViewFocusUpdateContext)

When overridden, allows the developer to prevent the focus change specified in context.

SupplementaryViewDisplayingEnded(IUICollectionViewDelegate, UICollectionView, UICollectionReusableView, NSString, NSIndexPath)

Indicates that the supplementary view at the specified indexPath has been removed.

TransitionLayout(IUICollectionViewDelegate, UICollectionView, UICollectionViewLayout, UICollectionViewLayout)

The UICollectionViewTransitionLayout to be used when moving from the specified fromLayout to the toLayout.

WillDisplayCell(IUICollectionViewDelegate, UICollectionView, UICollectionViewCell, NSIndexPath)

The cell is about to be displayed.

WillDisplayContextMenu(IUICollectionViewDelegate, UICollectionView, UIContextMenuConfiguration, IUIContextMenuInteractionAnimating)
WillDisplaySupplementaryView(IUICollectionViewDelegate, UICollectionView, UICollectionReusableView, String, NSIndexPath)

The supplementary view is about to be displayed.

WillEndContextMenuInteraction(IUICollectionViewDelegate, UICollectionView, UIContextMenuConfiguration, IUIContextMenuInteractionAnimating)
WillPerformPreviewAction(IUICollectionViewDelegate, UICollectionView, UIContextMenuConfiguration, IUIContextMenuInteractionCommitAnimating)
DecelerationEnded(IUIScrollViewDelegate, UIScrollView)

Indicates that deceleration relating to a scroll event has ended.

DecelerationStarted(IUIScrollViewDelegate, UIScrollView)

Indicates that deceleration of a scrolling event has begun.

DidChangeAdjustedContentInset(IUIScrollViewDelegate, UIScrollView)

Method that is called when the inset values change.

DidZoom(IUIScrollViewDelegate, UIScrollView)

Indicates that the specified scrollView has zoomed.

DraggingEnded(IUIScrollViewDelegate, UIScrollView, Boolean)

Indicates that dragging has completed.

DraggingStarted(IUIScrollViewDelegate, UIScrollView)

Indicates that dragging has begun.

ScrollAnimationEnded(IUIScrollViewDelegate, UIScrollView)

Indicates that all animations relating to scrolling have completed.

Scrolled(IUIScrollViewDelegate, UIScrollView)

Indicates that the specified scrollView has scrolled.

ScrolledToTop(IUIScrollViewDelegate, UIScrollView)

Indicates that the specified scrollView's scrolling has ended at the top.

ShouldScrollToTop(IUIScrollViewDelegate, UIScrollView)

Whether a scroll to the beginning of the scrollView should be permitted.

ViewForZoomingInScrollView(IUIScrollViewDelegate, UIScrollView)

The UIView to scale when zooming is requested.

WillEndDragging(IUIScrollViewDelegate, UIScrollView, CGPoint, CGPoint)

Indicates that dragging is about to end.

ZoomingEnded(IUIScrollViewDelegate, UIScrollView, UIView, NFloat)

Indicates that zooming has completed.

ZoomingStarted(IUIScrollViewDelegate, UIScrollView, UIView)

Indicates that zooming has begun.

Applies to