PopInThemeAnimation PopInThemeAnimation PopInThemeAnimation Class

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.

Syntax

Declaration

public sealed class PopInThemeAnimationpublic sealed class PopInThemeAnimationPublic NotInheritable Class PopInThemeAnimation
<PopInThemeAnimation .../>

Inheritance Hierarchy

Inherited Members

Inherited properties

, , , , , , , , , , , , ,

Inherited methods

, , , , , ,

Inherited events

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.

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

Constructors summary

Initializes a new instance of the PopInThemeAnimation class.

Properties summary

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

Identifies the FromHorizontalOffset dependency property.

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

Identifies the FromVerticalOffset dependency property.

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

Identifies the TargetName dependency property.

Constructors

  • PopInThemeAnimation()
    PopInThemeAnimation()
    PopInThemeAnimation()
    PopInThemeAnimation()

    Initializes a new instance of the PopInThemeAnimation class.

    public PopInThemeAnimation()public New()Public Sub New()public PopInThemeAnimation()

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 doublepublic double FromHorizontalOffset { get; set; }
    <PopInThemeAnimation FromHorizontalOffset="double" />
    
    

    Property Value

    • double
      double
      double

      The horizontal offset translation, in pixels.

  • 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 DependencyPropertypublic static DependencyProperty FromHorizontalOffsetProperty { get; }

    Property Value

  • 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 doublepublic double FromVerticalOffset { get; set; }
    <PopInThemeAnimation FromVerticalOffset="double" />
    
    

    Property Value

    • double
      double
      double

      The vertical offset translation, in pixels.

  • 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 DependencyPropertypublic static DependencyProperty FromVerticalOffsetProperty { get; }

    Property Value

  • TargetName
    TargetName
    TargetName
    TargetName

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

    public string TargetName { get; set; }public string TargetName { get; set; }Public ReadWrite Property TargetName As stringpublic string TargetName { get; set; }
    <PopInThemeAnimation TargetName="nameString" />
    
    

    Property Value

    • string
      string
      string

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

  • 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 DependencyPropertypublic static DependencyProperty TargetNameProperty { get; }

    Property Value

Device family

Windows 10 (introduced v10.0.10240.0)

API contract

Windows.Foundation.UniversalApiContract (introduced v1)

Attributes

Windows.Foundation.Metadata.ActivatableAttribute
Windows.Foundation.Metadata.ContractVersionAttribute
Windows.Foundation.Metadata.MarshalingBehaviorAttribute
Windows.Foundation.Metadata.StaticAttribute
Windows.Foundation.Metadata.ThreadingAttribute
Windows.Foundation.Metadata.WebHostHiddenAttribute

Details

Assembly

Windows.UI.Xaml.Media.Animation.dll