UIPresentationController UIPresentationController Class

Definition

Namespace:
UIKit UIKit
Assembly:
Xamarin.iOS.dll

Manages the user experience for advanced transitions and presentation of UIViewControllers whose ModalPresentationStyle is Custom.

[Foundation.Register("UIPresentationController", true)]
[ObjCRuntime.Introduced(ObjCRuntime.PlatformName.iOS, 8, 0, ObjCRuntime.PlatformArchitecture.All, null)]
public class UIPresentationController : Foundation.NSObject, IDisposable, UIKit.IUIAppearanceContainer, UIKit.IUIContentContainer, UIKit.IUIFocusEnvironment, UIKit.IUITraitEnvironment
type UIPresentationController = class
    inherit NSObject
    interface IUIAppearanceContainer
    interface INativeObject
    interface IDisposable
    interface IUIContentContainer
    interface IUIFocusEnvironment
    interface IUITraitEnvironment
Inheritance
ObjectObject
NSObjectNSObject
UIPresentationControllerUIPresentationController
Derived
Attributes
RegisterAttribute IntroducedAttribute
Implements
INativeObjectINativeObject IDisposableIDisposable IUIAppearanceContainerIUIAppearanceContainer IUIContentContainerIUIContentContainer IUIFocusEnvironmentIUIFocusEnvironment IUITraitEnvironmentIUITraitEnvironment

Constructors

UIPresentationController() UIPresentationController()

Default constructor, initializes a new instance of this class.
UIPresentationController(IntPtr) UIPresentationController(IntPtr)

A constructor used when creating managed representations of unmanaged objects; Called by the runtime.
UIPresentationController(NSObjectFlag) UIPresentationController(NSObjectFlag)

Constructor to call on derived classes to skip initialization and merely allocate the object.
UIPresentationController(UIViewController, UIViewController) UIPresentationController(UIViewController, UIViewController)

Properties

Class Class Inherited from NSObject
ClassHandle ClassHandle

The handle for this class.
ContainerView ContainerView

Gets the UIView in which a presentation occurs.
DebugDescription DebugDescription

A developer-meaningful description of this object.

(Inherited from NSObject)
Delegate Delegate

An instance of the UIKit.IUIAdaptivePresentationControllerDelegate model class which acts as the class delegate.
Description Description

Description of the object, the Objective-C version of ToString.

(Inherited from NSObject)
FocusItemContainer FocusItemContainer

Gets the focus container that provides spatial information to child focus items.
FrameOfPresentedViewInContainerView FrameOfPresentedViewInContainerView

Gets the frame rectangle that the controller assigns to the presented view at the end of animations.
Handle Handle

Handle (pointer) to the unmanaged object representation.

(Inherited from NSObject)
IsDirectBinding IsDirectBinding Inherited from NSObject
IsProxy IsProxy Inherited from NSObject
OverrideTraitCollection OverrideTraitCollection

Gets and sets additional traits for managed view controllers.
ParentFocusEnvironment ParentFocusEnvironment

Gets the parent focus environment.
PreferredContentSize PreferredContentSize

Gets the preferred size for the content of the container.
PreferredFocusedView PreferredFocusedView

Developers should not use this deprecated property. Developers should use 'PreferredFocusEnvironments' instead.
PreferredFocusEnvironments PreferredFocusEnvironments

An array of IUIFocusEnvironments that are recursively searched by the system to find the default focused view.
PresentationStyle PresentationStyle

Gets the preferred presentation style for this controller.
PresentedView PresentedView

Gets the view to present.
PresentedViewController PresentedViewController

Gets the view controller being presented.
PresentingViewController PresentingViewController

Gets the view controller that is the presentation starting point.
RetainCount RetainCount

Returns the current Objective-C retain count for the object.

(Inherited from NSObject)
Self Self Inherited from NSObject
ShouldPresentInFullscreen ShouldPresentInFullscreen

Gets whether the presentation covers the whole screen.
ShouldRemovePresentersView ShouldRemovePresentersView

Gets whether to remove the presenting view controller view when the presentation animations finish.
Superclass Superclass Inherited from NSObject
SuperHandle SuperHandle

Handle used to represent the methods in the base class for this NSObject.

(Inherited from NSObject)
TraitCollection TraitCollection

Gets the collection of traits for this presentation controller.
WeakDelegate WeakDelegate

An object that can respond to the delegate protocol for this type
Zone Zone Inherited from NSObject

Methods

AdaptivePresentationStyle() AdaptivePresentationStyle()

Gets the presentation style to use when the app changes in size.
AdaptivePresentationStyle(UITraitCollection) AdaptivePresentationStyle(UITraitCollection)

Gets the UIModalPresentationStyle associated with the .
AddObserver(NSObject, NSString, NSKeyValueObservingOptions, IntPtr) 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) 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>) AddObserver(NSString, NSKeyValueObservingOptions, Action<NSObservedChange>)

Registers an object for being observed externally using an arbitrary method.

(Inherited from NSObject)
AddObserver(String, NSKeyValueObservingOptions, Action<NSObservedChange>) AddObserver(String, NSKeyValueObservingOptions, Action<NSObservedChange>)

Registers an object for being observed externally using an arbitrary method.

(Inherited from NSObject)
AwakeFromNib() AwakeFromNib()

Called after the object has been loaded from the nib file. Overriders must call base.AwakeFromNib().

(Inherited from NSObject)
BeginInvokeOnMainThread(Action) BeginInvokeOnMainThread(Action) Inherited from NSObject
BeginInvokeOnMainThread(Selector, NSObject) BeginInvokeOnMainThread(Selector, NSObject)

Invokes asynchrously the specified code on the main UI thread.

(Inherited from NSObject)
ConformsToProtocol(IntPtr) ConformsToProtocol(IntPtr)

Invoked to determine if this object implements the specified protocol.

(Inherited from NSObject)
ContainerViewDidLayoutSubviews() ContainerViewDidLayoutSubviews()

Notifies this presentation controller that layout has ended on the views in the container view.
ContainerViewWillLayoutSubviews() ContainerViewWillLayoutSubviews()

Notifies this presentation controller that layout will begin on the views in the container view.
Copy() Copy()

Performs a copy of the underlying Objective-C object.

(Inherited from NSObject)
DangerousAutorelease() DangerousAutorelease() Inherited from NSObject
DangerousRelease() DangerousRelease() Inherited from NSObject
DangerousRetain() DangerousRetain() Inherited from NSObject
DidChange(NSKeyValueChange, NSIndexSet, NSString) DidChange(NSKeyValueChange, NSIndexSet, NSString)

Indicates a change occurred to the indexes for a to-many relationship.

(Inherited from NSObject)
DidChange(NSString, NSKeyValueSetMutationKind, NSSet) DidChange(NSString, NSKeyValueSetMutationKind, NSSet) Inherited from NSObject
DidChangeValue(String) DidChangeValue(String)

Indicates that a change occurred on the specified key.

(Inherited from NSObject)
DidUpdateFocus(UIFocusUpdateContext, UIFocusAnimationCoordinator) DidUpdateFocus(UIFocusUpdateContext, UIFocusAnimationCoordinator)

Indicates that the focus changed as detailed in the context.
DismissalTransitionDidEnd(Boolean) DismissalTransitionDidEnd(Boolean)

Notifies this presentation controller that dismissal animations are finished.
DismissalTransitionWillBegin() DismissalTransitionWillBegin()

Notifies this presentation controller that dismissal animations will begin.
Dispose() Dispose()

Releases the resources used by the NSObject object.

(Inherited from NSObject)
Dispose(Boolean) Dispose(Boolean)

Releases the resources used by the UIPresentationController object.
DoesNotRecognizeSelector(Selector) DoesNotRecognizeSelector(Selector)

Indicates that this object does not recognize the specified selector.

(Inherited from NSObject)
Equals(NSObject) Equals(NSObject) Inherited from NSObject
Equals(Object) Equals(Object) Inherited from NSObject
GetDictionaryOfValuesFromKeys(NSString[]) GetDictionaryOfValuesFromKeys(NSString[])

Retrieves the values of the specified keys.

(Inherited from NSObject)
GetHashCode() GetHashCode()

Generates a hash code for the current instance.

(Inherited from NSObject)
GetMethodForSelector(Selector) GetMethodForSelector(Selector) Inherited from NSObject
GetNativeField(String) GetNativeField(String) Inherited from NSObject
GetNativeHash() GetNativeHash() Inherited from NSObject
GetSizeForChildContentContainer(IUIContentContainer, CGSize) GetSizeForChildContentContainer(IUIContentContainer, CGSize)

Gets the size of the content of the specified child IUIContentContainer by using the size of the parent container.
Init() Init() Inherited from NSObject
InitializeHandle(IntPtr) InitializeHandle(IntPtr) Inherited from NSObject
InitializeHandle(IntPtr, String) InitializeHandle(IntPtr, String) Inherited from NSObject
Invoke(Action, Double) Invoke(Action, Double) Inherited from NSObject
Invoke(Action, TimeSpan) Invoke(Action, TimeSpan) Inherited from NSObject
InvokeOnMainThread(Action) InvokeOnMainThread(Action) Inherited from NSObject
InvokeOnMainThread(Selector, NSObject) InvokeOnMainThread(Selector, NSObject)

Invokes synchrously the specified code on the main UI thread.

(Inherited from NSObject)
IsEqual(NSObject) IsEqual(NSObject) Inherited from NSObject
IsKindOfClass(Class) IsKindOfClass(Class) Inherited from NSObject
IsMemberOfClass(Class) IsMemberOfClass(Class) Inherited from NSObject
MarkDirty() MarkDirty()

Promotes a regular peer object (IsDirectBinding is true) into a toggleref object.

(Inherited from NSObject)
MutableCopy() MutableCopy()

Creates a mutable copy of the specified NSObject.

(Inherited from NSObject)
ObserveValue(NSString, NSObject, NSDictionary, IntPtr) ObserveValue(NSString, NSObject, NSDictionary, IntPtr)

Indicates that the value at the specified keyPath relative to this object has changed.

(Inherited from NSObject)
PerformSelector(Selector) PerformSelector(Selector) Inherited from NSObject
PerformSelector(Selector, NSObject) PerformSelector(Selector, NSObject) Inherited from NSObject
PerformSelector(Selector, NSObject, Double) 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, Double, NSString[]) PerformSelector(Selector, NSObject, Double, NSString[]) Inherited from NSObject
PerformSelector(Selector, NSObject, NSObject) PerformSelector(Selector, NSObject, NSObject) Inherited from NSObject
PerformSelector(Selector, NSThread, NSObject, Boolean) PerformSelector(Selector, NSThread, NSObject, Boolean) Inherited from NSObject
PerformSelector(Selector, NSThread, NSObject, Boolean, NSString[]) PerformSelector(Selector, NSThread, NSObject, Boolean, NSString[]) Inherited from NSObject
PreferredContentSizeDidChangeForChildContentContainer(IUIContentContainer) PreferredContentSizeDidChangeForChildContentContainer(IUIContentContainer)

Notifies this controller that the preferred size for content for a specified child container has changed.
PrepareForInterfaceBuilder() PrepareForInterfaceBuilder() Inherited from NSObject
PresentationTransitionDidEnd(Boolean) PresentationTransitionDidEnd(Boolean)

Notifies this presentation controller that presentation animations have finished.
PresentationTransitionWillBegin() PresentationTransitionWillBegin()

Notifies this presentation contoller that layout will begin on the views in the container.
RemoveObserver(NSObject, NSString) RemoveObserver(NSObject, NSString)

Stops the specified observer from receiving further notifications of changed values for the specified keyPath.

(Inherited from NSObject)
RemoveObserver(NSObject, NSString, IntPtr) 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, String) RemoveObserver(NSObject, String)

Stops the specified observer from receiving further notifications of changed values for the specified keyPath.

(Inherited from NSObject)
RemoveObserver(NSObject, String, IntPtr) RemoveObserver(NSObject, String, IntPtr)

Stops the specified observer from receiving further notifications of changed values for the specified keyPath and context.

(Inherited from NSObject)
RespondsToSelector(Selector) RespondsToSelector(Selector)

Whether this object recognizes the specified selector.

(Inherited from NSObject)
SetNativeField(String, NSObject) SetNativeField(String, NSObject) Inherited from NSObject
SetNeedsFocusUpdate() SetNeedsFocusUpdate()

When this is the active focus environment, requests a focus update, which can potentially change the PreferredFocusedView. (See also UpdateFocusIfNeeded().)
SetNilValueForKey(NSString) SetNilValueForKey(NSString)

Sets the value of the specified key to null.

(Inherited from NSObject)
SetValueForKey(NSObject, NSString) SetValueForKey(NSObject, NSString)

Sets the value of the property specified by the key to the specified value.

(Inherited from NSObject)
SetValueForKeyPath(IntPtr, NSString) SetValueForKeyPath(IntPtr, NSString)

A constructor used when creating managed representations of unmanaged objects; Called by the runtime.

(Inherited from NSObject)
SetValueForKeyPath(NSObject, NSString) SetValueForKeyPath(NSObject, NSString)

Sets the value of a property that can be reached using a keypath.

(Inherited from NSObject)
SetValueForUndefinedKey(NSObject, NSString) 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) SetValuesForKeysWithDictionary(NSDictionary)

Sets the values of this NSObject to those in the specified dictionary.

(Inherited from NSObject)
ShouldUpdateFocus(UIFocusUpdateContext) ShouldUpdateFocus(UIFocusUpdateContext)

Called prior to the ContainerView either losing or receiving focus. If either focus environment returns false, the focus update is canceled.
SystemLayoutFittingSizeDidChangeForChildContentContainer(IUIContentContainer) SystemLayoutFittingSizeDidChangeForChildContentContainer(IUIContentContainer)

Notifies this container that auto layout resized a specified child container.
ToString() ToString()

Returns a string representation of the value of the current instance.

(Inherited from NSObject)
TraitCollectionDidChange(UITraitCollection) TraitCollectionDidChange(UITraitCollection)

Performs custom behavior when the specified current trait collection changes.
UpdateFocusIfNeeded() UpdateFocusIfNeeded()

If any focus environment has a pending update, this method forces an immediate focus update. Unlike SetNeedsFocusUpdate(), this method may be called by any UIPresentationController, whether it currently contains focus or not.
ValueForKey(NSString) ValueForKey(NSString)

Returns the value of the property associated with the specified key.

(Inherited from NSObject)
ValueForKeyPath(NSString) ValueForKeyPath(NSString)

Returns the value of a property that can be reached using a keypath.

(Inherited from NSObject)
ValueForUndefinedKey(NSString) ValueForUndefinedKey(NSString)

Indicates an attempt to read a value of an undefined key. If not overridden, raises an NSUndefinedKeyException.

(Inherited from NSObject)
ViewWillTransitionToSize(CGSize, IUIViewControllerTransitionCoordinator) ViewWillTransitionToSize(CGSize, IUIViewControllerTransitionCoordinator)

Called shortly before the view will change size to .
WillChange(NSKeyValueChange, NSIndexSet, NSString) 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) WillChange(NSString, NSKeyValueSetMutationKind, NSSet) Inherited from NSObject
WillChangeValue(String) WillChangeValue(String)

Indicates that the value of the specified key is about to change.

(Inherited from NSObject)
WillTransitionToTraitCollection(UITraitCollection, IUIViewControllerTransitionCoordinator) WillTransitionToTraitCollection(UITraitCollection, IUIViewControllerTransitionCoordinator)

Notifies this that its trait collection will change to traitCollection, as coordinated by coordinator.

Extension Methods

GetDebugDescription(INSObjectProtocol) GetDebugDescription(INSObjectProtocol)
GetAccessibilityCustomRotors(NSObject) GetAccessibilityCustomRotors(NSObject)

Gets the array of UIAccessibilityCustomRotor objects appropriate for this object.
SetAccessibilityCustomRotors(NSObject, UIAccessibilityCustomRotor[]) SetAccessibilityCustomRotors(NSObject, UIAccessibilityCustomRotor[])

Sets the array of UIAccessibilityCustomRotor objects appropriate for this object.
GetFocusItemContainer(IUIFocusEnvironment) GetFocusItemContainer(IUIFocusEnvironment)

Gets the focus container for the environment.
GetParentFocusEnvironment(IUIFocusEnvironment) GetParentFocusEnvironment(IUIFocusEnvironment)

Gets the parent focus environment.
GetPreferredFocusEnvironments(IUIFocusEnvironment) GetPreferredFocusEnvironments(IUIFocusEnvironment)

Gets the list of focus environments, ordered by priority, that the environment prefers when updating the focus.

Applies to

See also