UICollectionView.DequeueReusableSupplementaryView Method

Definition

Namespace:: UIKit

Assembly:: Microsoft.iOS.dll

Assembly:: Microsoft.MacCatalyst.dll

Assembly:: Microsoft.tvOS.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.

Overloads

Name	Description
DequeueReusableSupplementaryView(NSString, NSString, NSIndexPath)
DequeueReusableSupplementaryView(NSString, String, NSIndexPath)	Returns a UICollectionReusableView for a supplementary view.
DequeueReusableSupplementaryView(UICollectionElementKindSection, NSString, NSIndexPath)	Returns a newly-allocated or reused supplementary UICollectionReusableView.
DequeueReusableSupplementaryView(UICollectionElementKindSection, String, NSIndexPath)	Returns a UICollectionReusableView for a supplementary view.

DequeueReusableSupplementaryView(NSString, NSString, NSIndexPath)

[Foundation.Export("dequeueReusableSupplementaryViewOfKind:withReuseIdentifier:forIndexPath:")]
[ObjCRuntime.BindingImpl(ObjCRuntime.BindingImplOptions.GeneratedCode | ObjCRuntime.BindingImplOptions.Optimizable)]
public virtual UIKit.UICollectionReusableView DequeueReusableSupplementaryView(Foundation.NSString kind, Foundation.NSString identifier, Foundation.NSIndexPath indexPath);

[<Foundation.Export("dequeueReusableSupplementaryViewOfKind:withReuseIdentifier:forIndexPath:")>]
[<ObjCRuntime.BindingImpl(ObjCRuntime.BindingImplOptions.GeneratedCode | ObjCRuntime.BindingImplOptions.Optimizable)>]
abstract member DequeueReusableSupplementaryView : Foundation.NSString * Foundation.NSString * Foundation.NSIndexPath -> UIKit.UICollectionReusableView
override this.DequeueReusableSupplementaryView : Foundation.NSString * Foundation.NSString * Foundation.NSIndexPath -> UIKit.UICollectionReusableView

Parameters

kind: NSString

identifier: NSString

indexPath: NSIndexPath

Returns

UICollectionReusableView

Attributes: ExportAttribute BindingImplAttribute

Applies to

DequeueReusableSupplementaryView(NSString, String, NSIndexPath)

Returns a UICollectionReusableView for a supplementary view.

public UIKit.UICollectionReusableView DequeueReusableSupplementaryView(Foundation.NSString kind, string reuseIdentifier, Foundation.NSIndexPath indexPath);

member this.DequeueReusableSupplementaryView : Foundation.NSString * string * Foundation.NSIndexPath -> UIKit.UICollectionReusableView

Parameters

kind: NSString

An NSString specifying the kind of supplementary view to dequeue.

reuseIdentifier: String

The reuse identifier for the supplementary view type to dequeue.

indexPath: NSIndexPath

The index path specifying the location of the supplementary view.

Returns

UICollectionReusableView

A UICollectionReusableView that is either newly allocated or recycled from the reuse queue.

Applies to

DequeueReusableSupplementaryView(UICollectionElementKindSection, NSString, NSIndexPath)

Returns a newly-allocated or reused supplementary UICollectionReusableView.

public Foundation.NSObject DequeueReusableSupplementaryView(UIKit.UICollectionElementKindSection section, Foundation.NSString reuseIdentifier, Foundation.NSIndexPath indexPath);

member this.DequeueReusableSupplementaryView : UIKit.UICollectionElementKindSection * Foundation.NSString * Foundation.NSIndexPath -> Foundation.NSObject

Parameters

section: UICollectionElementKindSection

A UICollectionElementKindSection specifying what kind of supplementary view is desired.

reuseIdentifier: NSString

The reuse identifier for the supplementary view type to dequeue.

indexPath: NSIndexPath

The NSIndexPath specifying the location of the supplementary view.

Returns

NSObject

A supplementary UICollectionReusableView that is either newly allocated or recycled from the reuse queue.

Remarks

The application developer must have registered a class or nib file using either RegisterClassForSupplementaryView(Type, UICollectionElementKindSection, String) or RegisterNibForSupplementaryView(UINib, UICollectionElementKindSection, String) prior to calling this method.

If the UICollectionReusableView is not newly allocated but is being recycled, this method will call that cell's PrepareForReuse() method.

Applies to

DequeueReusableSupplementaryView(UICollectionElementKindSection, String, NSIndexPath)

Returns a UICollectionReusableView for a supplementary view.

public UIKit.UICollectionReusableView DequeueReusableSupplementaryView(UIKit.UICollectionElementKindSection kind, string reuseIdentifier, Foundation.NSIndexPath indexPath);

member this.DequeueReusableSupplementaryView : UIKit.UICollectionElementKindSection * string * Foundation.NSIndexPath -> UIKit.UICollectionReusableView

Parameters

kind: UICollectionElementKindSection

A UICollectionElementKindSection specifying the kind of supplementary view to dequeue.

reuseIdentifier: String

The reuse identifier for the supplementary view type to dequeue.

indexPath: NSIndexPath

The index path specifying the location of the supplementary view.

Returns

UICollectionReusableView

A UICollectionReusableView that is either newly allocated or recycled from the reuse queue.

Applies to