BitmapIconSource Class

Definition

Namespace:

Windows.UI.Xaml.Controls

Represents an icon source that uses a bitmap as its content.

Equivalent WinUI 2 API for UWP: Microsoft.UI.Xaml.Controls.BitmapIconSource (for WinUI in the Windows App SDK, see the Windows App SDK namespaces).

/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 327680)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
class BitmapIconSource : IconSource

[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 327680)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
public class BitmapIconSource : IconSource

function BitmapIconSource()

Public Class BitmapIconSource
Inherits IconSource

<BitmapIconSource .../>

Inheritance

Object IInspectable DependencyObject IconSource BitmapIconSource

Attributes

ContractVersionAttribute MarshalingBehaviorAttribute ThreadingAttribute

Windows requirements

Device family	Windows 10 Fall Creators Update (introduced in 10.0.16299.0)
API contract	Windows.Foundation.UniversalApiContract (introduced in v5.0)

Remarks

BitmapIconSource is similar to BitmapIcon. However, because it is not a FrameworkElement, it can be shared.

Constructors

BitmapIconSource()

Initializes a new instance of the BitmapIconSource class. Equivalent WinUI 2 API for UWP: Microsoft.UI.Xaml.Controls.BitmapIconSource.-ctor (for WinUI in the Windows App SDK, see the Windows App SDK namespaces).

Properties

Dispatcher	Gets the CoreDispatcher that this object is associated with. The CoreDispatcher 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)
Foreground	Gets or sets a brush that describes the foreground color. Equivalent WinUI 2 API for UWP: Microsoft.UI.Xaml.Controls.IconSource.Foreground (for WinUI in the Windows App SDK, see the Windows App SDK namespaces). (Inherited from IconSource)
ShowAsMonochrome	Gets or sets a value that indicates whether the bitmap is shown in a single color. Equivalent WinUI 2 API for UWP: Microsoft.UI.Xaml.Controls.BitmapIconSource.ShowAsMonochrome (for WinUI in the Windows App SDK, see the Windows App SDK namespaces).
ShowAsMonochromeProperty	Identifies the ShowAsMonochrome dependency property. Equivalent WinUI 2 API for UWP: Microsoft.UI.Xaml.Controls.BitmapIconSource.ShowAsMonochromeProperty (for WinUI in the Windows App SDK, see the Windows App SDK namespaces).
UriSource	Gets or sets the Uniform Resource Identifier (URI) of the bitmap to use as the icon content. Equivalent WinUI 2 API for UWP: Microsoft.UI.Xaml.Controls.BitmapIconSource.UriSource (for WinUI in the Windows App SDK, see the Windows App SDK namespaces).
UriSourceProperty	Identifies the UriSource dependency property. Equivalent WinUI 2 API for UWP: Microsoft.UI.Xaml.Controls.BitmapIconSource.UriSourceProperty (for WinUI in the Windows App SDK, see the Windows App SDK namespaces).

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)