DragOverThemeAnimation DragOverThemeAnimation DragOverThemeAnimation DragOverThemeAnimation Class

Definition

Represents the preconfigured animation that applies to the elements underneath an element being dragged.

public : sealed class DragOverThemeAnimation : Timeline, IDragOverThemeAnimation
struct winrt::Windows::UI::Xaml::Media::Animation::DragOverThemeAnimation : Timeline, IDragOverThemeAnimation
public sealed class DragOverThemeAnimation : Timeline, IDragOverThemeAnimation
Public NotInheritable Class DragOverThemeAnimation Inherits Timeline Implements IDragOverThemeAnimation
<DragItemThemeAnimation .../>
Inheritance
DragOverThemeAnimationDragOverThemeAnimationDragOverThemeAnimationDragOverThemeAnimation
Attributes
Windows 10 requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

Examples

The following is an example of a template for a custom control that animates as another element is being dragged over it.

<Style x:Key="ListViewItemStyle1" TargetType="ListViewItem">
    <Setter Property="Template">
        <Setter.Value>
            <ControlTemplate TargetType="ListViewItem">
                <Border x:Name="OuterContainer">
                    <VisualStateManager.VisualStateGroups>                        
                        <!—Reordering hint VisualStates of the ListViewItem control which use 
                             DragOverThemeAnimation. -->
                        <VisualStateGroup x:Name="ReorderHintStates">
                            <VisualStateGroup.Transitions>
                                <VisualTransition GeneratedDuration="0:0:0.650" To="NoReorderHint"/>
                            </VisualStateGroup.Transitions>
                            <VisualState x:Name="NoReorderHint"/>
                            <VisualState x:Name="BottomReorderHint">
                                <Storyboard>
                                    <DragOverThemeAnimation 
                                          Direction="Bottom" 
                                          ToOffset="{StaticResource ListViewItemReorderHintThemeOffset}"
                                          TargetName="ReorderHintContent"
                              />
                                </Storyboard>
                            </VisualState>
                            <VisualState x:Name="TopReorderHint">
                                <Storyboard>
                                    <DragOverThemeAnimation 
                                          Direction="Top" 
                                          ToOffset="{StaticResource ListViewItemReorderHintThemeOffset}"
                                          TargetName="ReorderHintContent"
                              />
                                </Storyboard>
                            </VisualState>
                            <VisualState x:Name="RightReorderHint">
                                <Storyboard>
                                    <DragOverThemeAnimation 
                                          Direction="Right" 
                                          ToOffset="{StaticResource ListViewItemReorderHintThemeOffset}"
                                          TargetName="ReorderHintContent"
                              />
                                </Storyboard>
                            </VisualState>
                            <VisualState x:Name="LeftReorderHint">
                                <Storyboard>
                                    <DragOverThemeAnimation 
                                          Direction="Left" 
                                          ToOffset="{StaticResource ListViewItemReorderHintThemeOffset}"
                                          TargetName="ReorderHintContent"
                              />
                                </Storyboard>
                            </VisualState>
                        </VisualStateGroup>

                        <!-- Additional state groups here. -->

                    </VisualStateManager.VisualStateGroups>

                    <!-- Template content here. -->

            </ControlTemplate>
        </Setter.Value>
    </Setter>
</Style>

Remarks

Note that setting the Duration property has no effect on this object since the duration is preconfigured.

Constructors

DragOverThemeAnimation() DragOverThemeAnimation() DragOverThemeAnimation() DragOverThemeAnimation()

Initializes a new instance of the DragOverThemeAnimation class.

public : DragOverThemeAnimation()
DragOverThemeAnimation() const;
public DragOverThemeAnimation()
Public Sub New()
See Also

Properties

AllowDependentAnimations AllowDependentAnimations AllowDependentAnimations AllowDependentAnimations

Gets or sets a value that determines whether dependent animations should be permitted to run, throughout the app.

(Inherited from Timeline)

AutoReverse AutoReverse AutoReverse AutoReverse

Gets or sets a value that indicates whether the timeline plays in reverse after it completes a forward iteration.

(Inherited from Timeline)

AutoReverseProperty AutoReverseProperty AutoReverseProperty AutoReverseProperty

Identifies the AutoReverse dependency property.

(Inherited from Timeline)

BeginTime BeginTime BeginTime BeginTime

Gets or sets the time at which this Timeline should begin.

(Inherited from Timeline)

BeginTimeProperty BeginTimeProperty BeginTimeProperty BeginTimeProperty

Identifies the BeginTime dependency property.

(Inherited from Timeline)

Direction Direction Direction Direction

Gets or sets the direction that the target should translate, when the animation is active.

public : AnimationDirection Direction { get; set; }
AnimationDirection Direction(); void Direction(AnimationDirection direction);
public AnimationDirection Direction { get; set; }
Public ReadWrite Property Direction As AnimationDirection
<DragOverThemeAnimation Direction="animationDirectionMemberName" />

Value
AnimationDirection AnimationDirection

A value of the enumeration.

See Also

DirectionProperty DirectionProperty DirectionProperty DirectionProperty

Identifies the Direction dependency property.

public : static DependencyProperty DirectionProperty { get; }
static DependencyProperty DirectionProperty();
public static DependencyProperty DirectionProperty { get; }
Public Static ReadOnly Property DirectionProperty As DependencyProperty
Value
DependencyProperty DependencyProperty

The identifier for the Direction dependency property.

See Also

Dispatcher Dispatcher Dispatcher Dispatcher

Gets the CoreDispatcher that this object is associated with. The CoreDispatcher represents a facility that can access the DependencyObject on the UI thread even if the code is initiated by a non-UI thread.

(Inherited from DependencyObject)

Duration Duration Duration Duration

Gets or sets the length of time for which this timeline plays, not counting repetitions.

(Inherited from Timeline)

DurationProperty DurationProperty DurationProperty DurationProperty

Identifies the Duration dependency property.

(Inherited from Timeline)

FillBehavior FillBehavior FillBehavior FillBehavior

Gets or sets a value that specifies how the animation behaves after it reaches the end of its active period.

(Inherited from Timeline)

FillBehaviorProperty FillBehaviorProperty FillBehaviorProperty FillBehaviorProperty

Identifies the FillBehavior dependency property.

(Inherited from Timeline)

RepeatBehavior RepeatBehavior RepeatBehavior RepeatBehavior

Gets or sets the repeating behavior of this timeline.

(Inherited from Timeline)

RepeatBehaviorProperty RepeatBehaviorProperty RepeatBehaviorProperty RepeatBehaviorProperty

Identifies the RepeatBehavior dependency property.

(Inherited from Timeline)

SpeedRatio SpeedRatio SpeedRatio SpeedRatio

Gets or sets the rate, relative to its parent, at which time progresses for this Timeline.

(Inherited from Timeline)

SpeedRatioProperty SpeedRatioProperty SpeedRatioProperty SpeedRatioProperty

Identifies for the SpeedRatio dependency property.

(Inherited from Timeline)

TargetName TargetName TargetName TargetName

Gets or sets the reference name of the control element being targeted.

public : Platform::String TargetName { get; set; }
winrt::hstring TargetName(); void TargetName(winrt::hstring targetname);
public string TargetName { get; set; }
Public ReadWrite Property TargetName As string
<DragOverThemeAnimation TargetName="nameString" />

Value
string string

The reference name. This is typically the x:Name of the relevant element as declared in XAML.

See Also

TargetNameProperty TargetNameProperty TargetNameProperty TargetNameProperty

Identifies the TargetName dependency property.

public : static DependencyProperty TargetNameProperty { get; }
static DependencyProperty TargetNameProperty();
public static DependencyProperty TargetNameProperty { get; }
Public Static ReadOnly Property TargetNameProperty As DependencyProperty
Value
DependencyProperty DependencyProperty

The identifier for the TargetName dependency property.

See Also

ToOffset ToOffset ToOffset ToOffset

Gets or sets the distance by which the target is translated when the animation is active.

public : double ToOffset { get; set; }
double ToOffset(); void ToOffset(double tooffset);
public double ToOffset { get; set; }
Public ReadWrite Property ToOffset As double
<DragOverThemeAnimation ToOffset="double" />

Value
double double

The offset, in pixels.

Remarks

The direction of the offset is controlled by Direction.

See Also

ToOffsetProperty ToOffsetProperty ToOffsetProperty ToOffsetProperty

Identifies the ToOffset dependency property.

public : static DependencyProperty ToOffsetProperty { get; }
static DependencyProperty ToOffsetProperty();
public static DependencyProperty ToOffsetProperty { get; }
Public Static ReadOnly Property ToOffsetProperty As DependencyProperty
Value
DependencyProperty DependencyProperty

The identifier for the ToOffset dependency property.

See Also

Methods

ClearValue(DependencyProperty) ClearValue(DependencyProperty) ClearValue(DependencyProperty) ClearValue(DependencyProperty)

Clears the local value of a dependency property.

(Inherited from DependencyObject)

GetAnimationBaseValue(DependencyProperty) GetAnimationBaseValue(DependencyProperty) GetAnimationBaseValue(DependencyProperty) GetAnimationBaseValue(DependencyProperty)

Returns any base value established for a dependency property, which would apply in cases where an animation is not active.

(Inherited from DependencyObject)

GetValue(DependencyProperty) GetValue(DependencyProperty) GetValue(DependencyProperty) GetValue(DependencyProperty)

Returns the current effective value of a dependency property from a DependencyObject.

(Inherited from DependencyObject)

ReadLocalValue(DependencyProperty) ReadLocalValue(DependencyProperty) ReadLocalValue(DependencyProperty) ReadLocalValue(DependencyProperty)

Returns the local value of a dependency property, if a local value is set.

(Inherited from DependencyObject)

RegisterPropertyChangedCallback(DependencyProperty,DependencyPropertyChangedCallback) RegisterPropertyChangedCallback(DependencyProperty,DependencyPropertyChangedCallback) RegisterPropertyChangedCallback(DependencyProperty,DependencyPropertyChangedCallback) RegisterPropertyChangedCallback(DependencyProperty,DependencyPropertyChangedCallback)

Registers a notification function for listening to changes to a specific DependencyProperty on this DependencyObject instance.

(Inherited from DependencyObject)

SetValue(DependencyProperty,Object) SetValue(DependencyProperty,Object) SetValue(DependencyProperty,Object) SetValue(DependencyProperty,Object)

Sets the local value of a dependency property on a DependencyObject.

(Inherited from DependencyObject)

UnregisterPropertyChangedCallback(DependencyProperty,Int64) UnregisterPropertyChangedCallback(DependencyProperty,Int64) UnregisterPropertyChangedCallback(DependencyProperty,Int64) UnregisterPropertyChangedCallback(DependencyProperty,Int64)

Cancels a change notification that was previously registered by calling RegisterPropertyChangedCallback.

(Inherited from DependencyObject)

Events

Completed Completed Completed Completed

Occurs when the Storyboard object has completed playing.

(Inherited from Timeline)

See Also