Show / Hide Table of Contents

Class ViewControllerTransitionContext<TViewController>

The view controller transition context provides detailed information about a view controller transition, such as the view controllers involved.

You will never use an instance of this class directly. Instead you will be given a concrete subclass, CanvasControllerTransitionContext or ElementsControllerTransitionContext, depending upon the workflow you are using.

Inheritance
System.Object
ViewControllerTransitionContext<TViewController>
CanvasControllerTransitionContext
ElementsControllerTransitionContext
Implements
ITransitionContext
IAppearable
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Pelican7.UIGraph
Assembly: UI Graph API Documentation Project.dll
Syntax
public abstract class ViewControllerTransitionContext<TViewController> : ITransitionContext, IAppearable where TViewController : ITransitionContextViewController
Type Parameters
Name Description
TViewController

Constructors

ViewControllerTransitionContext(ViewControllerTransitionIdentifier, TViewController, TViewController, TViewController, Boolean, Boolean, Stack<TViewController>)

Declaration
public ViewControllerTransitionContext(ViewControllerTransitionIdentifier identifier, TViewController toViewController, TViewController fromViewController, TViewController ownerViewController, bool animated, bool interactive, Stack<TViewController> intermediaryViewControllers = null)
Parameters
Type Name Description
ViewControllerTransitionIdentifier identifier
TViewController toViewController
TViewController fromViewController
TViewController ownerViewController
System.Boolean animated
System.Boolean interactive
System.Collections.Generic.Stack<TViewController> intermediaryViewControllers

Properties

Animated

Is the transition animated?

Declaration
public bool Animated { get; }
Property Value
Type Description
System.Boolean

FromViewController

The view controller being transition from. In a Present transition, this is the view controller whom initiated the presentation. In an Dismiss transition, this is the view controller being dismissed.

Declaration
public TViewController FromViewController { get; }
Property Value
Type Description
TViewController

Identifier

The transition's identifier.

Declaration
public ViewControllerTransitionIdentifier Identifier { get; }
Property Value
Type Description
ViewControllerTransitionIdentifier

Interactive

Is the transition interactive?

Declaration
public bool Interactive { get; }
Property Value
Type Description
System.Boolean

IntermediaryViewControllers

Any intermediary view controllers associated with the transition. For example, intermediary view controllers are present when dismissing back to a view controller lower in the stack than the current view controller's presenter.

Declaration
public Stack<TViewController> IntermediaryViewControllers { get; }
Property Value
Type Description
System.Collections.Generic.Stack<TViewController>

OwnerViewController

The view controller whom owns the transition. For containment transitions, the owner is the parent whom is performing the transition. In Present and Dismiss transitions, the owner is the view controller being presented or dismissed.

Declaration
public TViewController OwnerViewController { get; }
Property Value
Type Description
TViewController

ToViewController

The view controller being transitioned to. In a Present transition, this is the view controller being presented. In an Dismiss transition, this is the view controller whom is being dismissed to.

Declaration
public TViewController ToViewController { get; }
Property Value
Type Description
TViewController

Explicit Interface Implementations

IAppearable.BeginAppearanceTransition(Boolean)

Declaration
void IAppearable.BeginAppearanceTransition(bool isAppearing)
Parameters
Type Name Description
System.Boolean isAppearing

IAppearable.EndAppearanceTransition()

Declaration
void IAppearable.EndAppearanceTransition()

ITransitionContext.Animated

Declaration
bool ITransitionContext.Animated { get; }
Returns
Type Description
System.Boolean

ITransitionContext.HideRelevantViewControllerIfNecessary(Boolean)

Declaration
void ITransitionContext.HideRelevantViewControllerIfNecessary(bool completed)
Parameters
Type Name Description
System.Boolean completed

ITransitionContext.Interactive

Declaration
bool ITransitionContext.Interactive { get; }
Returns
Type Description
System.Boolean

ITransitionContext.ShowToViewController()

Declaration
void ITransitionContext.ShowToViewController()

Implements

ITransitionContext
IAppearable
Back to top © 2019 Pelican 7 LTD. All rights reserved.