UICollectionViewLayoutAttributes Class

Reference

Definition

Namespace:: UIKit

Assembly:: Xamarin.iOS.dll

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.

Provides layout attributes for UICollectionViewLayouts.

[Foundation.Register("UICollectionViewLayoutAttributes", true)]
[ObjCRuntime.Introduced(ObjCRuntime.PlatformName.iOS, 6, 0, ObjCRuntime.PlatformArchitecture.All, null)]
public class UICollectionViewLayoutAttributes : Foundation.NSObject, Foundation.INSCopying, IDisposable, UIKit.IUIDynamicItem

type UICollectionViewLayoutAttributes = class
    inherit NSObject
    interface INSCopying
    interface INativeObject
    interface IDisposable
    interface IUIDynamicItem

Inheritance: Object

NSObject
UICollectionViewLayoutAttributes

Attributes: RegisterAttribute IntroducedAttribute

Implements: INSCopying INativeObject IDisposable IUIDynamicItem

Remarks

Application developers who override this class in order to provide additional layout parameters should also override ApplyLayoutAttributes(UICollectionViewLayoutAttributes) to apply them.

In order to get a layout attributes object for a subclass of this class, you must call CreateForCell(NSIndexPath) and specify the type of the subclass, like this:

// A custom UICollectionViewLayoutAttributes class with one extra property
public class CustomCollectionViewLayoutAttributes : UICollectionViewLayoutAttributes {
  public int SomeProperty { get; set; }
  public override NSObject Copy ()
  {
    // It is required to override Copy, iOS will call this method to clone your object.
    var copy = (CustomCollectionViewLayoutAttributes) base.Copy ();
    copy.SomeProperty = SomeProperty;
    return copy;
  }
}
public class CircleLayout : UICollectionViewLayout {
  public override UICollectionViewLayoutAttributes LayoutAttributesForItem (NSIndexPath path)
  {
    var attributes = UICollectionViewLayoutAttributes.CreateForCell&lt;CustomCollectionViewLayoutAttributes&gt; (path);
    attributes.SomeProperty = 1;
    return attributes;
  }
 }

UICollectionViewLayoutAttributes implements IUIDynamicItem and thus can be used with UI Dynamics.

Constructors

UICollectionViewLayoutAttributes()	Default constructor, initializes a new instance of this class.
UICollectionViewLayoutAttributes(IntPtr)	A constructor used when creating managed representations of unmanaged objects; Called by the runtime.
UICollectionViewLayoutAttributes(NSObjectFlag)	Constructor to call on derived classes to skip initialization and merely allocate the object.

Properties

Alpha	The transparency to be applied.
Bounds	The RectangleF describing the bounds of the item.
Center	The center of the item.
Class	(Inherited from NSObject)
ClassHandle	The handle for this class.
CollisionBoundingPath	Gets the UIBezierPath to be used for collision detection.
CollisionBoundsType	Gets the UIDynamicItemCollisionBoundsType describing the type of bounds used for collision detected.
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)
Frame	The RectangleF frame for the UICollectionView
Handle	Handle (pointer) to the unmanaged object representation. (Inherited from NSObject)
Hidden	Whether the UICollectionView is hidden or not.
IndexPath	The index path of the item in the UICollectionView.
IsDirectBinding	(Inherited from NSObject)
IsProxy	(Inherited from NSObject)
RepresentedElementCategory	Used to identify the specific purpose of a supplementary or decoration view. Read-only.
RepresentedElementKind	Used to identify the specific purpose of a supplementary or decoration view. Read-only.
RetainCount	Returns the current Objective-C retain count for the object. (Inherited from NSObject)
Self	(Inherited from NSObject)
Size	The SizeF of the item.
Superclass	(Inherited from NSObject)
SuperHandle	Handle used to represent the methods in the base class for this NSObject. (Inherited from NSObject)
Transform	The affine transform of the item.
Transform3D	The 3D transform of the item. (If not null, Frame will be set to null.)
ZIndex	The Z-Index of the item. (Higher values appear in front of lower values.)
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)
Copy(NSZone)	Performs a copy of the underlying Objective-C object.
CreateForCell(NSIndexPath)	Creates a UICollectionViewLayoutAttributes for the cell at the specified index.\|Creates a UICollectionViewLayon
CreateForCell<T>(NSIndexPath)	Creates a layout attributes object of the specified type for the cell at the specified index path.
CreateForDecorationView(NSString, NSIndexPath)	Creates a layout attributes object representing the decoration view.
CreateForDecorationView<T>(NSString, NSIndexPath)	Creates a layout attributes object of a specific type representing the decoration view.
CreateForSupplementaryView(NSString, NSIndexPath)	Creates a layout attributes object representing the supplementary view.
CreateForSupplementaryView(UICollectionElementKindSection, NSIndexPath)	Creates a layout attributes object representing the supplementary view.
CreateForSupplementaryView<T>(NSString, NSIndexPath)	Creates a layout attributes object of a specific type representing the supplementary view.
CreateForSupplementaryView<T>(UICollectionElementKindSection, NSIndexPath)	Creates a layout attributes object representing the supplementary view.
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)
Equals(NSObject)	(Inherited from NSObject)
Equals(Object)	(Inherited from NSObject)
ExposedBindings()	(Inherited from NSObject)
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)
GetMethodForSelector(Selector)	(Inherited from NSObject)
GetNativeField(String)	Obsolete. (Inherited from NSObject)
GetNativeHash()	(Inherited from NSObject)
Init()	(Inherited from NSObject)
InitializeHandle(IntPtr, String)	(Inherited from NSObject)
InitializeHandle(IntPtr)	(Inherited from NSObject)
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)
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 `obj` is not null, it passes this as its single parameter. (Inherited from NSObject)
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)
PrepareForInterfaceBuilder()	(Inherited from NSObject)
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)
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 `this` object.
SetAccessibilityCustomRotors(NSObject, UIAccessibilityCustomRotor[])	Sets the array of UIAccessibilityCustomRotor objects appropriate for `this` object.
GetCollisionBoundingPath(IUIDynamicItem)	Returns the closed path that is used for collision detection.
GetCollisionBoundsType(IUIDynamicItem)	Returns a value that tells how collision bounds are specified.

Applies to

Compartir a través de