UINavigationController.PopToRootViewController(Boolean) UINavigationController.PopToRootViewController(Boolean) Method

Definition

Pops all UIViewController objects except the root controller.

[Foundation.Export("popToRootViewControllerAnimated:")]
public virtual UIKit.UIViewController[] PopToRootViewController (bool animated);
abstract member PopToRootViewController : bool -> UIKit.UIViewController[]
override this.PopToRootViewController : bool -> UIKit.UIViewController[]

Parameters

animated
Boolean Boolean

A boolean indicating if the transition back to the root controller should be animated.

Returns

An array of view controller that were popped from the stack in the process of returning to the root controller.

Remarks

After this call, the root controller will be at the top of the UINavigationController's stack, and the root controller's view will be displayed by the navigation controller.

Applies to