| -api-id | -api-type |
|---|---|
T:Windows.UI.Xaml.Controls.Image |
winrt class |
Represents a control that displays an image. The image source is specified by referring to an image file, using several supported formats. The image source can also be set with a stream. See Remarks for the list of supported image source formats.
<Image .../>An Image can display these image file formats:
- Joint Photographic Experts Group (JPEG)
- Portable Network Graphics (PNG)
- bitmap (BMP)
- Graphics Interchange Format (GIF)
- Tagged Image File Format (TIFF)
- JPEG XR
- icons (ICO)
- Scalable Vector Graphics (SVG)
Note
Icon files supported on Windows only. Not supported on Windows Phone 8.1
Starting in Windows 10, version 1607, the Image element supports animated Graphics Interchange Format (GIF) images. When you use a BitmapImage as the image Source, you can access BitmapImage API to control playback of the animated Graphics Interchange Format (GIF) image. For more info, see the Remarks on the BitmapImage class page.
Note
Animated Graphics Interchange Format (GIF) support is available when your app is compiled for Windows 10, version 1607 and running on version 1607 (or later). When your app is compiled for or runs on previous versions, the first frame of the Graphics Interchange Format (GIF) is shown, but it is not animated.
Starting in Windows 10, version 1703, the Image element supports static Scalable Vector Graphics (SVG) images through SvgImageSource. SvgImageSource supports secure static mode from the SVG specification and does not support animations or interactions. Direct2D supplies the underlying SVG rendering support and for more info on specific SVG element and attribute support, see SVG Support. To learn more about how to insert a SVG in your app, visit the SvgImageSource class page.
Note
Scalable Vector Graphics (SVG) support is available when your app is compiled for Windows 10, version 1703 and running on version 1703 (or later). When your app is compiled for or runs on previous versions, the SVG image will not be shown.
To set the image source file that an Image displays, you set its Source property, either in XAML or in code. Here's a simple example of setting Source in XAML:
<Image Width="200" Source="Images/myimage.png"/>This usage is setting Source by Uniform Resource Identifier (URI), which is a shortcut that's enabled by XAML. Note that the Uniform Resource Identifier (URI) here appears to be a relative Uniform Resource Identifier (URI); supporting partial Uniform Resource Identifier (URI) is another XAML shortcut. The root of this Uniform Resource Identifier (URI) is the base folder for an app project. This is usually the same location that the XAML file containing the Image tag is loaded from. In this example, the image source file is in an Images subfolder within the app's file structure.
Setting the Source property is inherently an asynchronous action. Because it's a property, there isn't an awaitable syntax, but for most scenarios you don't need to interact with the asynchronous aspects of image loading. The framework will wait for the image source to be returned, and will start a layout cycle when the image source file is available and decoded.
Setting the source to a Uniform Resource Identifier (URI) value that can't be resolved to a valid image source file doesn't throw an exception. Instead, it fires an ImageFailed event. You can write an ImageFailed handler and attach it to the Image object, and possibly use the ErrorMessage in event data to determine the nature of the failure. An error in decoding can also fire ImageFailed. If you want to verify that an image source file was loaded correctly, you can handle the ImageOpened event on the Image element.
You typically use image source files that you have included as part of your app download package. For large files, there might be a very small delay while the image source file is decoded, if this is the first time the source is used. For more info on app resources and how to package image source files in an app package, see Defining app resources.
You can also use image source files that aren't part of the app, for example images from external servers. These images are downloaded by an internal HTTP request, and then decoded. If the image source file is a large file, or if there are connection issues, there might be a delay before an external image can be displayed in an Image element.
If you create an Image object using code, call the default constructor, then set the Image.Source property. Setting the Image.Source property requires an instance of the BitmapImage class, which you also must construct. If your image source is a file referenced by Uniform Resource Identifier (URI), use the BitmapImage constructor that takes a Uniform Resource Identifier (URI) parameter. When you reference local content, you must include the ms-appx: scheme in the absolute Uniform Resource Identifier (URI) that you use as the BitmapImage constructor parameter. In code, you don't get the processing shortcuts for combining relative Uniform Resource Identifier (URI) parts and the ms-appx: scheme that happens automatically if you specify Source as a XAML attribute. Instead you must explicitly construct an absolute Uniform Resource Identifier (URI) with the appropriate scheme. You typically use the ms-appx: scheme for an image file that's packaged as part of your app.
Tip
If you're using C# or Microsoft Visual Basic, you can get the BaseUri property of the Image, and pass that as the baseUri parameter for System.Uri constructors that combine a Uniform Resource Identifier (URI) base location and a relative path within that location.
Here's an example of setting Image.Source in C#. In this example, the Image object was created in XAML but doesn't have a source or any other property values; instead these values are provided at run-time when the Image is loaded from XAML.
void Image_Loaded(object sender, RoutedEventArgs e)
{
Image img = sender as Image;
BitmapImage bitmapImage = new BitmapImage();
img.Width = bitmapImage.DecodePixelWidth = 80; //natural px width of image source
// don't need to set Height, system maintains aspect ratio, and calculates the other
// dimension, so long as one dimension measurement is provided
bitmapImage.UriSource = new Uri(img.BaseUri,"Assets/StoreLogo.png");
img.Source = bitmapImage;
}If your image source is a stream, you must write code that sets your Image instance to use the stream. This can't be done in XAML alone. Construct the Image to use, or reference an existing Image instance (which might have been defined in XAML markup, but without a source). Then use the async SetSourceAsync method of BitmapImage to define the image information from a stream, passing the stream to use as the streamSource parameter. Using a stream for an image source is fairly common. For example, if your app enables a user to choose an image file using a FileOpenPicker control, the object you get that represents the file the user chose can be opened as a stream, but doesn't provide a Uniform Resource Identifier (URI) reference to the file.
In this example, the code is already awaitable because it's waiting for the user to choose a file and it only runs after that happens. The stream to use comes from StorageFile.OpenAsync after a StorageFile instance is returned from the async picker actions.
FileOpenPicker open = new FileOpenPicker();
// Open a stream for the selected file
StorageFile file = await open.PickSingleFileAsync();
// Ensure a file was selected
if (file != null)
{
using (IRandomAccessStream fileStream = await file.OpenAsync(Windows.Storage.FileAccessMode.Read))
{
// Set the image source to the selected bitmap
BitmapImage bitmapImage = new BitmapImage();
bitmapImage.DecodePixelWidth = 600; //match the target Image.Width, not shown
await bitmapImage.SetSourceAsync(fileStream);
Scenario2Image.Source = bitmapImage;
}
}Tip
If you're using C# or Microsoft Visual Basic, streams can use the System.IO.Stream type that you may be familiar with from previous Microsoft .NET programming experience. You can call the AsStream extension method as an instance method on any object of type IRandomAccessStream that you've obtained from a Windows Runtime API. The previous example used IRandomAccessStream for parameter passing and didn't need to use AsStream. But if you ever need to manipulate the stream, AsStream is there as a utility to convert to a System.IO.Stream if you need it.
See XAML images sample for more example code.
Large image files can impact performance because they load into memory. If you are referencing an image file where you know that the source file is a large, high resolution image, but your app is displaying it in a UI region that's smaller than the image's natural size, you should set the DecodePixelWidth property, or DecodePixelHeight. The DecodePixel* properties enable you to pass information directly to the format-specific codec, and the codec can use this information to decode more efficiently and to a smaller memory footprint. Set DecodePixelWidth to the same pixel width of the area that you want your app to actually display. In other words, DecodePixelWidth for the BitmapImage source should be the same value as the Width or ActualWidth of the Image control that displays that source.
You can either set DecodePixelWidth, or set DecodePixelHeight. If you set one of these two properties, the system calculates the matching property to maintain the correct aspect ratio. You can also set both properties, but you typically should use values that maintain that aspect ratio. If you want to change aspect ratios there are better ways to do so, for example using a TranslateTransform as a RenderTransform.
To set DecodePixelWidth (or DecodePixelHeight) in XAML, you must use a slightly more verbose XAML syntax that includes an explicit BitmapImage element as a property element value, like this:
<Image>
<Image.Source>
<BitmapImage DecodePixelWidth="200" UriSource="images/myimage.png"/>
</Image.Source>
</Image>
DecodePixelWidth (or DecodePixelHeight) are properties of BitmapImage, so you need an explicit BitmapImage XAML object element in order to set the DecodePixel* properties as attributes in XAML.
If you are creating an Image instance in code, you are probably already creating a BitmapImage instance as a value to provide for the Source property, so just set DecodePixelWidth (or DecodePixelHeight) on the BitmapImage instance before you set the UriSource property. The DecodePixelType property also affects how pixel values are interpreted by the decode operations.
To prevent images from being decoded more than once, assign image source property from Uniform Resource Identifier (URI) rather than using memory streams whenever you can. The XAML framework can associate the same Uniform Resource Identifier (URI) in multiple places with one decoded image, but it cannot do the same for multiple memory streams even if they contain the same data.
You can remove image files from the image cache by setting all associated Image.Source values to null.
For more info on the Image class and performance, see Optimize animations and media.
The underlying codec support for image files is supplied by Windows Imaging Component (WIC) API. For more info on specific image formats as documented for the codecs, see Native WIC Codecs.
The API for Image, BitmapImage and BitmapSource doesn't include any dedicated methods for encoding and decoding of media formats. All of the decoding operations are built-in as actions that happen when the source is set or reset. This makes the classes easier to use for constructing UI, because they have a default set of supported source file formats and decoding behavior. Classes such as BitmapImage expose some of the decoding options and logic as part of event data for ImageOpened or ImageFailed events. If you need advanced image file decoding, or image encoding, you should use the API from the Windows.Graphics.Imaging namespace. You might need these API if your app scenario involves image file format conversions, or manipulation of an image where the user can save the result as a file. The encoding API are also supported by the Windows Imaging Component (WIC) component of Windows.
The Image class inherits the Width and Height properties from FrameworkElement, and these properties potentially control the size that your Image control will render when it displays in UI. If you don't set a Width or a Height, then the width and height is determined by the natural size of the image source. For example, if you load a bitmap image that is 300 pixels high and 400 pixels wide, as recorded in its source file format, these measurements are used for the width and height when the Image control calculates its natural size. You can check ActualHeight and ActualWidth at run time after the image renders to get the measurement information. Or, you can handle ImageOpened and check image file properties such as PixelHeight and PixelWidth immediately before the image renders.
If you set just one of the Width or Height properties but not both, then the system can use that dimension as guidance and calculate the other one, preserving the aspect ratio. If you're not sure of the source file dimensions, pick the dimension that's the most important to control in your layout scenario and let the system calculate the other dimension, and then the layout behavior of the container will typically adapt the layout to fit.
If you don't set Width and/or Height, and leave the image as its natural size, the Stretch property for the image can control how the image source file will fill the space you specify as Width and Height. The default Stretch value is Uniform, which preserves aspect ratio when it fits the image into a layout container. If the container's dimensions don't have the same aspect ratio, then there will be empty space that's still part of Image but isn't showing any image pixels, at least while using the Uniform value for Stretch. UniformToFill for Stretch won't leave empty space but might clip the image if dimensions are different. Fill for Stretch won't leave empty space, but might change the aspect ratio. You can experiment with these values to see what's best for image display in your layout scenario. Also, be aware that certain layout containers might size an image that has no specific Width and Height to fill the entire layout space, in which case you can choose to set specific sizes on either the image or the container for it.
Using the NineGrid technique is another option for sizing images that have a different natural size than your display area, if the image has regions that should not be scaled uniformly. For example you can use a background image that has an inherent border that should only stretch in one dimension, and corners that shouldn't stretch at all, but the image center can stretch to fit the layout requirements in both dimensions. For more info, see NineGrid.
You should create your image sources at several recommended sizes, to ensure that your app looks great when Windows 8 scales it. When specifying a Source for an Image, you can use a naming convention for resources that will use the correct resource for device-specific scaling factors. This is determined by the app automatically at run-time. For specifics of the naming conventions to use and more info, see Quickstart: Using file or image resources.
For more info on how to design images properly for scaling, see UX guidelines for layout and scaling.
Unqualified resources is a technique you can use where the basic resource reference refers to a default resource, and the resource management process can find the equivalent localized resource automatically. You can use automatic handling for accessing unqualified resources with current scale and culture qualifiers, or you can use ResourceManager and ResourceMap with qualifiers for culture and scale to obtain the resources directly. For more info see Resource management system.
If you set FlowDirection as RightToLeft for an Image, the visual content of an Image is flipped horizontally. However, an Image element does not inherit the FlowDirection value from any parent element. Typically you only want image-flipping behavior in images that are relevant to layout, but not necessarily to elements that have embedded text or other components that wouldn't make sense flipped for a right-to-left audience. To get image-flip behavior, you must set the FlowDirection element on the Image element specifically to RightToLeft, or set the FlowDirection property in code-behind. Consider identifying the Image element by x:Uid directive, and specifying FlowDirection values as a Windows Runtime resource, so that your localization experts can change this value later without changing the XAML or code.
The Image class is not a true control class in that it is not a descendant class of Control. You can't call focus to an Image element, or place an Image element in a tab sequence. For more info on the accessibility aspects of using images and the Image element in your UI, see Basic accessibility information.
For Windows 8, resources can use a resource qualifier pattern to load different resources depending on device-specific scaling. However, resources aren't automatically reloaded if the scaling factor changes while the app is running. In this case apps would have to take care of reloading resources, by handling the DpiChanged event (or the deprecated LogicalDpiChanged event) and using ResourceManager API to manually reload the resource that's appropriate for the new scaling factor. Starting with Windows 8.1, any resource that was originally retrieved for your app is automatically re-evaluated if the scaling factor changes while the app is running. In addition, when that resource is the image source for an Image object, then one of the source-load events (ImageOpened or ImageFailed) is fired as a result of the system's action of requesting the new resource and then applying it to the Image. The scenario where a run-time scale change might happen is if the user moves your app to a different monitor when more than one is available.
If you migrate your app code from Windows 8 to Windows 8.1 you may want to account for this behavior change, because it results in ImageOpened or ImageFailed events that happen at run-time when the scale change is handled, even in cases where the Source is set in XAML. Also, if you did have code that handled DpiChanged/LogicalDpiChanged and reset the resources, you should examine whether that code is still needed given the new Windows 8.1 automatic reload behavior.
Apps that were compiled for Windows 8 but running on Windows 8.1 continue to use the Windows 8 behavior.
| Windows version | SDK version | Value added |
|---|---|---|
| 1607 | 14393 | GetAlphaMask |
Tip
For more info, design guidance, and code examples, see Image.
[!div class="nextstepaction"] Open the WinUI 2 Gallery app and see the Image in action
The WinUI 2 Gallery app includes interactive examples of most WinUI 2 controls, features, and functionality. Get the app from the Microsoft Store or get the source code on GitHub.
FrameworkElement, Image and ImageBrush, XAML images sample, Optimize animations and media, BitmapSource, FlowDirection, Windows.Graphics.Imaging, Source, Animated GIF playback (XAML) sample (Windows 10)