PopInThemeAnimation PopInThemeAnimation PopInThemeAnimation PopInThemeAnimation Class

Definition

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.

public : sealed class PopInThemeAnimation : Timeline, IPopInThemeAnimation
public sealed class PopInThemeAnimation : Timeline, IPopInThemeAnimation
Public NotInheritable Class PopInThemeAnimation Inherits Timeline Implements IPopInThemeAnimation
var popInThemeAnimation = new popInThemeAnimation();
<PopInThemeAnimation .../>
Inheritance
PopInThemeAnimationPopInThemeAnimationPopInThemeAnimationPopInThemeAnimation
Attributes
Windows 10 requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

Examples

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

<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>

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.

Constructors

PopInThemeAnimation() PopInThemeAnimation() PopInThemeAnimation() PopInThemeAnimation()

Initializes a new instance of the PopInThemeAnimation class.

public : PopInThemeAnimation()
public PopInThemeAnimation()
Public Sub New()
var popInThemeAnimation = new popInThemeAnimation();
See Also

Properties

FromHorizontalOffset FromHorizontalOffset FromHorizontalOffset FromHorizontalOffset

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

public : double FromHorizontalOffset { get; set; }
public double FromHorizontalOffset { get; set; }
Public ReadWrite Property FromHorizontalOffset As double
var double = popInThemeAnimation.fromHorizontalOffset;
popInThemeAnimation.fromHorizontalOffset = double;
<PopInThemeAnimation FromHorizontalOffset="double" />

Value
double double double double

The horizontal offset translation, in pixels.

See Also

FromHorizontalOffsetProperty FromHorizontalOffsetProperty FromHorizontalOffsetProperty FromHorizontalOffsetProperty

Identifies the FromHorizontalOffset dependency property.

public : static DependencyProperty FromHorizontalOffsetProperty { get; }
public static DependencyProperty FromHorizontalOffsetProperty { get; }
Public Static ReadOnly Property FromHorizontalOffsetProperty As DependencyProperty
var dependencyProperty = Windows.UI.Xaml.Media.Animation.PopInThemeAnimation.fromHorizontalOffsetProperty;
See Also

FromVerticalOffset FromVerticalOffset FromVerticalOffset FromVerticalOffset

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

public : double FromVerticalOffset { get; set; }
public double FromVerticalOffset { get; set; }
Public ReadWrite Property FromVerticalOffset As double
var double = popInThemeAnimation.fromVerticalOffset;
popInThemeAnimation.fromVerticalOffset = double;
<PopInThemeAnimation FromVerticalOffset="double" />

Value
double double double double

The vertical offset translation, in pixels.

See Also

FromVerticalOffsetProperty FromVerticalOffsetProperty FromVerticalOffsetProperty FromVerticalOffsetProperty

Identifies the FromVerticalOffset dependency property.

public : static DependencyProperty FromVerticalOffsetProperty { get; }
public static DependencyProperty FromVerticalOffsetProperty { get; }
Public Static ReadOnly Property FromVerticalOffsetProperty As DependencyProperty
var dependencyProperty = Windows.UI.Xaml.Media.Animation.PopInThemeAnimation.fromVerticalOffsetProperty;
See Also

TargetName TargetName TargetName TargetName

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

public : Platform::String TargetName { get; set; }
public string TargetName { get; set; }
Public ReadWrite Property TargetName As string
var string = popInThemeAnimation.targetName;
popInThemeAnimation.targetName = string;
<PopInThemeAnimation TargetName="nameString" />

Value
Platform::String string 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; }
public static DependencyProperty TargetNameProperty { get; }
Public Static ReadOnly Property TargetNameProperty As DependencyProperty
var dependencyProperty = Windows.UI.Xaml.Media.Animation.PopInThemeAnimation.targetNameProperty;
Value
DependencyProperty DependencyProperty DependencyProperty DependencyProperty

The identifier for the TargetName dependency property.

See Also

AllowDependentAnimations AllowDependentAnimations AllowDependentAnimations AllowDependentAnimations

Inherited from Timeline

AutoReverse AutoReverse AutoReverse AutoReverse

Inherited from Timeline

AutoReverseProperty AutoReverseProperty AutoReverseProperty AutoReverseProperty

Inherited from Timeline

BeginTime BeginTime BeginTime BeginTime

Inherited from Timeline

BeginTimeProperty BeginTimeProperty BeginTimeProperty BeginTimeProperty

Inherited from Timeline

Dispatcher Dispatcher Dispatcher Dispatcher

Inherited from DependencyObject

Duration Duration Duration Duration

Inherited from Timeline

DurationProperty DurationProperty DurationProperty DurationProperty

Inherited from Timeline

FillBehavior FillBehavior FillBehavior FillBehavior

Inherited from Timeline

FillBehaviorProperty FillBehaviorProperty FillBehaviorProperty FillBehaviorProperty

Inherited from Timeline

RepeatBehavior RepeatBehavior RepeatBehavior RepeatBehavior

Inherited from Timeline

RepeatBehaviorProperty RepeatBehaviorProperty RepeatBehaviorProperty RepeatBehaviorProperty

Inherited from Timeline

SpeedRatio SpeedRatio SpeedRatio SpeedRatio

Inherited from Timeline

SpeedRatioProperty SpeedRatioProperty SpeedRatioProperty SpeedRatioProperty

Inherited from Timeline

Methods

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

Inherited from DependencyObject

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

Inherited from DependencyObject

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

Inherited from DependencyObject

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

Inherited from DependencyObject

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

Inherited from DependencyObject

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

Inherited from DependencyObject

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

Inherited from DependencyObject

Events

Completed Completed Completed Completed

Inherited from Timeline

See Also