Placement

A transition is always applied when placing a region. The system wide default transition when none is specified is to fade in on Place()/PlaceModal() and fade out on Displace(). A default place and displace transition can be specified in the layout which overrides the system wide default. The transition can be specified in the Place()/PlaceModal() and Displace() calls which overrides the system wide default and the value from the layout.

These additional Place() and Displace() APIs support specifying a transition:

context.GetRegion(region).Place(myPoint, referenceRegions, referencePoint, transition, transitionTime)

context.GetRegion(region).Place(myPoint, referenceRegions, referencePoint, xOffset, yOffset, zIndex, transition, transitionTime)

context.GetRegion(region).Displace(transition, transitionTime)

Parameters

  • Transition: (optional) The name of the animation to use while placing or displacing the region. The default value when this is not specified is FadeIn. If the Region is being placed and is not currently visible, these transition specifiers are recognized:
    • CutIn: Ignores transitionTime and makes region visible immediately.
    • FadeIn
    • SlideInFromLeft
    • SlideInFromRight
    • SlideInFromTop
    • SlideInFromBottom
    • FloatInFromLeft - A mix of FadeIn and SlideInFromLeft.
    • FloatInFromRight
    • FloatInFromTop
    • FloatInFromBottom
    • PullOutFromLeft: As a drawer pulling out from the left edge (the content moves).
    • PullOutFromRight
    • PullOutFromTop
    • PullOutFromBottom
    • RevealFromLeft: The content is revealed as the transition completes from left to right (the content does not move).
    • RevealFromRight
    • RevealFromTop
    • RevealFromBottom
    • GrowIn: The content appears at reduced scale and grows in place to 100% scale.
  • If the region is already placed and is being moved, these transition specifiers are recognized:
    • Slide
  • If the region is being displaced, these transition specifiers are recognized (default value is FadeOut):
    • CutOut: Ignores transitionTime and hides regions immediately.
    • FadeOut
    • SlideOutToLeft
    • SlideOutToRight
    • SlideOutToTop
    • SlideOutToBottom
    • FloatOutToLeft: A mix of FadeOut and SlideOut.
    • FloatOutToRight
    • FloatOutToTop
    • FloatOutToBottom
    • RetractToLeft: As a drawer pushed back in to the left edge (the content moves).
    • RetractToRight
    • RetractToTop
    • RetractToBottom
    • ConcealToLeft: The content is hidden as the transition completes from right to left (the content does not move).
    • ConcealToRight
    • ConcealToTop
    • ConcealToBottom
    • ShrinkOut: The content reduces in scale until it is gone.
  • TransitionDuration: (optional) The duration, in milliseconds, that the animation will take to complete. Default value is 500 (i.e. 0.5 second).