BarWipeTransition Class
A wipe transition between two elements that uses a straight bar with a configurable gradient spread.
public class BarWipeTransition : StoryboardTransitionBase, ICloneable
- Inheritance:
- Object DispatcherObject DependencyObject Transition StoryboardTransitionBase Object
- Implements:
- ICloneable
Constructors
BarWipeTransition()
public BarWipeTransition()
Properties
BeginTime
Gets or sets the time at which this transition should begin.
public TimeSpan BeginTime { get; set; }
Property Value
- TimeSpan:
The time at which this transition should begin, relative to the parent's begin time.
Direction
Gets or sets a TransitionDirection specifying the direction of the transition.
public TransitionDirection Direction { get; set; }
Property Value
- TransitionDirection:
A TransitionDirection specifying the direction of the transition.
Duration
Gets or sets the length of time for which this transition plays, not counting repetitions.
public Duration Duration { get; set; }
Property Value
- Duration:
The transition's simple duration: the amount of time this effect takes to complete a single forward iteration. The default value is
Automatic
.
Mode
Gets or sets a TransitionMode specifying the mode of the transition.
public TransitionMode Mode { get; set; }
Property Value
- TransitionMode:
A TransitionMode specifying the mode of the transition.
Spread
Gets or sets the spread of the wipe effect.
public double Spread { get; set; }
Property Value
- Double:
A percentage value between
0
and1
. The default is0.25
.
Remarks
A larger value makes the wipe gradient larger.
Methods
GetFromContentStoryboard(TransitionPresenter, FrameworkElement)
Returns the Storyboard to apply to the "from" content.
protected override Storyboard GetFromContentStoryboard(TransitionPresenter presenter, FrameworkElement content)
Parameter | Type | Description |
---|---|---|
presenter | TransitionPresenter | The TransitionPresenter that is managing the transition. |
content | FrameworkElement | The element requesting a Style. |
Returns
- Storyboard:
The Storyboard to apply to the "from" content.
GetFromContentStyle(TransitionPresenter, FrameworkElement)
Returns the Style to apply to the "from" content during the transition.
protected override Style GetFromContentStyle(TransitionPresenter presenter, FrameworkElement content)
Parameter | Type | Description |
---|---|---|
presenter | TransitionPresenter | The TransitionPresenter that is managing the transition. |
content | FrameworkElement | The element requesting a Style. |
Returns
GetOppositeTransition()
Returns a variation of the transition that can be used for backing out a content that was inserted into the presenter using this transition.
public override Transition GetOppositeTransition()
Returns
- Transition:
A variation of the transition that can be used for backing out a content that was inserted into the presenter using this transition.
GetToContentStoryboard(TransitionPresenter, FrameworkElement)
Returns the Storyboard to apply to the "to" content.
protected override Storyboard GetToContentStoryboard(TransitionPresenter presenter, FrameworkElement content)
Parameter | Type | Description |
---|---|---|
presenter | TransitionPresenter | The TransitionPresenter that is managing the transition. |
content | FrameworkElement | The element requesting a Style. |
Returns
- Storyboard:
The Storyboard to apply to the "to" content.
GetToContentStyle(TransitionPresenter, FrameworkElement)
Returns the Style to apply to the "to" content during the transition.
protected override Style GetToContentStyle(TransitionPresenter presenter, FrameworkElement content)
Parameter | Type | Description |
---|---|---|
presenter | TransitionPresenter | The TransitionPresenter that is managing the transition. |
content | FrameworkElement | The element requesting a Style. |
Returns
Fields
BeginTimeProperty
Identifies the BeginTime dependency property. This field is read-only.
public static readonly DependencyProperty BeginTimeProperty
DirectionProperty
Identifies the Direction dependency property. This field is read-only.
public static readonly DependencyProperty DirectionProperty
DurationProperty
Identifies the Duration dependency property. This field is read-only.
public static readonly DependencyProperty DurationProperty
ModeProperty
Identifies the Mode dependency property. This field is read-only.
public static readonly DependencyProperty ModeProperty
SpreadProperty
Identifies the Spread dependency property. This field is read-only.
public static readonly DependencyProperty SpreadProperty
Inherited Members
- StoryboardTransitionBase.GetFromContentStyle(TransitionPresenter, FrameworkElement, FrameworkElement)
- StoryboardTransitionBase.GetToContentStyle(TransitionPresenter, FrameworkElement, FrameworkElement)
- StoryboardTransitionBase.OnCompleted(TransitionPresenter, FrameworkElement, Object, FrameworkElement, Object)
- StoryboardTransitionBase.OnStarted(TransitionPresenter, FrameworkElement, FrameworkElement)
- Transition.ClipToBoundsProperty
- Transition.IsToContentTopMostProperty
- Transition.ICloneable.Clone()
- Transition.Clone()
- Transition.EndTransition(TransitionPresenter, FrameworkElement, Object, FrameworkElement, Object)
- Transition.GetOppositeDirection(TransitionDirection)
- Transition.GetOppositeMode(TransitionMode)
- Transition.GetResolvedDirection(TransitionDirection, TransitionDirection)
- Transition.ClipToBounds
- Transition.IsToContentTopMost
- Object.ToString()
- Object.Equals(Object)
- Object.Equals(Object, Object)
- Object.ReferenceEquals(Object, Object)
- Object.GetHashCode()
- Object.GetType()
- Object.MemberwiseClone()