IconSource Class

Definition

Namespace:

Microsoft.UI.Xaml.Controls

Represents the base class for an icon source.

This documentation applies to WinUI 2 for UWP (for WinUI in the Windows App SDK, see the Windows App SDK namespaces).

public ref class IconSource : DependencyObject

/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
/// [Microsoft.UI.Xaml.CustomAttributes.MUXPropertyChangedCallbackMethodName(value="OnPropertyChanged")]
/// [Windows.Foundation.Metadata.ContractVersion(Microsoft.UI.Xaml.XamlContract, 65536)]
/// [Windows.UI.Xaml.Data.Bindable]
class IconSource : DependencyObject

[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
[Microsoft.UI.Xaml.CustomAttributes.MUXPropertyChangedCallbackMethodName(value="OnPropertyChanged")]
[Windows.Foundation.Metadata.ContractVersion(typeof(Microsoft.UI.Xaml.XamlContract), 65536)]
[Windows.UI.Xaml.Data.Bindable]
public class IconSource : DependencyObject

Public Class IconSource
Inherits DependencyObject

Inheritance

DependencyObject

IconSource

Derived

Microsoft.UI.Xaml.Controls.AnimatedIconSource

Microsoft.UI.Xaml.Controls.BitmapIconSource

Microsoft.UI.Xaml.Controls.FontIconSource

Microsoft.UI.Xaml.Controls.ImageIconSource

Microsoft.UI.Xaml.Controls.PathIconSource

Microsoft.UI.Xaml.Controls.SymbolIconSource

Attributes

MarshalingBehaviorAttribute ThreadingAttribute Microsoft.UI.Xaml.CustomAttributes.MUXPropertyChangedCallbackMethodNameAttribute ContractVersionAttribute BindableAttribute

Examples

Tip

For more info, design guidance, and code examples, see Icons for Windows apps.

The WinUI 3 Gallery and WinUI 2 Gallery apps include interactive examples of most WinUI 3 and WinUI 2 controls, features, and functionality.

If installed already, open them by clicking the following links: WinUI 3 Gallery or WinUI 2 Gallery.

If they are not installed, you can download the WinUI 3 Gallery and the WinUI 2 Gallery from the Microsoft Store.

You can also get the source code for both from GitHub (use the main branch for WinUI 3 and the winui2 branch for WinUI 2).

Remarks

IconSource is similar to IconElement. However, because it is not a FrameworkElement, it can be shared.

IconSource derived classes

IconSource is the parent class for these classes:

• BitmapIconSource
• FontIconSource
• PathIconSource
• SymbolIconSource

Properties

Foreground	Gets or sets a brush that paints the foreground color of the control. This documentation applies to WinUI 2 for UWP (for WinUI in the Windows App SDK, see the Windows App SDK namespaces).
ForegroundProperty	Identifies the Foreground dependency property. This documentation applies to WinUI 2 for UWP (for WinUI in the Windows App SDK, see the Windows App SDK namespaces).

Methods

CreateIconElement()

Creates an IconSource UI element. This documentation applies to WinUI 2 for UWP (for WinUI in the Windows App SDK, see the Windows App SDK namespaces).