AnimatedIconSource Class

Reference

Definition

Namespace:: Microsoft.UI.Xaml.Controls

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

Represents a shareable object used to create an icon that displays and controls a visual that can animate in response to user interaction and visual state changes.

/// [Windows.Foundation.Metadata.ContractVersion(Microsoft.UI.Xaml.XamlContract, 65536)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
class AnimatedIconSource : IconSource

[Windows.Foundation.Metadata.ContractVersion(typeof(Microsoft.UI.Xaml.XamlContract), 65536)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
public class AnimatedIconSource : IconSource

Public Class AnimatedIconSource
Inherits IconSource

Inheritance: Object IInspectable DependencyObject IconSource AnimatedIconSource

Attributes: ContractVersionAttribute MarshalingBehaviorAttribute ThreadingAttribute

Examples

Tip

For more info, design guidance, and code examples, see Animated icon.

Open the WinUI 3 Gallery app and see the AnimatedIcon in action.

The WinUI 3 Gallery app includes interactive examples of most WinUI 3 controls, features, and functionality. Get the app from the Microsoft Store or get the source code on GitHub.

Remarks

Note

AnimatedIconSource is similar to AnimatedIcon. However, because it is not a FrameworkElement, it can be shared.

You don't set the state directly on an AnimatedIconSource. Instead, set the AnimatedIcon.State attached property on an ancestor element of the AnimatedIconSource.

Constructors

AnimatedIconSource()

Initializes a new instance of the AnimatedIconSource 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)
FallbackIconSource	Gets or sets the static icon to use when the animated icon cannot run.
FallbackIconSourceProperty	Identifies the FallbackIconSource dependency property.
Foreground	Gets or sets a brush that paints the foreground color of the control. (Inherited from IconSource)
MirroredWhenRightToLeft	Gets or sets a value that indicates whether the icon is mirrored when the FlowDirection is RightToLeft.
MirroredWhenRightToLeftProperty	Identifies the MirroredWhenRightToLeft dependency property.
Source	Gets or sets the animated visual shown by the `AnimatedIconSource` object.
SourceProperty	Identifies the Source dependency property.

Methods

ClearValue(DependencyProperty)	Clears the local value of a dependency property. (Inherited from DependencyObject)
CreateIconElement()	Creates an icon UI element. (Inherited from IconSource)
CreateIconElementCore()	Creates an icon UI element. (Inherited from IconSource)
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)
GetIconElementPropertyCore(DependencyProperty)	Maps IconSource properties to IconElementProperties. (Inherited from IconSource)
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