PointerDownThemeAnimation class (Windows)

1 out of 1 rated this helpful - Rate this topic

Represents a preconfigured animation that runs when a user taps down on an item or element.

Inheritance

Object
DependencyObject
Timeline
PointerDownThemeAnimation

Syntax


public sealed class PointerDownThemeAnimation : Timeline

XAML Object Element Usage


<PointerDownThemeAnimation .../>

Attributes

ActivatableAttribute(NTDDI_WIN8)
MarshalingBehaviorAttribute(Agile)
StaticAttribute(Windows.UI.Xaml.Media.Animation.IPointerDownThemeAnimationStatics, NTDDI_WIN8)
ThreadingAttribute(Both)
VersionAttribute(NTDDI_WIN8)
WebHostHiddenAttribute()

Members

The PointerDownThemeAnimation class has these types of members:

Constructors
Events
Methods
Properties

Constructors

The PointerDownThemeAnimation class has these constructors.

Constructor	Description
PointerDownThemeAnimation	Initializes a new instance of the PointerDownThemeAnimation class.

Events

The PointerDownThemeAnimation class has these events.

Event	Description
Completed	Occurs when the Storyboard object has completed playing. (Inherited from Timeline)

Methods

The PointerDownThemeAnimation class has these methods. It also inherits methods from the Object class.

Method	Description
ClearValue	Clears the local value of a dependency property. (Inherited from DependencyObject)
GetAnimationBaseValue	Returns any base value established for a dependency property, which would apply in cases where an animation is not active. (Inherited from DependencyObject)
GetValue	Returns the current effective value of a dependency property from a DependencyObject. (Inherited from DependencyObject)
ReadLocalValue	Returns the local value of a dependency property, if a local value is set. (Inherited from DependencyObject)
SetValue	Sets the local value of a dependency property on a DependencyObject. (Inherited from DependencyObject)

Properties

The PointerDownThemeAnimation class has these properties.

Property	Access type	Description
AutoReverse	Read/write	Gets or sets a value that indicates whether the timeline plays in reverse after it completes a forward iteration. (Inherited from Timeline)
BeginTime	Read/write	Gets or sets the time at which this Timeline should begin. (Inherited from Timeline)
Dispatcher	Read-only	Gets the CoreDispatcher that this object is associated with. (Inherited from DependencyObject)
Duration	Read/write	Gets or sets the length of time for which this timeline plays, not counting repetitions. (Inherited from Timeline)
FillBehavior	Read/write	Gets or sets a value that specifies how the animation behaves after it reaches the end of its active period. (Inherited from Timeline)
RepeatBehavior	Read/write	Gets or sets the repeating behavior of this timeline. (Inherited from Timeline)
SpeedRatio	Read/write	Gets or sets the rate, relative to its parent, at which time progresses for this Timeline. (Inherited from Timeline)
TargetName	Read/write	Gets or sets the reference name of the control element being targeted.
TargetNameProperty	Read-only	Identifies the TargetName dependency property.

Remarks

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

Examples

The following is an example of a template of a custom control that uses PointerDown/Up theme animations.

XAML



<!-- Example template of a custom control that uses PointerDown/Up theme 
     animations. The PointerDownThemeAnimation will be run when the control
     is in the PointerDown state.-->
<ControlTemplate TargetType="local:TapControl">
    <Grid>
        <VisualStateManager.VisualStateGroups>
            <VisualStateGroup x:Name="TapStates">
                <VisualState x:Name="Normal" />
                <VisualState x:Name="PointerDown">
                    <Storyboard>
                        <PointerDownThemeAnimation TargetName="contentRectangle" />
                    </Storyboard>
                </VisualState>    
                <VisualState x:Name="PointerUp">
                    <Storyboard>
                        <PointerUpThemeAnimation TargetName="contentRectangle" />
                    </Storyboard>
                </VisualState>
            </VisualStateGroup>
        </VisualStateManager.VisualStateGroups>
        <Rectangle x:Name="contentRectangle" 
                    Width="100" 
                    Height="100" 
                    Fill="{TemplateBinding Background}" />
    </Grid>
</ControlTemplate>

C++


public sealed class TapControl : Control
{
    public TapControl()
    {
        this.DefaultStyleKey = typeof(TapControl);
    }

    protected override void OnPointerPressed(PointerRoutedEventArgs e)
    {
        this.CapturePointer(e.Pointer);
        VisualStateManager.GoToState(this, "PointerDown", true);
    }

    protected override void OnPointerReleased(PointerRoutedEventArgs e)
    {
        VisualStateManager.GoToState(this, "PointerUp", true);
        this.ReleasePointerCapture(e.Pointer);
    }
}

Requirements

Minimum supported client	Windows 8 [Windows Store apps only]
Minimum supported server	Windows Server 2012 [Windows Store apps only]
Namespace	Windows.UI.Xaml.Media.Animation Windows::UI::Xaml::Media::Animation [C++]
Metadata	Windows.winmd

PointerDownThemeAnimation class