ImageIcon Class
Definition
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.
Represents an icon that uses an Image as its content.
This documentation applies to WinUI 2 for UWP (for WinUI in the Windows App SDK, see the Windows App SDK namespaces).
/// [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 ImageIcon : IconElement[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 ImageIcon : IconElementPublic Class ImageIcon
Inherits IconElement- Inheritance
-
ImageIcon
- Attributes
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).
The following example shows an AppBarButton with an ImageIcon. Source specifies an image that's included in the app package.
<!--
xmlns:muxc="using:Microsoft.UI.Xaml.Controls"
-->
<AppBarButton Label="ImageIcon">
<AppBarButton.Icon>
<muxc:ImageIcon Source="ms-appx:///Assets/globe.png"/>
</AppBarButton.Icon>
</AppBarButton>
Here we show how to load an ImageIcon from a bitmap stream.
// using muxc = Microsoft.UI.Xaml.Controls;
var bitmapSource = new BitmapSource();
await bitmapSource.SetSourceAsync(bitmapStream);
var icon = new muxc.ImageIcon() { Source = bitmapSource };
Remarks
Supported image types are .bmp, .gif, .jpg, .png, .wdp, and .tiff.
The image should be solid on a transparent background.
Only the first frame of a multi-frame image is used. To use animated icons, see AnimatedIcon.
Due to the file types supported, ImageIcon ignores the Foreground property, so you can't change the foreground color like you can on other IconSource derived controls.
ImageIcon is typically used with an AppBarButton, but it can be used wherever an IconElement can be used.
Constructors
| ImageIcon() |
Initializes a new instance of the This documentation applies to WinUI 2 for UWP (for WinUI in the Windows App SDK, see the Windows App SDK namespaces). |
Properties
| Source |
Gets or sets the URI of the image file to use as the icon. This documentation applies to WinUI 2 for UWP (for WinUI in the Windows App SDK, see the Windows App SDK namespaces). |
| SourceProperty |
Identifies the This documentation applies to WinUI 2 for UWP (for WinUI in the Windows App SDK, see the Windows App SDK namespaces). |