RepositionThemeAnimation Class

Reference

Definition

Namespace:: Microsoft.UI.Xaml.Media.Animation

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Edit

Use to animate an object that is being repositioned.

public ref class RepositionThemeAnimation sealed : Timeline

/// [Windows.Foundation.Metadata.Activatable(65536, "Microsoft.UI.Xaml.WinUIContract")]
/// [Windows.Foundation.Metadata.ContractVersion(Microsoft.UI.Xaml.WinUIContract, 65536)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
class RepositionThemeAnimation final : Timeline

[Windows.Foundation.Metadata.Activatable(65536, "Microsoft.UI.Xaml.WinUIContract")]
[Windows.Foundation.Metadata.ContractVersion(typeof(Microsoft.UI.Xaml.WinUIContract), 65536)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
public sealed class RepositionThemeAnimation : Timeline

Public NotInheritable Class RepositionThemeAnimation
Inherits Timeline

<RepositionThemeAnimation .../>

Inheritance: Object Platform::Object IInspectable DependencyObject Timeline RepositionThemeAnimation

Attributes: ActivatableAttribute ContractVersionAttribute MarshalingBehaviorAttribute ThreadingAttribute

Examples

The following example applies a RepositionThemeAnimation to a rectangle.

<Grid>
    <Grid.Resources>
        <!-- Sets up a RepositionThemeAnimation using the FromHorizontalOffset property 
             to start the animation from the old location. -->
        <Storyboard x:Name="PointerReleasedStoryboard">
            <RepositionThemeAnimation Storyboard.TargetName="myRectangle" FromHorizontalOffset="-400"/>
        </Storyboard>
    </Grid.Resources>

    <Rectangle x:Name="myRectangle" 
         HorizontalAlignment="Left" 
         Width="200" 
         Height="200" 
         Fill="Blue"
         PointerReleased="Rectangle_PointerReleased" 
/>
</Grid>

private void Rectangle_PointerReleased(object sender, PointerRoutedEventArgs e)
{
    myRectangle.Margin = new Thickness(400, 0, 0, 0);
    PointerReleasedStoryboard.Begin();            
}

void DocsCppWinRT::MainPage::Rectangle_PointerReleased(
    Windows::Foundation::IInspectable const& /* sender */,
    Windows::UI::Xaml::Input::PointerRoutedEventArgs const& /* e */)
{
    myRectangle().Margin({ 400, 0, 0, 0 });
    PointerReleasedStoryboard().Begin();
}

void MyPage::Rectangle_PointerReleased(Object^ sender, PointerRoutedEventArgs^ e)
{
    myRectangle->Margin = Thickness(400, 0, 0, 0);
    PointerReleasedStoryboard->Begin();
}

Remarks

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

Constructors

RepositionThemeAnimation()

Initializes a new instance of the RepositionThemeAnimation class.

Properties

AutoReverse	Gets or sets a value that indicates whether the timeline plays in reverse after it completes a forward iteration. (Inherited from Timeline)
BeginTime	Gets or sets the time at which this Timeline should begin. (Inherited from Timeline)
Dispatcher	Always returns `null` in a Windows App SDK app. Use DispatcherQueue instead. (Inherited from DependencyObject)
DispatcherQueue	Gets the `DispatcherQueue` that this object is associated with. The `DispatcherQueue` 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	Gets or sets the length of time for which this timeline plays, not counting repetitions. (Inherited from Timeline)
FillBehavior	Gets or sets a value that specifies how the animation behaves after it reaches the end of its active period. (Inherited from Timeline)
FromHorizontalOffset	Gets or sets the distance by which the target is translated in the horizontal direction when the animation is active.
FromHorizontalOffsetProperty	Identifies the FromHorizontalOffset dependency property.
FromVerticalOffset	Gets or sets the distance by which the target is translated in the vertical direction when the animation is active.
FromVerticalOffsetProperty	Identifies the FromVerticalOffset dependency property.
RepeatBehavior	Gets or sets the repeating behavior of this timeline. (Inherited from Timeline)
SpeedRatio	Gets or sets the rate, relative to its parent, at which time progresses for this Timeline. (Inherited from Timeline)
TargetName	Gets or sets the reference name of the control element being targeted.
TargetNameProperty	Identifies the TargetName dependency property.

Methods

ClearValue(DependencyProperty)	Clears the local value of a dependency property. (Inherited from DependencyObject)
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)	Returns the current effective value of a dependency property from a DependencyObject. (Inherited from DependencyObject)
ReadLocalValue(DependencyProperty)	Returns the local value of a dependency property, if a local value is set. (Inherited from DependencyObject)
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)	Sets the local value of a dependency property on a DependencyObject. (Inherited from DependencyObject)
UnregisterPropertyChangedCallback(DependencyProperty, Int64)	Cancels a change notification that was previously registered by calling RegisterPropertyChangedCallback. (Inherited from DependencyObject)

Events

Completed

Occurs when the Storyboard object has completed playing.

(Inherited from Timeline)

Applies to

Share via