PopInThemeAnimation class (Windows)

0 out of 1 rated this helpful - Rate this topic

Represents the preconfigured animation that applies to pop-in components of controls (for example, tooltip-like UI on an object) as they appear. This animation combines opacity and translation.

Inheritance

Object
DependencyObject
Timeline
PopInThemeAnimation

Syntax

C++


public sealed class PopInThemeAnimation : Timeline

XAML Object Element Usage


<PopInThemeAnimation .../>

Attributes

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

Members

The PopInThemeAnimation class has these types of members:

Constructors
Events
Methods
Properties

Constructors

The PopInThemeAnimation class has these constructors.

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

Events

The PopInThemeAnimation class has these events.

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

Methods

The PopInThemeAnimation 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 PopInThemeAnimation 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)
FromHorizontalOffset	Read/write	Gets or sets the distance by which the target is translated in the horizontal direction when the animation is active.
FromHorizontalOffsetProperty	Read-only	Identifies the FromHorizontalOffset dependency property.
FromVerticalOffset	Read/write	Gets or sets the distance by which the target is translated in the vertical direction when the animation is active.
FromVerticalOffsetProperty	Read-only	Identifies the FromVerticalOffset dependency property.
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

This animation does not move or change the object or its neighbors. This animation is meant to be applied to overlay content (like tooltips) when that content first appears. When the content dissapears, you should use a PopOutThemeAnimation.

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

Examples

The following shows an example template for a ToolTip control that uses PopInThemeAnimation and PopOutThemeAnimation.

XAML


<Style x:Key="ToolTipStyle1" TargetType="ToolTip">
    <!-- Sample template for the ToolTip control that uses PopinThemeAnimation and PopOutThemeAnimation. -->
    <Setter Property="Template">
        <Setter.Value>
            <ControlTemplate TargetType="ToolTip">
                <Border x:Name="LayoutRoot" 
                         BorderBrush="{TemplateBinding BorderBrush}" 
                         BorderThickness="{TemplateBinding BorderThickness}" 
                         Background="{TemplateBinding Background}">
                    <VisualStateManager.VisualStateGroups>
                        <VisualStateGroup x:Name="OpenStates">
                            <VisualState x:Name="Closed">
                                <Storyboard>
                                    <!-- Run a PopOutThemeAnimation when ToolTip is closed. -->
                                    <PopOutThemeAnimation TargetName="LayoutRoot"/>
                                </Storyboard>
                            </VisualState>
                            <VisualState x:Name="Opened">
                                <Storyboard>
                                    <!-- Run a PopInThemeAnimation when ToolTip is opened. -->
                                    <PopInThemeAnimation 
                                        FromVerticalOffset="{Binding TemplateSettings.FromVerticalOffset, RelativeSource={RelativeSource Mode=TemplatedParent}}" 
                                        FromHorizontalOffset="{Binding TemplateSettings.FromHorizontalOffset, RelativeSource={RelativeSource Mode=TemplatedParent}}" 
                                        TargetName="LayoutRoot"/>
                                </Storyboard>
                            </VisualState>
                        </VisualStateGroup>
                    </VisualStateManager.VisualStateGroups>
                    <ContentPresenter 
                         ContentTemplate="{TemplateBinding ContentTemplate}" 
                         ContentTransitions="{TemplateBinding ContentTransitions}" 
                         Content="{TemplateBinding Content}" 
                         Margin="{TemplateBinding Padding}"/>
                </Border>
            </ControlTemplate>
        </Setter.Value>
    </Setter>
</Style>

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

PopInThemeAnimation class