BitmapIconSource Class

  • Reference

Definition

Namespace:
Microsoft.UI.Xaml.Controls
Edit

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

/// [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 BitmapIconSource : IconSource
[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 class BitmapIconSource : IconSource
Public Class BitmapIconSource
Inherits IconSource
<BitmapIconSource .../>
Inheritance
Object IInspectable DependencyObject IconSource BitmapIconSource
Attributes
ContractVersionAttribute MarshalingBehaviorAttribute ThreadingAttribute

Examples

Tip

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

Open the WinUI 3 Gallery app and see BitmapIconSource 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

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.

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)
Foreground

Gets or sets a brush that paints the foreground color of the control.

(Inherited from IconSource)
ShowAsMonochrome

Gets or sets a value that indicates whether the bitmap is shown in a single color.
ShowAsMonochromeProperty

Identifies the ShowAsMonochrome dependency property.
UriSource

Gets or sets the Uniform Resource Identifier (URI) of the bitmap to use as the icon content.
UriSourceProperty

Identifies the UriSource 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

See also