UICollectionViewFlowLayout Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
A flow-based layout for use with UICollectionViews.
[Foundation.Register("UICollectionViewFlowLayout", true)]
[ObjCRuntime.Introduced(ObjCRuntime.PlatformName.iOS, 6, 0, ObjCRuntime.PlatformArchitecture.All, null)]
public class UICollectionViewFlowLayout : UIKit.UICollectionViewLayouttype UICollectionViewFlowLayout = class
inherit UICollectionViewLayout- Inheritance
- Attributes
Remarks
UICollectionViews allow content to be displayed using arbitrary layouts. The UICollectionViewFlowLayout provides an easy-to-use flow-based layout.
The UICollectionViewFlowLayout lays out UICollectionViewCells side-by-side, either horizontally or vertically. Component UICollectionViewCells wrap at the boundaries. Cells are spaced in the direction of layout according to the MinimumInteritemSpacing property and rows (whether horizontal or vertical) are separated based on the MinimumLineSpacing property.
The application developer can use various methods of UICollectionViewDelegateFlowLayout to modify the exact spacing and size of cells within a UICollectionViewFlowLayout.
The direction of the flow layout is at right angles to the direction of the ScrollDirection property. In the following image, the flow layout is left-to-right and the ScrollDirection is Vertical.
Constructors
| UICollectionViewFlowLayout() |
Default constructor, initializes a new instance of this class. |
| UICollectionViewFlowLayout(IntPtr) |
A constructor used when creating managed representations of unmanaged objects; Called by the runtime. |
| UICollectionViewFlowLayout(NSCoder) |
A constructor that initializes the object from the data stored in the unarchiver object. |
| UICollectionViewFlowLayout(NSObjectFlag) |
Constructor to call on derived classes to skip initialization and merely allocate the object. |
Properties
| AutomaticSize | |
| Class | (Inherited from NSObject) |
| ClassHandle |
The handle for this class. |
| CollectionView |
The UICollectionView which this UICollectionViewLayout is laying out. (Inherited from UICollectionViewLayout) |
| CollectionViewContentSize |
The SizeF of this UICollectionViewLayout's content. (Inherited from UICollectionViewLayout) |
| DebugDescription |
A developer-meaningful description of this object. (Inherited from NSObject) |
| Description |
Description of the object, the Objective-C version of ToString. (Inherited from NSObject) |
| DevelopmentLayoutDirection |
Gets the language direction that was used during development. (Inherited from UICollectionViewLayout) |
| EstimatedItemSize |
Gets or sets the size estimation that is used, for example, to calculate the height of off-screen cells. |
| FlipsHorizontallyInOppositeLayoutDirection |
Gets a Boolean that tells whether the coordinate system horizontally reverses for reversed layout directions. (Inherited from UICollectionViewLayout) |
| FooterReferenceSize |
Specifies the SizeF of the footer of a UICollectionViewFlowLayout section. |
| Handle |
Handle (pointer) to the unmanaged object representation. (Inherited from NSObject) |
| HeaderReferenceSize |
The default SizeF for section headers.|The defaultSizeF for section headers. |
| IsDirectBinding | (Inherited from NSObject) |
| IsProxy | (Inherited from NSObject) |
| ItemSize |
The default size of the UICollectionViewCells being displayed. |
| MinimumInteritemSpacing |
The minimum spacing between cells in the direction of the flow (i.e., between sides if horizontal, between bottom and top if vertical). |
| MinimumLineSpacing |
The minimum spacing between new lines of cells, in the direction of the ScrollDirection property (i.e., the opposite of the flow direction). |
| RetainCount |
Returns the current Objective-C retain count for the object. (Inherited from NSObject) |
| ScrollDirection |
The scrolling direction, which is at right angles to the flow direction. |
| SectionFootersPinToVisibleBounds |
Gets or sets whether section footers should be pinned to the bounds. |
| SectionHeadersPinToVisibleBounds |
Gets or sets whether section headers should be pinned to the bounds. |
| SectionInset |
Insets between sections. |
| SectionInsetReference | |
| Self | (Inherited from NSObject) |
| Superclass | (Inherited from NSObject) |
| SuperHandle |
Handle used to represent the methods in the base class for this NSObject. (Inherited from NSObject) |
| Zone | (Inherited from NSObject) |
Methods
| AddObserver(NSObject, NSString, NSKeyValueObservingOptions, IntPtr) |
Registers an object for being observed externally (using NSString keyPath). Observed changes are dispatched to the observer’s object ObserveValue(NSString, NSObject, NSDictionary, IntPtr) method. (Inherited from NSObject) |
| AddObserver(NSObject, String, NSKeyValueObservingOptions, IntPtr) |
Registers an object for being observed externally (using string keyPath). Observed changes are dispatched to the observer’s object ObserveValue(NSString, NSObject, NSDictionary, IntPtr) method. (Inherited from NSObject) |
| AddObserver(NSString, NSKeyValueObservingOptions, Action<NSObservedChange>) |
Registers an object for being observed externally using an arbitrary method. (Inherited from NSObject) |
| AddObserver(String, NSKeyValueObservingOptions, Action<NSObservedChange>) |
Registers an object for being observed externally using an arbitrary method. (Inherited from NSObject) |
| AwakeFromNib() |
Called after the object has been loaded from the nib file. Overriders must call base.AwakeFromNib(). (Inherited from NSObject) |
| BeginInvokeOnMainThread(Action) | (Inherited from NSObject) |
| BeginInvokeOnMainThread(Selector, NSObject) |
Invokes asynchrously the specified code on the main UI thread. (Inherited from NSObject) |
| Bind(NSString, NSObject, String, NSDictionary) | (Inherited from NSObject) |
| Bind(String, NSObject, String, NSDictionary) |
Obsolete.
(Inherited from NSObject)
|
| BindingInfo(String) |
Obsolete.
(Inherited from NSObject)
|
| BindingOptionDescriptions(String) |
Obsolete.
(Inherited from NSObject)
|
| BindingValueClass(String) |
Obsolete.
(Inherited from NSObject)
|
| CommitEditing() | (Inherited from NSObject) |
| CommitEditing(NSObject, Selector, IntPtr) | (Inherited from NSObject) |
| ConformsToProtocol(IntPtr) |
Invoked to determine if this object implements the specified protocol. (Inherited from NSObject) |
| Copy() |
Performs a copy of the underlying Objective-C object. (Inherited from NSObject) |
| DangerousAutorelease() | (Inherited from NSObject) |
| DangerousRelease() | (Inherited from NSObject) |
| DangerousRetain() | (Inherited from NSObject) |
| DidChange(NSKeyValueChange, NSIndexSet, NSString) |
Indicates a change occurred to the indexes for a to-many relationship. (Inherited from NSObject) |
| DidChange(NSString, NSKeyValueSetMutationKind, NSSet) | (Inherited from NSObject) |
| DidChangeValue(String) |
Indicates that a change occurred on the specified key. (Inherited from NSObject) |
| Dispose() |
Releases the resources used by the NSObject object. (Inherited from NSObject) |
| Dispose(Boolean) |
Releases the resources used by the NSObject object. (Inherited from NSObject) |
| DoesNotRecognizeSelector(Selector) |
Indicates that this object does not recognize the specified selector. (Inherited from NSObject) |
| EncodeTo(NSCoder) |
Encodes the state of the object on the provided encoder (Inherited from UICollectionViewLayout) |
| Equals(NSObject) | (Inherited from NSObject) |
| Equals(Object) | (Inherited from NSObject) |
| ExposedBindings() | (Inherited from NSObject) |
| FinalizeAnimatedBoundsChange() |
When overridden, performs custom cleanup after animated changes to the bounds or after items have been inserted or deleted. (Inherited from UICollectionViewLayout) |
| FinalizeCollectionViewUpdates() |
When overridden, allows additional animations or clean up during an update. (Inherited from UICollectionViewLayout) |
| FinalizeLayoutTransition() |
Called prior to transition animations, informs the layout object to perform any steps necessary before the animations. (Inherited from UICollectionViewLayout) |
| FinalLayoutAttributesForDisappearingDecorationElement(NSString, NSIndexPath) |
The final layout information for a decoration element that is about to be removed from this UICollectionViewLayout. (Inherited from UICollectionViewLayout) |
| FinalLayoutAttributesForDisappearingItem(NSIndexPath) |
The final layout information for an item that is about to be removed from the UICollectionView. (Inherited from UICollectionViewLayout) |
| FinalLayoutAttributesForDisappearingSupplementaryElement(NSString, NSIndexPath) |
The final layout information for a supplementary view that is about to be removed from the collection view. (Inherited from UICollectionViewLayout) |
| GetBindingInfo(NSString) | (Inherited from NSObject) |
| GetBindingOptionDescriptions(NSString) | (Inherited from NSObject) |
| GetBindingValueClass(NSString) | (Inherited from NSObject) |
| GetDictionaryOfValuesFromKeys(NSString[]) |
Retrieves the values of the specified keys. (Inherited from NSObject) |
| GetHashCode() |
Generates a hash code for the current instance. (Inherited from NSObject) |
| GetIndexPathsToDeleteForDecorationViewOfKind(NSString) |
An array of NSIndexPaths indicating the decoration views to remove. (Inherited from UICollectionViewLayout) |
| GetIndexPathsToDeleteForSupplementaryView(NSString) |
An array of NSIndexPaths indicating the supplementary views to remove. (Inherited from UICollectionViewLayout) |
| GetIndexPathsToInsertForDecorationView(NSString) |
An array of NSIndexPaths indicating the decoration views to add. (Inherited from UICollectionViewLayout) |
| GetIndexPathsToInsertForSupplementaryView(NSString) |
An array of index paths indicating the supplementary views to add. (Inherited from UICollectionViewLayout) |
| GetInvalidationContext(UICollectionViewLayoutAttributes, UICollectionViewLayoutAttributes) |
Gets the invalidated areas for a change from |
| GetInvalidationContextForBoundsChange(CGRect) |
Returns a UICollectionViewLayoutInvalidationContext that specifies the portions of the layout that change in response to a change in bounds. (Inherited from UICollectionViewLayout) |
| GetInvalidationContextForEndingInteractiveMovementOfItems(NSIndexPath[], NSIndexPath[], Boolean) |
Returns a validation context for the moved items. (Inherited from UICollectionViewLayout) |
| GetInvalidationContextForInteractivelyMovingItems(NSIndexPath[], CGPoint, NSIndexPath[], CGPoint) |
Gets a UICollectionViewLayoutInvalidationContext that identifies the items being moved. (Inherited from UICollectionViewLayout) |
| GetLayoutAttributesForInteractivelyMovingItem(NSIndexPath, CGPoint) |
Returns the layout attributes for items that the user is moving. (Inherited from UICollectionViewLayout) |
| GetMethodForSelector(Selector) | (Inherited from NSObject) |
| GetNativeField(String) |
Obsolete.
(Inherited from NSObject)
|
| GetNativeHash() | (Inherited from NSObject) |
| GetTargetIndexPathForInteractivelyMovingItem(NSIndexPath, CGPoint) |
Returns the target index path for items that the user is moving. (Inherited from UICollectionViewLayout) |
| Init() | (Inherited from NSObject) |
| InitializeHandle(IntPtr, String) | (Inherited from NSObject) |
| InitializeHandle(IntPtr) | (Inherited from NSObject) |
| InitialLayoutAttributesForAppearingDecorationElement(NSString, NSIndexPath) |
Information on the starting layout of a decoration view that is being inserted into the UICollectionView. (Inherited from UICollectionViewLayout) |
| InitialLayoutAttributesForAppearingItem(NSIndexPath) |
Information on the starting layout of an item that is being inserted into the UICollectionView. (Inherited from UICollectionViewLayout) |
| InitialLayoutAttributesForAppearingSupplementaryElement(NSString, NSIndexPath) |
Information on the starting layout of a supplementary view that is being inserted into the UICollectionView. (Inherited from UICollectionViewLayout) |
| InvalidateLayout() |
Invalidates the current layout and initiates an update. (Inherited from UICollectionViewLayout) |
| InvalidateLayout(UICollectionViewLayoutInvalidationContext) |
Forces recomputation and application of the collection view. (Inherited from UICollectionViewLayout) |
| Invoke(Action, Double) | (Inherited from NSObject) |
| Invoke(Action, TimeSpan) | (Inherited from NSObject) |
| InvokeOnMainThread(Action) | (Inherited from NSObject) |
| InvokeOnMainThread(Selector, NSObject) |
Invokes synchrously the specified code on the main UI thread. (Inherited from NSObject) |
| IsEqual(NSObject) | (Inherited from NSObject) |
| IsKindOfClass(Class) | (Inherited from NSObject) |
| IsMemberOfClass(Class) | (Inherited from NSObject) |
| LayoutAttributesForDecorationView(NSString, NSIndexPath) |
The UICollectionViewLayoutAttributes for the specified decoration view. (Inherited from UICollectionViewLayout) |
| LayoutAttributesForElementsInRect(CGRect) |
The UICollectionViewLayoutAttributes for all the cells and views in the specified RectangleF. (Inherited from UICollectionViewLayout) |
| LayoutAttributesForItem(NSIndexPath) |
The UICollectionViewLayoutAttributes for the specified NSIndexPath. (Inherited from UICollectionViewLayout) |
| LayoutAttributesForSupplementaryView(NSString, NSIndexPath) |
The UICollectionViewLayoutAttributes for the specified supplementary view. (Inherited from UICollectionViewLayout) |
| LayoutAttributesForSupplementaryView(UICollectionElementKindSection, NSIndexPath) |
The attributes for the supplementary view at the specified indexPath. (Inherited from UICollectionViewLayout) |
| MarkDirty() |
Promotes a regular peer object (IsDirectBinding is true) into a toggleref object. (Inherited from NSObject) |
| MutableCopy() |
Creates a mutable copy of the specified NSObject. (Inherited from NSObject) |
| ObjectDidEndEditing(NSObject) | (Inherited from NSObject) |
| ObserveValue(NSString, NSObject, NSDictionary, IntPtr) |
Indicates that the value at the specified keyPath relative to this object has changed. (Inherited from NSObject) |
| PerformSelector(Selector, NSObject, Double, NSString[]) | (Inherited from NSObject) |
| PerformSelector(Selector, NSObject, Double) |
Invokes the selector on the current instance and if the |
| PerformSelector(Selector, NSObject, NSObject) | (Inherited from NSObject) |
| PerformSelector(Selector, NSObject) | (Inherited from NSObject) |
| PerformSelector(Selector, NSThread, NSObject, Boolean, NSString[]) | (Inherited from NSObject) |
| PerformSelector(Selector, NSThread, NSObject, Boolean) | (Inherited from NSObject) |
| PerformSelector(Selector) | (Inherited from NSObject) |
| PrepareForAnimatedBoundsChange(CGRect) |
Called prior to animated changes to the bounds or before insertion or deletion of items. (Inherited from UICollectionViewLayout) |
| PrepareForCollectionViewUpdates(UICollectionViewUpdateItem[]) |
Notifies the layout object that the contents of the UICollectionView are about to change. (Inherited from UICollectionViewLayout) |
| PrepareForInterfaceBuilder() | (Inherited from NSObject) |
| PrepareForTransitionFromLayout(UICollectionViewLayout) |
Notifies the layout object that it will shortly be installed as the layout for the UICollectionView. (Inherited from UICollectionViewLayout) |
| PrepareForTransitionToLayout(UICollectionViewLayout) |
Tells the layout object that it will shortly be removed as the layout for the UICollectionView. (Inherited from UICollectionViewLayout) |
| PrepareLayout() |
Tells the layout object to update the layout. (Inherited from UICollectionViewLayout) |
| RegisterClassForDecorationView(Type, NSString) |
Registers the class identified by kind as a decoration view. (Inherited from UICollectionViewLayout) |
| RegisterNibForDecorationView(UINib, NSString) |
Registers the UINib for use as a template for decoration views. (Inherited from UICollectionViewLayout) |
| RemoveObserver(NSObject, NSString, IntPtr) |
Stops the specified observer from receiving further notifications of changed values for the specified keyPath and context. (Inherited from NSObject) |
| RemoveObserver(NSObject, NSString) |
Stops the specified observer from receiving further notifications of changed values for the specified keyPath. (Inherited from NSObject) |
| RemoveObserver(NSObject, String, IntPtr) |
Stops the specified observer from receiving further notifications of changed values for the specified keyPath and context. (Inherited from NSObject) |
| RemoveObserver(NSObject, String) |
Stops the specified observer from receiving further notifications of changed values for the specified keyPath. (Inherited from NSObject) |
| RespondsToSelector(Selector) |
Whether this object recognizes the specified selector. (Inherited from NSObject) |
| SetNativeField(String, NSObject) |
Obsolete.
(Inherited from NSObject)
|
| SetNilValueForKey(NSString) |
Sets the value of the specified key to null. (Inherited from NSObject) |
| SetValueForKey(NSObject, NSString) |
Sets the value of the property specified by the key to the specified value. (Inherited from NSObject) |
| SetValueForKeyPath(IntPtr, NSString) |
A constructor used when creating managed representations of unmanaged objects; Called by the runtime. (Inherited from NSObject) |
| SetValueForKeyPath(NSObject, NSString) |
Sets the value of a property that can be reached using a keypath. (Inherited from NSObject) |
| SetValueForUndefinedKey(NSObject, NSString) |
Indicates an attempt to write a value to an undefined key. If not overridden, raises an NSUndefinedKeyException. (Inherited from NSObject) |
| SetValuesForKeysWithDictionary(NSDictionary) |
Sets the values of this NSObject to those in the specified dictionary. (Inherited from NSObject) |
| ShouldInvalidateLayout(UICollectionViewLayoutAttributes, UICollectionViewLayoutAttributes) |
Returns true if the collection view needs to invalidate for a change from |
| ShouldInvalidateLayoutForBoundsChange(CGRect) |
Whether the new bounds requires a layout update. (Inherited from UICollectionViewLayout) |
| TargetContentOffset(CGPoint, CGPoint) |
The PointF at which to stop scrolling. (Inherited from UICollectionViewLayout) |
| TargetContentOffsetForProposedContentOffset(CGPoint) |
The content offset to use after an animated layout change. (Inherited from UICollectionViewLayout) |
| ToString() |
Returns a string representation of the value of the current instance. (Inherited from NSObject) |
| Unbind(NSString) | (Inherited from NSObject) |
| Unbind(String) |
Obsolete.
(Inherited from NSObject)
|
| ValueForKey(NSString) |
Returns the value of the property associated with the specified key. (Inherited from NSObject) |
| ValueForKeyPath(NSString) |
Returns the value of a property that can be reached using a keypath. (Inherited from NSObject) |
| ValueForUndefinedKey(NSString) |
Indicates an attempt to read a value of an undefined key. If not overridden, raises an NSUndefinedKeyException. (Inherited from NSObject) |
| WillChange(NSKeyValueChange, NSIndexSet, NSString) |
Indicates that the values of the specified indices in the specified key are about to change. (Inherited from NSObject) |
| WillChange(NSString, NSKeyValueSetMutationKind, NSSet) | (Inherited from NSObject) |
| WillChangeValue(String) |
Indicates that the value of the specified key is about to change. (Inherited from NSObject) |
Extension Methods
| GetDebugDescription(INSObjectProtocol) | |
| GetAccessibilityCustomRotors(NSObject) |
Gets the array of UIAccessibilityCustomRotor objects appropriate for |
| SetAccessibilityCustomRotors(NSObject, UIAccessibilityCustomRotor[]) |
Sets the array of UIAccessibilityCustomRotor objects appropriate for |