DiscreteObjectKeyFrame 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

Animates from the Object value of the previous key frame to its own Value using discrete values.

public ref class DiscreteObjectKeyFrame sealed : ObjectKeyFrame

/// [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 DiscreteObjectKeyFrame final : ObjectKeyFrame

[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 DiscreteObjectKeyFrame : ObjectKeyFrame

Public NotInheritable Class DiscreteObjectKeyFrame
Inherits ObjectKeyFrame

<DiscreteObjectKeyFrame ...>
  <DiscreteObjectKeyFrame.Value>
    objectValue
  </DiscreteObjectKeyFrame.Value>
</DiscreteObjectKeyFrame ...>
-or-
</DiscreteObjectKeyFrame Value="objectAsAttribute"...>

Inheritance: Object Platform::Object IInspectable DependencyObject ObjectKeyFrame DiscreteObjectKeyFrame

Attributes: ActivatableAttribute ContractVersionAttribute MarshalingBehaviorAttribute ThreadingAttribute

Remarks

Key-frame animations permit more than one target value that is reached at a point along the animation timeline. In other words each key frame can specify a different intermediate value, and the last key frame reached is the final animation value. By specifying multiple values to animate, you can make more complex animations.

DiscreteObjectKeyFrame is the only keyframe type permitted in an ObjectAnimationUsingKeyFrames. There are no linear interpolations or other interpolation logic that's possible for changing object values as the animation runs. The old object is removed at the KeyTime and the new object that is the value of the keyframe with that KeyTime replaces it.

There are several scenarios where using ObjectAnimationUsingKeyFrames rather than a typed animation is useful. Some of them are:

Creating the Storyboard for a visual state and using a value that is a {StaticResource} markup extension reference, rather than one of the typed values. This gives you the ability to reference system theme resources from a visual state.
Animating int or byte values.
Animating structures used in UI definitions and visual states, such as GridLength. You can't animate the properties of the structure but you can swap the entire structure value with a DiscreteObjectKeyFrame and a new GridLength.

For more info on how to use key-frame animations, see Key-frame animations and easing function animations.

Constructors

DiscreteObjectKeyFrame()

Initializes a new instance of the DiscreteObjectKeyFrame class.

Properties

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)
KeyTime	Gets or sets the time at which the key frame's target Value should be reached. (Inherited from ObjectKeyFrame)
Value	Gets or sets the key frame's target value. (Inherited from ObjectKeyFrame)

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)

Applies to

Share via