Image Image Image Image Class

Definition

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.

public : sealed class Image : FrameworkElement, IImage, IImage2, IImage3
struct winrt::Windows::UI::Xaml::Controls::Image : FrameworkElement, IImage, IImage2, IImage3
public sealed class Image : FrameworkElement, IImage, IImage2, IImage3
Public NotInheritable Class Image Inherits FrameworkElement Implements IImage, IImage2, IImage3
<Image .../>
Inheritance
Attributes
Windows 10 requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

Examples

XAML Controls Gallery
XAML controls gallery

If you have the XAML Controls Gallery app installed, click here to open the app and see the Image in action.

Remarks

Image file formats

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.

Setting Image.Source

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.

Setting Image.Source using code

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,"Images/myimage.png");
}

Using a stream source for an Image source

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.

Image files and performance

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.

Image file encoding and decoding

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.

Image width and height

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.

NineGrid

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.

Resource qualification and localization for Image

Image source files and scaling

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.

Using unqualified resources

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.

FlowDirection for Image

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 and accessibility

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.

Windows 8 behavior

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.

Constructors

Image() Image() Image() Image()

Initializes a new instance of the Image class.

Properties

AccessKey AccessKey AccessKey AccessKey

Gets or sets the access key (mnemonic) for this element.

(Inherited from UIElement)
AccessKeyProperty AccessKeyProperty AccessKeyProperty AccessKeyProperty

Identifies for the AccessKey dependency property.

(Inherited from UIElement)
AccessKeyScopeOwner AccessKeyScopeOwner AccessKeyScopeOwner AccessKeyScopeOwner

Gets or sets a source element that provides the access key scope for this element, even if it's not in the visual tree of the source element.

(Inherited from UIElement)
AccessKeyScopeOwnerProperty AccessKeyScopeOwnerProperty AccessKeyScopeOwnerProperty AccessKeyScopeOwnerProperty

Identifies for the AccessKeyScopeOwner dependency property.

(Inherited from UIElement)
ActualHeight ActualHeight ActualHeight ActualHeight

Gets the rendered height of a FrameworkElement. See Remarks.

(Inherited from FrameworkElement)
ActualHeightProperty ActualHeightProperty ActualHeightProperty ActualHeightProperty

Identifies the ActualHeight dependency property. See Remarks.

(Inherited from FrameworkElement)
ActualTheme ActualTheme ActualTheme ActualTheme

Gets the UI theme that is currently used by the element, which might be different than the RequestedTheme.

(Inherited from FrameworkElement)
ActualThemeProperty ActualThemeProperty ActualThemeProperty ActualThemeProperty

Identifies the ActualTheme dependency property.

(Inherited from FrameworkElement)
ActualWidth ActualWidth ActualWidth ActualWidth

Gets the rendered width of a FrameworkElement. See Remarks.

(Inherited from FrameworkElement)
ActualWidthProperty ActualWidthProperty ActualWidthProperty ActualWidthProperty

Identifies the ActualWidth dependency property. See Remarks.

(Inherited from FrameworkElement)
AllowDrop AllowDrop AllowDrop AllowDrop

Gets or sets a value that determines whether this UIElement can be a drop target for purposes of drag-and-drop operations.

(Inherited from UIElement)
AllowDropProperty AllowDropProperty AllowDropProperty AllowDropProperty

Identifies the AllowDrop dependency property.

(Inherited from UIElement)
AllowFocusOnInteraction AllowFocusOnInteraction AllowFocusOnInteraction AllowFocusOnInteraction

Gets or sets a value that indicates whether the element automatically gets focus when the user interacts with it.

(Inherited from FrameworkElement)
AllowFocusOnInteractionProperty AllowFocusOnInteractionProperty AllowFocusOnInteractionProperty AllowFocusOnInteractionProperty

Identifies for the AllowFocusOnInteraction dependency property.

(Inherited from FrameworkElement)
AllowFocusWhenDisabled AllowFocusWhenDisabled AllowFocusWhenDisabled AllowFocusWhenDisabled

Gets or sets whether a disabled control can receive focus.

(Inherited from FrameworkElement)
AllowFocusWhenDisabledProperty AllowFocusWhenDisabledProperty AllowFocusWhenDisabledProperty AllowFocusWhenDisabledProperty

Identifies the AllowFocusWhenDisabled dependency property.

(Inherited from FrameworkElement)
BaseUri BaseUri BaseUri BaseUri

Gets a Uniform Resource Identifier (URI) that represents the base Uniform Resource Identifier (URI) for an XAML-constructed object at XAML load time. This property is useful for Uniform Resource Identifier (URI) resolution at run time.

(Inherited from FrameworkElement)
BringIntoViewRequestedEvent BringIntoViewRequestedEvent BringIntoViewRequestedEvent BringIntoViewRequestedEvent

Gets the identifier for the BringIntoViewRequested routed event.

(Inherited from UIElement)
CacheMode CacheMode CacheMode CacheMode

Gets or sets a value that indicates that rendered content should be cached as a composited bitmap when possible.

(Inherited from UIElement)
CacheModeProperty CacheModeProperty CacheModeProperty CacheModeProperty

Identifies the CacheMode dependency property.

(Inherited from UIElement)
CanDrag CanDrag CanDrag CanDrag

Gets or sets a value that indicates whether the element can be dragged as data in a drag-and-drop operation.

(Inherited from UIElement)
CanDragProperty CanDragProperty CanDragProperty CanDragProperty

Identifies the CanDrag dependency property.

(Inherited from UIElement)
CharacterReceivedEvent CharacterReceivedEvent CharacterReceivedEvent CharacterReceivedEvent

Gets the identifier for the CharacterReceived routed event.

(Inherited from UIElement)
Clip Clip Clip Clip

Gets or sets the RectangleGeometry used to define the outline of the contents of a UIElement.

(Inherited from UIElement)
ClipProperty ClipProperty ClipProperty ClipProperty

Identifies the Clip dependency property.

(Inherited from UIElement)
CompositeMode CompositeMode CompositeMode CompositeMode

Gets or sets a property that declares alternate composition and blending modes for the element in its parent layout and window. This is relevant for elements that are involved in a mixed XAML / Microsoft DirectX UI.

(Inherited from UIElement)
CompositeModeProperty CompositeModeProperty CompositeModeProperty CompositeModeProperty

Identifies the CompositeMode dependency property.

(Inherited from UIElement)
ContextFlyout ContextFlyout ContextFlyout ContextFlyout

Gets or sets the flyout associated with this element.

(Inherited from UIElement)
ContextFlyoutProperty ContextFlyoutProperty ContextFlyoutProperty ContextFlyoutProperty

Identifies for the ContextFlyout dependency property.

(Inherited from UIElement)
ContextRequestedEvent ContextRequestedEvent ContextRequestedEvent ContextRequestedEvent

Gets the identifier for the ContextRequested routed event.

(Inherited from UIElement)
DataContext DataContext DataContext DataContext

Gets or sets the data context for a FrameworkElement when it participates in data binding.

(Inherited from FrameworkElement)
DataContextProperty DataContextProperty DataContextProperty DataContextProperty

Identifies the DataContext dependency property.

(Inherited from FrameworkElement)
DesiredSize DesiredSize DesiredSize DesiredSize

Gets the size that this UIElement computed during the measure pass of the layout process.

(Inherited from UIElement)
Dispatcher Dispatcher Dispatcher 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)
DoubleTappedEvent DoubleTappedEvent DoubleTappedEvent DoubleTappedEvent

Gets the identifier for the DoubleTapped routed event.

(Inherited from UIElement)
DragEnterEvent DragEnterEvent DragEnterEvent DragEnterEvent

Gets the identifier for the DragEnter routed event.

(Inherited from UIElement)
DragLeaveEvent DragLeaveEvent DragLeaveEvent DragLeaveEvent

Gets the identifier for the DragLeave routed event.

(Inherited from UIElement)
DragOverEvent DragOverEvent DragOverEvent DragOverEvent

Gets the identifier for the DragOver routed event.

(Inherited from UIElement)
DropEvent DropEvent DropEvent DropEvent

Gets the identifier for the Drop routed event.

(Inherited from UIElement)
ExitDisplayModeOnAccessKeyInvoked ExitDisplayModeOnAccessKeyInvoked ExitDisplayModeOnAccessKeyInvoked ExitDisplayModeOnAccessKeyInvoked

Gets or sets a value that specifies whether the access key display is dismissed when an access key is invoked.

(Inherited from UIElement)
ExitDisplayModeOnAccessKeyInvokedProperty ExitDisplayModeOnAccessKeyInvokedProperty ExitDisplayModeOnAccessKeyInvokedProperty ExitDisplayModeOnAccessKeyInvokedProperty

Identifies the ExitDisplayModeOnAccessKeyInvoked dependency property.

(Inherited from UIElement)
FlowDirection FlowDirection FlowDirection FlowDirection

Gets or sets the direction in which text and other UI elements flow within any parent element that controls their layout. This property can be set to either LeftToRight or RightToLeft. Setting FlowDirection to RightToLeft on any element sets the alignment to the right, the reading order to right-to-left and the layout of the control to flow from right to left.

(Inherited from FrameworkElement)
FlowDirectionProperty FlowDirectionProperty FlowDirectionProperty FlowDirectionProperty

Identifies the FlowDirection dependency property.

(Inherited from FrameworkElement)
FocusVisualMargin FocusVisualMargin FocusVisualMargin FocusVisualMargin

Gets or sets the outer margin of the focus visual for a FrameworkElement.

(Inherited from FrameworkElement)
FocusVisualMarginProperty FocusVisualMarginProperty FocusVisualMarginProperty FocusVisualMarginProperty

Identifies the FocusVisualMargin dependency property.

(Inherited from FrameworkElement)
FocusVisualPrimaryBrush FocusVisualPrimaryBrush FocusVisualPrimaryBrush FocusVisualPrimaryBrush

Gets or sets the brush used to draw the outer border of a HighVisibility focus visual for a FrameworkElement.

(Inherited from FrameworkElement)
FocusVisualPrimaryBrushProperty FocusVisualPrimaryBrushProperty FocusVisualPrimaryBrushProperty FocusVisualPrimaryBrushProperty

Identifies the FocusVisualPrimaryBrush dependency property.

(Inherited from FrameworkElement)
FocusVisualPrimaryThickness FocusVisualPrimaryThickness FocusVisualPrimaryThickness FocusVisualPrimaryThickness

Gets or sets the thickness of the outer border of a HighVisibility focus visual for a FrameworkElement.

(Inherited from FrameworkElement)
FocusVisualPrimaryThicknessProperty FocusVisualPrimaryThicknessProperty FocusVisualPrimaryThicknessProperty FocusVisualPrimaryThicknessProperty

Identifies the FocusVisualPrimaryThickness dependency property.

(Inherited from FrameworkElement)
FocusVisualSecondaryBrush FocusVisualSecondaryBrush FocusVisualSecondaryBrush FocusVisualSecondaryBrush

Gets or sets the brush used to draw the inner border of a HighVisibility focus visual for a FrameworkElement.

(Inherited from FrameworkElement)
FocusVisualSecondaryBrushProperty FocusVisualSecondaryBrushProperty FocusVisualSecondaryBrushProperty FocusVisualSecondaryBrushProperty

Identifies the FocusVisualSecondaryBrush dependency property.

(Inherited from FrameworkElement)
FocusVisualSecondaryThickness FocusVisualSecondaryThickness FocusVisualSecondaryThickness FocusVisualSecondaryThickness

Gets or sets the thickness of the inner border of a HighVisibility focus visual for a FrameworkElement.

(Inherited from FrameworkElement)
FocusVisualSecondaryThicknessProperty FocusVisualSecondaryThicknessProperty FocusVisualSecondaryThicknessProperty FocusVisualSecondaryThicknessProperty

Identifies the FocusVisualSecondaryThickness dependency property.

(Inherited from FrameworkElement)
GettingFocusEvent GettingFocusEvent GettingFocusEvent GettingFocusEvent

Gets the identifier for the GettingFocus routed event.

(Inherited from UIElement)
Height Height Height Height

Gets or sets the suggested height of a FrameworkElement.

(Inherited from FrameworkElement)
HeightProperty HeightProperty HeightProperty HeightProperty

Identifies the Height dependency property.

(Inherited from FrameworkElement)
HighContrastAdjustment HighContrastAdjustment HighContrastAdjustment HighContrastAdjustment

Gets or sets a value that indicates whether the framework automatically adjusts the element's visual properties when high contrast themes are enabled.

(Inherited from UIElement)
HighContrastAdjustmentProperty HighContrastAdjustmentProperty HighContrastAdjustmentProperty HighContrastAdjustmentProperty

Identifies the HighContrastAdjustment dependency property.

(Inherited from UIElement)
HoldingEvent HoldingEvent HoldingEvent HoldingEvent

Gets the identifier for the Holding routed event.

(Inherited from UIElement)
HorizontalAlignment HorizontalAlignment HorizontalAlignment HorizontalAlignment

Gets or sets the horizontal alignment characteristics that are applied to a FrameworkElement when it is composed in a layout parent, such as a panel or items control.

(Inherited from FrameworkElement)
HorizontalAlignmentProperty HorizontalAlignmentProperty HorizontalAlignmentProperty HorizontalAlignmentProperty

Identifies the HorizontalAlignment dependency property.

(Inherited from FrameworkElement)
IsAccessKeyScope IsAccessKeyScope IsAccessKeyScope IsAccessKeyScope

Gets or sets a value that indicates whether an element defines its own access key scope.

(Inherited from UIElement)
IsAccessKeyScopeProperty IsAccessKeyScopeProperty IsAccessKeyScopeProperty IsAccessKeyScopeProperty

Identifies for the IsAccessKeyScope dependency property.

(Inherited from UIElement)
IsDoubleTapEnabled IsDoubleTapEnabled IsDoubleTapEnabled IsDoubleTapEnabled

Gets or sets a value that determines whether the DoubleTapped event can originate from that element.

(Inherited from UIElement)
IsDoubleTapEnabledProperty IsDoubleTapEnabledProperty IsDoubleTapEnabledProperty IsDoubleTapEnabledProperty

Identifies the IsDoubleTapEnabled dependency property.

(Inherited from UIElement)
IsHitTestVisible IsHitTestVisible IsHitTestVisible IsHitTestVisible

Gets or sets whether the contained area of this UIElement can return true values for hit testing.

(Inherited from UIElement)
IsHitTestVisibleProperty IsHitTestVisibleProperty IsHitTestVisibleProperty IsHitTestVisibleProperty

Identifies the IsHitTestVisible dependency property.

(Inherited from UIElement)
IsHoldingEnabled IsHoldingEnabled IsHoldingEnabled IsHoldingEnabled

Gets or sets a value that determines whether the Holding event can originate from that element.

(Inherited from UIElement)
IsHoldingEnabledProperty IsHoldingEnabledProperty IsHoldingEnabledProperty IsHoldingEnabledProperty

Identifies the IsHoldingEnabled dependency property.

(Inherited from UIElement)
IsRightTapEnabled IsRightTapEnabled IsRightTapEnabled IsRightTapEnabled

Gets or sets a value that determines whether the RightTapped event can originate from that element.

(Inherited from UIElement)
IsRightTapEnabledProperty IsRightTapEnabledProperty IsRightTapEnabledProperty IsRightTapEnabledProperty

Identifies the IsRightTapEnabled dependency property.

(Inherited from UIElement)
IsTapEnabled IsTapEnabled IsTapEnabled IsTapEnabled

Gets or sets a value that determines whether the Tapped event can originate from that element.

(Inherited from UIElement)
IsTapEnabledProperty IsTapEnabledProperty IsTapEnabledProperty IsTapEnabledProperty

Identifies the IsTapEnabled dependency property.

(Inherited from UIElement)
KeyboardAcceleratorPlacementMode KeyboardAcceleratorPlacementMode KeyboardAcceleratorPlacementMode KeyboardAcceleratorPlacementMode

Gets or sets a value that indicates whether the control tooltip displays the key combination for it's associated keyboard accelerator.

(Inherited from UIElement)
KeyboardAcceleratorPlacementModeProperty KeyboardAcceleratorPlacementModeProperty KeyboardAcceleratorPlacementModeProperty KeyboardAcceleratorPlacementModeProperty

Identifies the KeyboardAcceleratorPlacementMode dependency property.

(Inherited from UIElement)
KeyboardAcceleratorPlacementTarget KeyboardAcceleratorPlacementTarget KeyboardAcceleratorPlacementTarget KeyboardAcceleratorPlacementTarget

Gets or sets a value that indicates the control tooltip that displays the accelerator key combination.

(Inherited from UIElement)
KeyboardAcceleratorPlacementTargetProperty KeyboardAcceleratorPlacementTargetProperty KeyboardAcceleratorPlacementTargetProperty KeyboardAcceleratorPlacementTargetProperty

Identifies the KeyboardAcceleratorPlacementTarget dependency property.

(Inherited from UIElement)
KeyboardAccelerators KeyboardAccelerators KeyboardAccelerators KeyboardAccelerators

Gets the the collection of key combinations that invoke an action using the keyboard.

Accelerators are typically assigned to buttons or menu items.

Example of a menu showing keyboard accelerators for various menu items

Example of a menu showing keyboard accelerators for various menu items

(Inherited from UIElement)
KeyDownEvent KeyDownEvent KeyDownEvent KeyDownEvent

Gets the identifier for the KeyDown routed event.

(Inherited from UIElement)
KeyTipHorizontalOffset KeyTipHorizontalOffset KeyTipHorizontalOffset KeyTipHorizontalOffset

Gets or sets a value that indicates how far left or right the Key Tip is placed in relation to the UIElement.

(Inherited from UIElement)
KeyTipHorizontalOffsetProperty KeyTipHorizontalOffsetProperty KeyTipHorizontalOffsetProperty KeyTipHorizontalOffsetProperty

Identifies the KeyTipHorizontalOffset dependency property.

(Inherited from UIElement)
KeyTipPlacementMode KeyTipPlacementMode KeyTipPlacementMode KeyTipPlacementMode

Gets or sets a value that indicates where the access key Key Tip is placed in relation to the boundary of the UIElement.

(Inherited from UIElement)
KeyTipPlacementModeProperty KeyTipPlacementModeProperty KeyTipPlacementModeProperty KeyTipPlacementModeProperty

Identifies the KeyTipPlacementMode dependency property.

(Inherited from UIElement)
KeyTipTarget KeyTipTarget KeyTipTarget KeyTipTarget

Gets or sets a value that indicates the element targeted by the access key Key Tip.

(Inherited from UIElement)
KeyTipTargetProperty KeyTipTargetProperty KeyTipTargetProperty KeyTipTargetProperty

Identifies the KeyTipTarget dependency property.

(Inherited from UIElement)
KeyTipVerticalOffset KeyTipVerticalOffset KeyTipVerticalOffset KeyTipVerticalOffset

Gets or sets a value that indicates how far up or down the Key Tip is placed in relation to the UI element.

(Inherited from UIElement)
KeyTipVerticalOffsetProperty KeyTipVerticalOffsetProperty KeyTipVerticalOffsetProperty KeyTipVerticalOffsetProperty

Identifies the KeyTipVerticalOffset dependency property.

(Inherited from UIElement)
KeyUpEvent KeyUpEvent KeyUpEvent KeyUpEvent

Gets the identifier for the KeyUp routed event.

(Inherited from UIElement)
Language Language Language Language

Gets or sets localization/globalization language information that applies to a FrameworkElement, and also to all child elements of the current FrameworkElement in the object representation and in UI.

(Inherited from FrameworkElement)
LanguageProperty LanguageProperty LanguageProperty LanguageProperty

Identifies the Language dependency property.

(Inherited from FrameworkElement)
Lights Lights Lights Lights

Gets the collection of XamlLight objects attached to this element.

(Inherited from UIElement)
LightsProperty LightsProperty LightsProperty LightsProperty

Identifies the Lights dependency property.

(Inherited from UIElement)
LosingFocusEvent LosingFocusEvent LosingFocusEvent LosingFocusEvent

Gets the identifier for the LosingFocus routed event.

(Inherited from UIElement)
ManipulationCompletedEvent ManipulationCompletedEvent ManipulationCompletedEvent ManipulationCompletedEvent

Gets the identifier for the ManipulationCompleted routed event.

(Inherited from UIElement)
ManipulationDeltaEvent ManipulationDeltaEvent ManipulationDeltaEvent ManipulationDeltaEvent

Gets the identifier for the ManipulationDelta routed event.

(Inherited from UIElement)
ManipulationInertiaStartingEvent ManipulationInertiaStartingEvent ManipulationInertiaStartingEvent ManipulationInertiaStartingEvent

Gets the identifier for the ManipulationInertiaStarting routed event.

(Inherited from UIElement)
ManipulationMode ManipulationMode ManipulationMode ManipulationMode

Gets or sets the ManipulationModes value used for UIElement behavior and interaction with gestures. Setting this value enables handling the manipulation events from this element in app code.

(Inherited from UIElement)
ManipulationModeProperty ManipulationModeProperty ManipulationModeProperty ManipulationModeProperty

Identifies the ManipulationMode dependency property.

(Inherited from UIElement)
ManipulationStartedEvent ManipulationStartedEvent ManipulationStartedEvent ManipulationStartedEvent

Gets the identifier for the ManipulationStarted routed event.

(Inherited from UIElement)
ManipulationStartingEvent ManipulationStartingEvent ManipulationStartingEvent ManipulationStartingEvent

Gets the identifier for the ManipulationStarting routed event.

(Inherited from UIElement)
Margin Margin Margin Margin

Gets or sets the outer margin of a FrameworkElement.

(Inherited from FrameworkElement)
MarginProperty MarginProperty MarginProperty MarginProperty

Identifies the Margin dependency property.

(Inherited from FrameworkElement)
MaxHeight MaxHeight MaxHeight MaxHeight

Gets or sets the maximum height constraint of a FrameworkElement.

(Inherited from FrameworkElement)
MaxHeightProperty MaxHeightProperty MaxHeightProperty MaxHeightProperty

Identifies the MaxHeight dependency property.

(Inherited from FrameworkElement)
MaxWidth MaxWidth MaxWidth MaxWidth

Gets or sets the maximum width constraint of a FrameworkElement.

(Inherited from FrameworkElement)
MaxWidthProperty MaxWidthProperty MaxWidthProperty MaxWidthProperty

Identifies the MaxWidth dependency property.

(Inherited from FrameworkElement)
MinHeight MinHeight MinHeight MinHeight

Gets or sets the minimum height constraint of a FrameworkElement.

(Inherited from FrameworkElement)
MinHeightProperty MinHeightProperty MinHeightProperty MinHeightProperty

Identifies the MinHeight dependency property.

(Inherited from FrameworkElement)
MinWidth MinWidth MinWidth MinWidth

Gets or sets the minimum width constraint of a FrameworkElement.

(Inherited from FrameworkElement)
MinWidthProperty MinWidthProperty MinWidthProperty MinWidthProperty

Identifies the MinWidth dependency property.

(Inherited from FrameworkElement)
Name Name Name Name

Gets or sets the identifying name of the object. When a XAML processor creates the object tree from XAML markup, run-time code can refer to the XAML-declared object by this name.

(Inherited from FrameworkElement)
NameProperty NameProperty NameProperty NameProperty

Identifies the Name dependency property.

(Inherited from FrameworkElement)
NineGrid NineGrid NineGrid NineGrid

Gets or sets a value for a nine-grid metaphor that controls how the image can be resized. The nine-grid metaphor enables you to stretch edges and corners of an image differently than its center. See Remarks for more info and an illustration.

NineGridProperty NineGridProperty NineGridProperty NineGridProperty

Identifies the NineGrid dependency property.

NoFocusCandidateFoundEvent NoFocusCandidateFoundEvent NoFocusCandidateFoundEvent NoFocusCandidateFoundEvent

Gets the identifier for the NoFocusCandidateFound routed event.

(Inherited from UIElement)
Opacity Opacity Opacity Opacity

Gets or sets the degree of the object's opacity.

(Inherited from UIElement)
OpacityProperty OpacityProperty OpacityProperty OpacityProperty

Identifies the IsHitTestVisible dependency property.

(Inherited from UIElement)
Parent Parent Parent Parent

Gets the parent object of this FrameworkElement in the object tree.

(Inherited from FrameworkElement)
PlayToSource PlayToSource PlayToSource PlayToSource

Gets the information that is transmitted if the Image is used for a Play To scenario.

PlayToSourceProperty PlayToSourceProperty PlayToSourceProperty PlayToSourceProperty

Identifies the PlayToSource dependency property.

PointerCanceledEvent PointerCanceledEvent PointerCanceledEvent PointerCanceledEvent

Gets the identifier for the PointerCanceled routed event.

(Inherited from UIElement)
PointerCaptureLostEvent PointerCaptureLostEvent PointerCaptureLostEvent PointerCaptureLostEvent

Gets the identifier for the PointerCaptureLost routed event.

(Inherited from UIElement)
PointerCaptures PointerCaptures PointerCaptures PointerCaptures

Gets the set of all captured pointers, represented as Pointer values.

(Inherited from UIElement)
PointerCapturesProperty PointerCapturesProperty PointerCapturesProperty PointerCapturesProperty

Identifies the PointerCaptures dependency property.

(Inherited from UIElement)
PointerEnteredEvent PointerEnteredEvent PointerEnteredEvent PointerEnteredEvent

Gets the identifier for the PointerEntered routed event.

(Inherited from UIElement)
PointerExitedEvent PointerExitedEvent PointerExitedEvent PointerExitedEvent

Gets the identifier for the PointerExited routed event.

(Inherited from UIElement)
PointerMovedEvent PointerMovedEvent PointerMovedEvent PointerMovedEvent

Gets the identifier for the PointerMoved routed event.

(Inherited from UIElement)
PointerPressedEvent PointerPressedEvent PointerPressedEvent PointerPressedEvent

Gets the identifier for the PointerPressed routed event.

(Inherited from UIElement)
PointerReleasedEvent PointerReleasedEvent PointerReleasedEvent PointerReleasedEvent

Gets the identifier for the PointerReleased routed event.

(Inherited from UIElement)
PointerWheelChangedEvent PointerWheelChangedEvent PointerWheelChangedEvent PointerWheelChangedEvent

Gets the identifier for the PointerWheelChanged routed event.

(Inherited from UIElement)
PreviewKeyDownEvent PreviewKeyDownEvent PreviewKeyDownEvent PreviewKeyDownEvent

Gets the identifier for the PreviewKeyDown routed event.

(Inherited from UIElement)
PreviewKeyUpEvent PreviewKeyUpEvent PreviewKeyUpEvent PreviewKeyUpEvent

Gets the identifier for the PreviewKeyUp routed event.

(Inherited from UIElement)
Projection Projection Projection Projection

Gets or sets the perspective projection (3-D effect) to apply when rendering this element.

(Inherited from UIElement)
ProjectionProperty ProjectionProperty ProjectionProperty ProjectionProperty

Identifies the Projection dependency property.

(Inherited from UIElement)
RenderSize RenderSize RenderSize RenderSize

Gets the final render size of a UIElement. Use is not recommended, see Remarks.

(Inherited from UIElement)
RenderTransform RenderTransform RenderTransform RenderTransform

Gets or sets transform information that affects the rendering position of a UIElement.

(Inherited from UIElement)
RenderTransformOrigin RenderTransformOrigin RenderTransformOrigin RenderTransformOrigin

Gets or sets the origin point of any possible render transform declared by RenderTransform, relative to the bounds of the UIElement.

(Inherited from UIElement)
RenderTransformOriginProperty RenderTransformOriginProperty RenderTransformOriginProperty RenderTransformOriginProperty

Identifies the RenderTransformOrigin dependency property.

(Inherited from UIElement)
RenderTransformProperty RenderTransformProperty RenderTransformProperty RenderTransformProperty

Identifies the RenderTransform dependency property.

(Inherited from UIElement)
RequestedTheme RequestedTheme RequestedTheme RequestedTheme

Gets or sets the UI theme that is used by the UIElement (and its child elements) for resource determination. The UI theme you specify with RequestedTheme can override the app-level RequestedTheme.

(Inherited from FrameworkElement)
RequestedThemeProperty RequestedThemeProperty RequestedThemeProperty RequestedThemeProperty

Identifies the RequestedTheme dependency property.

(Inherited from FrameworkElement)
Resources Resources Resources Resources

Gets the locally defined resource dictionary. In XAML, you can establish resource items as child object elements of a frameworkElement.Resources property element, through XAML implicit collection syntax.

(Inherited from FrameworkElement)
RightTappedEvent RightTappedEvent RightTappedEvent RightTappedEvent

Gets the identifier for the RightTapped routed event.

(Inherited from UIElement)
Source Source Source Source

Gets or sets the source for the image.

SourceProperty SourceProperty SourceProperty SourceProperty

Identifies the Source dependency property.

Stretch Stretch Stretch Stretch

Gets or sets a value that describes how an Image should be stretched to fill the destination rectangle.

StretchProperty StretchProperty StretchProperty StretchProperty

Identifies the Stretch dependency property.

Style Style Style Style

Gets or sets an instance Style that is applied for this object during layout and rendering.

(Inherited from FrameworkElement)
StyleProperty StyleProperty StyleProperty StyleProperty

Identifies the Style dependency property.

(Inherited from FrameworkElement)
TabFocusNavigation TabFocusNavigation TabFocusNavigation TabFocusNavigation

Gets or sets a value that modifies how tabbing and TabIndex work for this control.

Note

For Windows 10 Creators Update (build 10.0.15063) and newer, use this property of the UIElement base class instead of the TabNavigation property of a Control object.

(Inherited from UIElement)
TabFocusNavigationProperty TabFocusNavigationProperty TabFocusNavigationProperty TabFocusNavigationProperty

Identifies the TabFocusNavigation dependency property.

(Inherited from UIElement)
Tag Tag Tag Tag

Gets or sets an arbitrary object value that can be used to store custom information about this object.

(Inherited from FrameworkElement)
TagProperty TagProperty TagProperty TagProperty

Identifies the Tag dependency property.

(Inherited from FrameworkElement)
TappedEvent TappedEvent TappedEvent TappedEvent

Gets the identifier for the Tapped routed event.

(Inherited from UIElement)
Transform3D Transform3D Transform3D Transform3D

Gets or sets the 3-D transform effect to apply when rendering this element.

(Inherited from UIElement)
Transform3DProperty Transform3DProperty Transform3DProperty Transform3DProperty

Identifies the Transform3D dependency property.

(Inherited from UIElement)
Transitions Transitions Transitions Transitions

Gets or sets the collection of Transition style elements that apply to a UIElement.

(Inherited from UIElement)
TransitionsProperty TransitionsProperty TransitionsProperty TransitionsProperty

Identifies the Transitions dependency property.

(Inherited from UIElement)
Triggers Triggers Triggers Triggers

Gets the collection of triggers for animations that are defined for a FrameworkElement. Not commonly used. See Remarks.

(Inherited from FrameworkElement)
UseLayoutRounding UseLayoutRounding UseLayoutRounding UseLayoutRounding

Gets or sets a value that determines whether rendering for the object and its visual subtree should use rounding behavior that aligns rendering to whole pixels.

(Inherited from UIElement)
UseLayoutRoundingProperty UseLayoutRoundingProperty UseLayoutRoundingProperty UseLayoutRoundingProperty

Identifies the UseLayoutRounding dependency property.

(Inherited from UIElement)
VerticalAlignment VerticalAlignment VerticalAlignment VerticalAlignment

Gets or sets the vertical alignment characteristics that are applied to a FrameworkElement when it is composed in a parent object such as a panel or items control.

(Inherited from FrameworkElement)
VerticalAlignmentProperty VerticalAlignmentProperty VerticalAlignmentProperty VerticalAlignmentProperty

Identifies the VerticalAlignment dependency property.

(Inherited from FrameworkElement)
Visibility Visibility Visibility Visibility

Gets or sets the visibility of a UIElement. A UIElement that is not visible is not rendered and does not communicate its desired size to layout.

(Inherited from UIElement)
VisibilityProperty VisibilityProperty VisibilityProperty VisibilityProperty

Identifies the Visibility dependency property.

(Inherited from UIElement)
Width Width Width Width

Gets or sets the width of a FrameworkElement.

(Inherited from FrameworkElement)
WidthProperty WidthProperty WidthProperty WidthProperty

Identifies the Width dependency property.

(Inherited from FrameworkElement)
XYFocusDownNavigationStrategy XYFocusDownNavigationStrategy XYFocusDownNavigationStrategy XYFocusDownNavigationStrategy

Gets or sets a value that specifies the strategy used to determine the target element of a down navigation.

(Inherited from UIElement)
XYFocusDownNavigationStrategyProperty XYFocusDownNavigationStrategyProperty XYFocusDownNavigationStrategyProperty XYFocusDownNavigationStrategyProperty

Identifies the XYFocusDownNavigationStrategy dependency property.

(Inherited from UIElement)
XYFocusKeyboardNavigation XYFocusKeyboardNavigation XYFocusKeyboardNavigation XYFocusKeyboardNavigation

Gets or sets a value that enables or disables navigation using the keyboard directional arrows.

(Inherited from UIElement)
XYFocusKeyboardNavigationProperty XYFocusKeyboardNavigationProperty XYFocusKeyboardNavigationProperty XYFocusKeyboardNavigationProperty

Identifies the XYFocusKeyboardNavigation dependency property.

(Inherited from UIElement)
XYFocusLeftNavigationStrategy XYFocusLeftNavigationStrategy XYFocusLeftNavigationStrategy XYFocusLeftNavigationStrategy

Gets or sets a value that specifies the strategy used to determine the target element of a left navigation.

(Inherited from UIElement)
XYFocusLeftNavigationStrategyProperty XYFocusLeftNavigationStrategyProperty XYFocusLeftNavigationStrategyProperty XYFocusLeftNavigationStrategyProperty

Identifies the XYFocusLeftNavigationStrategy dependency property.

(Inherited from UIElement)
XYFocusRightNavigationStrategy XYFocusRightNavigationStrategy XYFocusRightNavigationStrategy XYFocusRightNavigationStrategy

Gets or sets a value that specifies the strategy used to determine the target element of a right navigation.

(Inherited from UIElement)
XYFocusRightNavigationStrategyProperty XYFocusRightNavigationStrategyProperty XYFocusRightNavigationStrategyProperty XYFocusRightNavigationStrategyProperty

Identifies the XYFocusRightNavigationStrategy dependency property.

(Inherited from UIElement)
XYFocusUpNavigationStrategy XYFocusUpNavigationStrategy XYFocusUpNavigationStrategy XYFocusUpNavigationStrategy

Gets or sets a value that specifies the strategy used to determine the target element of an up navigation.

(Inherited from UIElement)
XYFocusUpNavigationStrategyProperty XYFocusUpNavigationStrategyProperty XYFocusUpNavigationStrategyProperty XYFocusUpNavigationStrategyProperty

Identifies the XYFocusUpNavigationStrategy dependency property.

(Inherited from UIElement)

Methods

AddHandler(RoutedEvent,Object,Boolean) AddHandler(RoutedEvent,Object,Boolean) AddHandler(RoutedEvent,Object,Boolean) AddHandler(RoutedEvent,Object,Boolean)

Adds a routed event handler for a specified routed event, adding the handler to the handler collection on the current element. Specify handledEventsToo as true to have the provided handler be invoked even if the event is handled elsewhere.

(Inherited from UIElement)
Arrange(Rect) Arrange(Rect) Arrange(Rect) Arrange(Rect)

Positions child objects and determines a size for a UIElement. Parent objects that implement custom layout for their child elements should call this method from their layout override implementations to form a recursive layout update.

(Inherited from UIElement)
ArrangeOverride(Size) ArrangeOverride(Size) ArrangeOverride(Size) ArrangeOverride(Size)

Provides the behavior for the "Arrange" pass of layout. Classes can override this method to define their own "Arrange" pass behavior.

(Inherited from FrameworkElement)
CancelDirectManipulations CancelDirectManipulations CancelDirectManipulations CancelDirectManipulations

Cancels ongoing direct manipulation processing (system-defined panning/zooming) on any ScrollViewer parent that contains the current UIElement.

(Inherited from UIElement)
CapturePointer(Pointer) CapturePointer(Pointer) CapturePointer(Pointer) CapturePointer(Pointer)

Sets pointer capture to a UIElement. Once captured, only the element that has capture will fire pointer-related events.

(Inherited from UIElement)
ClearValue(DependencyProperty) ClearValue(DependencyProperty) ClearValue(DependencyProperty) ClearValue(DependencyProperty)

Clears the local value of a dependency property.

(Inherited from DependencyObject)
DeferTree(DependencyObject) DeferTree(DependencyObject) DeferTree(DependencyObject) DeferTree(DependencyObject)

Removes the specified element from the XAML visual tree in a way that it can be undeferred later.

(Inherited from FrameworkElement)
FindName(String) FindName(String) FindName(String) FindName(String)

Retrieves an object that has the specified identifier name.

(Inherited from FrameworkElement)
FindSubElementsForTouchTargeting(Point,Rect) FindSubElementsForTouchTargeting(Point,Rect) FindSubElementsForTouchTargeting(Point,Rect) FindSubElementsForTouchTargeting(Point,Rect)

Enables a UIElement subclass to expose child elements that assist with resolving touch targeting.

(Inherited from UIElement)
GetAlphaMask() GetAlphaMask() GetAlphaMask() GetAlphaMask()

Returns a mask that represents the alpha channel of an image as a CompositionBrush.

GetAnimationBaseValue(DependencyProperty) GetAnimationBaseValue(DependencyProperty) GetAnimationBaseValue(DependencyProperty) 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)
GetAsCastingSource() GetAsCastingSource() GetAsCastingSource() GetAsCastingSource()

Returns the image as a CastingSource.

GetBindingExpression(DependencyProperty) GetBindingExpression(DependencyProperty) GetBindingExpression(DependencyProperty) GetBindingExpression(DependencyProperty)

Returns the BindingExpression that represents the binding on the specified property.

(Inherited from FrameworkElement)
GetChildrenInTabFocusOrder GetChildrenInTabFocusOrder GetChildrenInTabFocusOrder GetChildrenInTabFocusOrder

Enables a UIElement subclass to expose child elements that take part in Tab focus.

(Inherited from UIElement)
GetValue(DependencyProperty) GetValue(DependencyProperty) GetValue(DependencyProperty) GetValue(DependencyProperty)

Returns the current effective value of a dependency property from a DependencyObject.

(Inherited from DependencyObject)
GoToElementStateCore(String,Boolean) GoToElementStateCore(String,Boolean) GoToElementStateCore(String,Boolean) GoToElementStateCore(String,Boolean)

When implemented in a derived class, enables per-state construction of a visual tree for a control template in code, rather than by loading XAML for all states at control startup.

(Inherited from FrameworkElement)
InvalidateArrange InvalidateArrange InvalidateArrange InvalidateArrange

Invalidates the arrange state (layout) for a UIElement. After the invalidation, the UIElement will have its layout updated, which will occur asynchronously.

(Inherited from UIElement)
InvalidateMeasure InvalidateMeasure InvalidateMeasure InvalidateMeasure

Invalidates the measurement state (layout) for a UIElement.

(Inherited from UIElement)
Measure(Size) Measure(Size) Measure(Size) Measure(Size)

Updates the DesiredSize of a UIElement. Typically, objects that implement custom layout for their layout children call this method from their own MeasureOverride implementations to form a recursive layout update.

(Inherited from UIElement)
MeasureOverride(Size) MeasureOverride(Size) MeasureOverride(Size) MeasureOverride(Size)

Provides the behavior for the "Measure" pass of the layout cycle. Classes can override this method to define their own "Measure" pass behavior.

(Inherited from FrameworkElement)
OnApplyTemplate OnApplyTemplate OnApplyTemplate OnApplyTemplate

Invoked whenever application code or internal processes (such as a rebuilding layout pass) call ApplyTemplate. In simplest terms, this means the method is called just before a UI element displays in your app. Override this method to influence the default post-template logic of a class.

(Inherited from FrameworkElement)
OnBringIntoViewRequested(BringIntoViewRequestedEventArgs) OnBringIntoViewRequested(BringIntoViewRequestedEventArgs) OnBringIntoViewRequested(BringIntoViewRequestedEventArgs) OnBringIntoViewRequested(BringIntoViewRequestedEventArgs)

Called before the BringIntoViewRequested event occurs.

(Inherited from UIElement)
OnCreateAutomationPeer OnCreateAutomationPeer OnCreateAutomationPeer OnCreateAutomationPeer

When implemented in a derived class, returns class-specific AutomationPeer implementations for the Microsoft UI Automation infrastructure.

(Inherited from UIElement)
OnDisconnectVisualChildren OnDisconnectVisualChildren OnDisconnectVisualChildren OnDisconnectVisualChildren

Override this method to implement how layout and logic should behave when items are removed from a class-specific content or children property.

(Inherited from UIElement)
OnKeyboardAcceleratorInvoked(KeyboardAcceleratorInvokedEventArgs) OnKeyboardAcceleratorInvoked(KeyboardAcceleratorInvokedEventArgs) OnKeyboardAcceleratorInvoked(KeyboardAcceleratorInvokedEventArgs) OnKeyboardAcceleratorInvoked(KeyboardAcceleratorInvokedEventArgs)

Called when a keyboard shortcut (or accelerator) is processed in your app. Override this method to handle how your app responds when a keyboard accelerator is invoked.

(Inherited from UIElement)
OnProcessKeyboardAccelerators(ProcessKeyboardAcceleratorEventArgs) OnProcessKeyboardAccelerators(ProcessKeyboardAcceleratorEventArgs) OnProcessKeyboardAccelerators(ProcessKeyboardAcceleratorEventArgs) OnProcessKeyboardAccelerators(ProcessKeyboardAcceleratorEventArgs)

Called just before a keyboard shortcut (or accelerator) is processed in your app. Invoked whenever application code or internal processes call ProcessKeyboardAccelerators. Override this method to influence the default accelerator handling.

(Inherited from UIElement)
ReadLocalValue(DependencyProperty) ReadLocalValue(DependencyProperty) ReadLocalValue(DependencyProperty) ReadLocalValue(DependencyProperty)

Returns the local value of a dependency property, if a local value is set.

(Inherited from DependencyObject)
RegisterAsScrollPort(UIElement) RegisterAsScrollPort(UIElement) RegisterAsScrollPort(UIElement) RegisterAsScrollPort(UIElement)

Registers an element as representing a scrollable viewport.

(Inherited from UIElement)
RegisterPropertyChangedCallback(DependencyProperty,DependencyPropertyChangedCallback) RegisterPropertyChangedCallback(DependencyProperty,DependencyPropertyChangedCallback) RegisterPropertyChangedCallback(DependencyProperty,DependencyPropertyChangedCallback) RegisterPropertyChangedCallback(DependencyProperty,DependencyPropertyChangedCallback)

Registers a notification function for listening to changes to a specific DependencyProperty on this DependencyObject instance.

(Inherited from DependencyObject)
ReleasePointerCapture(Pointer) ReleasePointerCapture(Pointer) ReleasePointerCapture(Pointer) ReleasePointerCapture(Pointer)

Releases pointer captures for capture of one specific pointer by this UIElement.

(Inherited from UIElement)
ReleasePointerCaptures ReleasePointerCaptures ReleasePointerCaptures ReleasePointerCaptures

Releases all pointer captures held by this element.

(Inherited from UIElement)
RemoveHandler(RoutedEvent,Object) RemoveHandler(RoutedEvent,Object) RemoveHandler(RoutedEvent,Object) RemoveHandler(RoutedEvent,Object)

Removes the specified routed event handler from this UIElement. Typically the handler in question was added by AddHandler.

(Inherited from UIElement)
SetBinding(DependencyProperty,BindingBase) SetBinding(DependencyProperty,BindingBase) SetBinding(DependencyProperty,BindingBase) SetBinding(DependencyProperty,BindingBase)

Attaches a binding to a FrameworkElement, using the provided binding object

.

(Inherited from FrameworkElement)
SetValue(DependencyProperty,Object) SetValue(DependencyProperty,Object) SetValue(DependencyProperty,Object) SetValue(DependencyProperty,Object)

Sets the local value of a dependency property on a DependencyObject.

(Inherited from DependencyObject)
StartBringIntoView StartBringIntoView StartBringIntoView StartBringIntoView

Initiates a request to the XAML framework to bring the element into view within any scrollable regions it is contained within.

(Inherited from UIElement)
StartBringIntoView(BringIntoViewOptions) StartBringIntoView(BringIntoViewOptions) StartBringIntoView(BringIntoViewOptions) StartBringIntoView(BringIntoViewOptions)

Initiates a request to the XAML framework to bring the element into view using the specified options.

(Inherited from UIElement)
StartDragAsync(PointerPoint) StartDragAsync(PointerPoint) StartDragAsync(PointerPoint) StartDragAsync(PointerPoint)

Initiates a drag-and-drop operation.

(Inherited from UIElement)
TransformToVisual(UIElement) TransformToVisual(UIElement) TransformToVisual(UIElement) TransformToVisual(UIElement)

Returns a transform object that can be used to transform coordinates from the UIElement to the specified object.

(Inherited from UIElement)
TryInvokeKeyboardAccelerator(ProcessKeyboardAcceleratorEventArgs) TryInvokeKeyboardAccelerator(ProcessKeyboardAcceleratorEventArgs) TryInvokeKeyboardAccelerator(ProcessKeyboardAcceleratorEventArgs) TryInvokeKeyboardAccelerator(ProcessKeyboardAcceleratorEventArgs)

Attempts to invoke a keyboard shortcut (or accelerator) by searching the entire visual tree of the UIElement for the shortcut.

(Inherited from UIElement)
TryStartDirectManipulation(Pointer) TryStartDirectManipulation(Pointer) TryStartDirectManipulation(Pointer) TryStartDirectManipulation(Pointer)

Resumes direct manipulation processing (system-defined panning/zooming) on any ScrollViewer parent that contains the current UIElement.

(Inherited from UIElement)
UnregisterPropertyChangedCallback(DependencyProperty,Int64) UnregisterPropertyChangedCallback(DependencyProperty,Int64) UnregisterPropertyChangedCallback(DependencyProperty,Int64) UnregisterPropertyChangedCallback(DependencyProperty,Int64)

Cancels a change notification that was previously registered by calling RegisterPropertyChangedCallback.

(Inherited from DependencyObject)
UpdateLayout UpdateLayout UpdateLayout UpdateLayout

Ensures that all positions of child objects of a UIElement are properly updated for layout.

(Inherited from UIElement)

Events

AccessKeyDisplayDismissed AccessKeyDisplayDismissed AccessKeyDisplayDismissed AccessKeyDisplayDismissed

Occurs when the access key sequence is complete to notify controls that they should hide access key visuals.

(Inherited from UIElement)
AccessKeyDisplayRequested AccessKeyDisplayRequested AccessKeyDisplayRequested AccessKeyDisplayRequested

Occurs when the access key sequence is started to notify controls that they should show access key visuals.

(Inherited from UIElement)
AccessKeyInvoked AccessKeyInvoked AccessKeyInvoked AccessKeyInvoked

Occurs when a user completes an access key sequence to notify the element that the access key action should be invoked.

(Inherited from UIElement)
ActualThemeChanged ActualThemeChanged ActualThemeChanged ActualThemeChanged

Occurs when the ActualTheme property value has changed.

(Inherited from FrameworkElement)
BringIntoViewRequested BringIntoViewRequested BringIntoViewRequested BringIntoViewRequested

Occurs when StartBringIntoView is called on this element or one of its descendants.

(Inherited from UIElement)
CharacterReceived CharacterReceived CharacterReceived CharacterReceived

Occurs when a single, composed character is received by the input queue.

(Inherited from UIElement)
ContextCanceled ContextCanceled ContextCanceled ContextCanceled

Occurs when a context input gesture continues into a manipulation gesture, to notify the element that the context flyout should not be opened.

(Inherited from UIElement)
ContextRequested ContextRequested ContextRequested ContextRequested

Occurs when the user has completed a context input gesture, such as a right-click.

(Inherited from UIElement)
DataContextChanged DataContextChanged DataContextChanged DataContextChanged

Occurs when the value of the FrameworkElement.DataContext property changes.

(Inherited from FrameworkElement)
DoubleTapped DoubleTapped DoubleTapped DoubleTapped

Occurs when an otherwise unhandled DoubleTap interaction occurs over the hit test area of this element.

(Inherited from UIElement)
DragEnter DragEnter DragEnter DragEnter

Occurs when the input system reports an underlying drag event with this element as the target.

(Inherited from UIElement)
DragLeave DragLeave DragLeave DragLeave

Occurs when the input system reports an underlying drag event with this element as the origin.

(Inherited from UIElement)
DragOver DragOver DragOver DragOver

Occurs when the input system reports an underlying drag event with this element as the potential drop target.

(Inherited from UIElement)
DragStarting DragStarting DragStarting DragStarting

Occurs when a drag operation is initiated.

(Inherited from UIElement)
Drop Drop Drop Drop

Occurs when the input system reports an underlying drop event with this element as the drop target.

(Inherited from UIElement)
DropCompleted DropCompleted DropCompleted DropCompleted

Occurs when a drag-and-drop operation is ended.

(Inherited from UIElement)
GettingFocus GettingFocus GettingFocus GettingFocus

Occurs before a UIElement receives focus.

(Inherited from UIElement)
GotFocus GotFocus GotFocus GotFocus

Occurs when a UIElement receives focus.

(Inherited from UIElement)
Holding Holding Holding Holding

Occurs when an otherwise unhandled Hold interaction occurs over the hit test area of this element.

(Inherited from UIElement)
ImageFailed ImageFailed ImageFailed ImageFailed

Occurs when there is an error associated with image retrieval or format.

ImageOpened ImageOpened ImageOpened ImageOpened

Occurs when the image source is downloaded and decoded with no failure. You can use this event to determine the natural size of the image source.

KeyDown KeyDown KeyDown KeyDown

Occurs when a keyboard key is pressed while the UIElement has focus.

(Inherited from UIElement)
KeyUp KeyUp KeyUp KeyUp

Occurs when a keyboard key is released while the UIElement has focus.

(Inherited from UIElement)
LayoutUpdated LayoutUpdated LayoutUpdated LayoutUpdated

Occurs when the layout of the visual tree changes, due to layout-relevant properties changing value or some other action that refreshes the layout.

(Inherited from FrameworkElement)
Loaded Loaded Loaded Loaded

Occurs when a FrameworkElement has been constructed and added to the object tree, and is ready for interaction.

(Inherited from FrameworkElement)
Loading Loading Loading Loading

Occurs when a FrameworkElement begins to load.

(Inherited from FrameworkElement)
LosingFocus LosingFocus LosingFocus LosingFocus

Occurs before a UIElement loses focus.

(Inherited from UIElement)
LostFocus LostFocus LostFocus LostFocus

Occurs when a UIElement loses focus.

(Inherited from UIElement)
ManipulationCompleted ManipulationCompleted ManipulationCompleted ManipulationCompleted

Occurs when a manipulation on the UIElement is complete.

(Inherited from UIElement)
ManipulationDelta ManipulationDelta ManipulationDelta ManipulationDelta

Occurs when the input device changes position during a manipulation.

(Inherited from UIElement)
ManipulationInertiaStarting ManipulationInertiaStarting ManipulationInertiaStarting ManipulationInertiaStarting

Occurs when the input device loses contact with the UIElement object during a manipulation and inertia begins.

(Inherited from UIElement)
ManipulationStarted ManipulationStarted ManipulationStarted ManipulationStarted

Occurs when an input device begins a manipulation on the UIElement.

(Inherited from UIElement)
ManipulationStarting ManipulationStarting ManipulationStarting ManipulationStarting

Occurs when the manipulation processor is first created.

(Inherited from UIElement)
NoFocusCandidateFound NoFocusCandidateFound NoFocusCandidateFound NoFocusCandidateFound

Occurs when a user attempts to move focus (via tab or directional arrows), but focus doesn't move because no focus candidate is found in the direction of movement.

(Inherited from UIElement)
PointerCanceled PointerCanceled PointerCanceled PointerCanceled

Occurs when a pointer that made contact abnormally loses contact.

(Inherited from UIElement)
PointerCaptureLost PointerCaptureLost PointerCaptureLost PointerCaptureLost

Occurs when pointer capture previously held by this element moves to another element or elsewhere.

(Inherited from UIElement)
PointerEntered PointerEntered PointerEntered PointerEntered

Occurs when a pointer enters the hit test area of this element.

(Inherited from UIElement)
PointerExited PointerExited PointerExited PointerExited

Occurs when a pointer leaves the hit test area of this element.

(Inherited from UIElement)
PointerMoved PointerMoved PointerMoved PointerMoved

Occurs when a pointer moves while the pointer remains within the hit test area of this element.

(Inherited from UIElement)
PointerPressed PointerPressed PointerPressed PointerPressed

Occurs when the pointer device initiates a Press action within this element.

(Inherited from UIElement)
PointerReleased PointerReleased PointerReleased PointerReleased

Occurs when the pointer device that previously initiated a Press action is released, while within this element. Note that the end of a Press action is not guaranteed to fire a PointerReleased event; other events may fire instead. For more info, see Remarks.

(Inherited from UIElement)
PointerWheelChanged PointerWheelChanged PointerWheelChanged PointerWheelChanged

Occurs when the delta value of a pointer wheel changes.

(Inherited from UIElement)
PreviewKeyDown PreviewKeyDown PreviewKeyDown PreviewKeyDown

Occurs when a keyboard key is pressed while the UIElement has focus.

(Inherited from UIElement)
PreviewKeyUp PreviewKeyUp PreviewKeyUp PreviewKeyUp

Occurs when a keyboard key is released while the UIElement has focus.

(Inherited from UIElement)
ProcessKeyboardAccelerators ProcessKeyboardAccelerators ProcessKeyboardAccelerators ProcessKeyboardAccelerators

Occurs when a keyboard shortcut (or accelerator) is pressed.

(Inherited from UIElement)
RightTapped RightTapped RightTapped RightTapped

Occurs when a right-tap input stimulus happens while the pointer is over the element.

(Inherited from UIElement)
SizeChanged SizeChanged SizeChanged SizeChanged

Occurs when either the ActualHeight or the ActualWidth property changes value on a FrameworkElement.

(Inherited from FrameworkElement)
Tapped Tapped Tapped Tapped

Occurs when an otherwise unhandled Tap interaction occurs over the hit test area of this element.

(Inherited from UIElement)
Unloaded Unloaded Unloaded Unloaded

Occurs when this object is no longer connected to the main object tree.

(Inherited from FrameworkElement)

See Also