Image 类

定义

表示用于显示图像的控件。 图像源通过使用多种受支持的格式引用图像文件来指定。 还可以使用流设置图像源。 有关支持的图像源格式的列表,请参阅“备注”。

public ref class Image sealed : FrameworkElement
/// [Windows.Foundation.Metadata.Activatable(65536, Windows.Foundation.UniversalApiContract)]
/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 65536)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
class Image final : FrameworkElement
/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 65536)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
/// [Windows.Foundation.Metadata.Activatable(65536, "Windows.Foundation.UniversalApiContract")]
class Image final : FrameworkElement
[Windows.Foundation.Metadata.Activatable(65536, typeof(Windows.Foundation.UniversalApiContract))]
[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 65536)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
public sealed class Image : FrameworkElement
[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 65536)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
[Windows.Foundation.Metadata.Activatable(65536, "Windows.Foundation.UniversalApiContract")]
public sealed class Image : FrameworkElement
Public NotInheritable Class Image
Inherits FrameworkElement
<Image .../>
继承
属性

Windows 要求

设备系列
Windows 10 (在 10.0.10240.0 中引入)
API contract
Windows.Foundation.UniversalApiContract (在 v1.0 中引入)

示例

提示

有关详细信息、设计指南和代码示例,请参阅 Image

WinUI 2 库应用包括大多数 WinUI 2 控件、特性和功能的交互式示例。 通过 Microsoft Store 获取应用,或在 GitHub 上获取源代码。

注解

图像文件格式

图像可以显示以下图像文件格式:

  • 联合图像专家组 (JPEG)
  • 可移植网络图形 (PNG)
  • 位图 (BMP)
  • 图形交换格式 (GIF)
  • 标记图像文件格式 (TIFF)
  • JPEG XR
  • 图标 (ICO)
  • 可缩放的向量图形 (SVG)

注意

仅在 Windows 上支持图标文件。 Windows Phone 8.1 不支持

从版本 1607 Windows 10开始,Image 元素支持动态图形交换格式 (GIF) 图像。 使用 BitmapImage 作为图像 时,可以访问 BitmapImage API 来控制动画图形交换格式 (GIF) 图像的播放。 有关详细信息,请参阅 BitmapImage 类页面上的“备注”。

注意

当应用编译Windows 10版本 1607 并在版本 1607 (或更高版本) 上运行时,可以使用动态图形交换格式 (GIF) 支持。 为早期版本编译或运行应用时,将显示图形交换格式的第一帧 (GIF) ,但不会进行动画处理。

从版本 1703 Windows 10开始,Image 元素通过 SvgImageSource 支持静态可缩放矢量图形 (SVG) 图像。 SvgImageSource 支持 SVG 规范中的安全静态模式,不支持动画或交互。 Direct2D 提供基础 SVG 呈现支持,并提供有关特定 SVG 元素和属性支持的详细信息,请参阅 SVG 支持。 若要详细了解如何在应用中插入 SVG,请访问 SvgImageSource 类页。

注意

当应用编译Windows 10版本 1703 并在版本 1703 或更高版本 (或更高版本) 时,可以使用可缩放矢量图形 (SVG) 支持。 为以前版本编译或运行应用时,不会显示 SVG 图像。

设置 Image.Source

若要设置图像显示的图像源文件,可以在 XAML 或代码中设置其 Source 属性。 下面是在 XAML 中设置 的简单示例:

<Image Width="200" Source="Images/myimage.png"/>

此用法是通过统一资源标识符设置 (URI) ,这是 XAML 启用的快捷方式。 请注意,此处) 的统一资源标识符 (URI 显示为相对统一资源标识符 (URI) ;支持部分统一资源标识符 (URI) 是另一个 XAML 快捷方式。 此统一资源标识符的根 (URI) 是应用项目的基文件夹。 这通常是从中加载包含图像标记的 XAML 文件所在的位置。 在此示例中,图像源文件位于应用文件结构内的 Images 子文件夹中。

设置 Source 属性本质上是异步操作。 因为它是一个属性,所以没有可等待的语法,但在大多数情况下,你不需要与图像加载的异步方面进行交互。 框架将等待图像源返回,并在图像源文件可用和解码时启动布局周期。

将源设置为统一资源标识符 (URI) 值,无法解析为有效的图像源文件不会引发异常。 而是触发 ImageFailed 事件。 可以编写 ImageFailed 处理程序并将其附加到 Image 对象,并在事件数据中使用 ErrorMessage 来确定失败的性质。 解码时出错也可以触发 ImageFailed。 如果要验证映像源文件是否已正确加载,则可以处理 Image 元素上的 ImageOpened 事件。

通常使用已包含在应用下载包中的映像源文件。 对于大型文件,如果在首次使用源时对图像源文件进行解码,则可能存在非常小的延迟。 有关应用资源以及如何在应用包中打包图像源文件的详细信息,请参阅 定义应用资源

还可以使用不属于应用的图像源文件,例如来自外部服务器的映像。 这些映像由内部 HTTP 请求下载,然后解码。 如果图像源文件是大型文件,或者存在连接问题,则可能会在图像元素中显示外部图像之前出现延迟。

使用代码设置 Image.Source

如果使用代码创建 Image 对象,请调用默认构造函数,然后设置 Image.Source 属性。 设置 Image.Source 属性需要 BitmapImage 类的实例,还必须构造该类。 如果图像源是统一资源标识符 (URI) 引用的文件,请使用采用统一资源标识符 (URI) 参数的 BitmapImage 构造函数。 引用本地内容时,必须将 ms-appx: 方案包含在绝对统一资源标识符 (URI 中,) 用作 BitmapImage 构造函数参数。 在代码中,不会获取处理快捷方式,用于将相对统一资源标识符 (URI) 部分和 ms-appx 组合在 一起:如果将 Source 指定为 XAML 属性,则会自动发生的方案。 相反,必须使用适当的方案显式构造绝对统一资源标识符 (URI) 。 通常使用 ms-appx: 方案作为应用的一部分打包的图像文件。

提示

如果使用 C# 或 Microsoft Visual Basic,则可以获取映像的 BaseUri 属性,并将其作为 System.Uri 构造函数的 baseUri 参数传递,这些构造函数将统一资源标识符 (URI) 基位置和该位置内的相对路径组合在一起。

下面是在 C# 中设置 Image.Source 的示例。 在此示例中,Image 对象是在 XAML 中创建的,但没有源或任何其他属性值;而是在从 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;
}

对图像源使用流源

如果图像源是流,则必须编写用于设置映像实例以使用该流的代码。 这不能单独在 XAML 中完成。 构造要使用的映像,或引用现有映像实例 (,该实例可能已在 XAML 标记中定义,但没有源) 。 然后使用 BitmapImageasync SetSourceAsync 方法定义流中的图像信息,传递要用作 streamSource 参数的流。 对图像源使用流相当常见。 例如,如果应用允许用户使用 FileOpenPicker 控件选择图像文件,则你获取的对象表示用户选择的文件可以作为流打开,但不提供统一资源标识符 (URI) 引用文件。

在此示例中,代码已可等待,因为它正在等待用户选择文件,并且仅在发生此情况后运行。 要使用的流来自 StorageFile.OpenAsync 后,从异步选取器操作返回 StorageFile 实例。

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; 
    } 
}

提示

如果使用的是 C# 或 Microsoft Visual Basic,流可以使用以前 Microsoft .NET 编程体验中可能熟悉的 System.IO.Stream 类型。 可以在从 Windows 运行时 API 获取的任何 IRandomAccessStream 类型的任何对象上调用 AsStream 扩展方法作为实例方法。 前面的示例使用 IRandomAccessStream 进行参数传递,不需要使用 AsStream。 但是,如果需要操作流, AsStream 会作为实用工具转换为 System.IO.Stream (如果需要)。

有关更多示例代码 ,请参阅 XAML 图像示例

图像文件和性能

大型映像文件可能会影响性能,因为它们会加载到内存中。 如果引用图像文件,知道源文件是一个较大的高分辨率图像,但应用在小于图像自然大小的 UI 区域中显示它,则应设置 DecodePixelWidth 属性或 DecodePixelHeight通过 DecodePixel* 属性,可以将信息直接传递给特定于格式的编解码器,编解码器可以使用此信息更高效地解码,并缩小内存占用空间。 将 DecodePixelWidth 设置为你希望应用实际显示的区域的相同像素宽度。 换句话说,BitmapImage 源的 DecodePixelWidth 应与显示该源的图像控件的 WidthActualWidth 的值相同。

可以设置 DecodePixelWidth,也可以设置 DecodePixelHeight。 如果设置这两个属性之一,系统会计算匹配属性以保持正确的纵横比。 还可以设置这两个属性,但通常应使用保持该纵横比的值。 如果要更改纵横比,有更好的方法可以执行此操作,例如将 TranslateTransform 用作 RenderTransform

若要在 XAML 中设置 DecodePixelWidth (或 DecodePixelHeight) ,必须使用稍微详细的 XAML 语法,该语法将显式 BitmapImage 元素作为属性值,如下所示:

<Image>
  <Image.Source>
    <BitmapImage DecodePixelWidth="200" UriSource="images/myimage.png"/>
  </Image.Source>
</Image>

DecodePixelWidth (或 DecodePixelHeight) 是 BitmapImage 的属性,因此需要显式 BitmapImage XAML 对象元素才能将 DecodePixel* 属性设置为 XAML 中的属性。

如果要在代码中创建图像实例,则可能已经在将 BitmapImage 实例创建为属性提供的值,因此在设置 UriSource 属性之前,只需在 BitmapImage 实例上设置 DecodePixelWidth (或 DecodePixelHeight) 。 DecodePixelType 属性还会影响解码操作解释像素值的方式。

若要防止多次解码图像,请从统一资源标识符 (URI 分配图像源属性,) 而不是随时使用内存流。 XAML 框架可以将同一统一资源标识符 (URI) 与一个解码的图像关联到多个位置,但即使它们包含相同的数据,也无法对多个内存流执行相同的操作。

可以通过将所有关联的 Image.Source 值设置为 null,从映像缓存中删除图像文件。

有关 Image 类和性能的详细信息,请参阅 优化动画和媒体

图像文件编码和解码

Windows 映像组件 (WIC) API 提供对图像文件的基础编解码器支持。 有关为编解码器记录的特定图像格式的详细信息,请参阅 本机 WIC 编解码器

Image、 BitmapImageBitmapSource 的 API 不包含用于编码和解码媒体格式的任何专用方法。 所有解码操作都是内置于设置或重置源时发生的操作。 这使得类更易于用于构造 UI,因为它们具有一组默认支持的源文件格式和解码行为。 BitmapImage 等类将某些解码选项和逻辑作为 ImageOpenedImageFailed 事件事件的事件数据的一部分公开。 如果需要高级图像文件解码或图像编码,则应使用 Windows.Graphics.Imaging 命名空间中的 API。 如果你的应用方案涉及图像文件格式转换,或者操作图像,用户可以将结果另存为文件,则可能需要这些 API。 Windows 映像组件也支持编码 API (WIC) 组件的 Windows。

图像 宽度和高度

Image 类从 FrameworkElement 继承 WidthHeight 属性,这些属性可能会控制图像控件在 UI 中显示时呈现的大小。 如果未设置 宽度高度,则宽度和高度由图像源的自然大小决定。 例如,如果加载高度为 300 像素且宽为 400 像素的位图图像,则图像控件计算其自然大小时,这些度量用于宽度和高度。 可以在图像呈现后检查 ActualHeightActualWidth 以获取度量信息。 或者,可以在图像呈现前立即处理 ImageOpened 并检查图像文件属性,例如 PixelHeightPixelWidth

如果只设置一个 WidthHeight 属性,但不能同时设置这两个属性,则系统可以使用该维度作为指导并计算另一个维度,从而保留纵横比。 如果不确定源文件维度,请选择在布局方案中控制最重要的维度,让系统计算其他维度,然后容器的布局行为通常会调整布局以适应。

如果未设置 宽度 和/或 高度,并将图像保留为其自然大小,图像的 Stretch 属性可以控制图像源文件将如何填充指定为 WidthHeight 的空间。 默认 的 Stretch 值为 Uniform,当它适合图像进入布局容器时,它将保留纵横比。 如果容器的维度没有相同的纵横比,则仍有一部分为图像的空白空间,但至少在使用 Stretch 的统一值时未显示任何图像像素。 UniformToFill for Stretch 不会留空空间,但如果维度不同,可能会剪辑图像。 Stretch填充不会留空空间,但可能会更改纵横比。 可以试验这些值,了解布局方案中最适合图像显示的内容。 此外,请注意,某些布局容器可能会调整没有特定 宽度高度 的图像的大小,以填充整个布局空间,在这种情况下,可以选择在图像或容器上设置特定大小。

NineGrid

如果图像具有不应统一缩放的区域,则使用 NineGrid 技术是调整与显示区域不同的自然大小的图像的另一个选项。 例如,可以使用一个背景图像,该背景图像具有固有的边框,该边框只应在一个维度中拉伸,而不应拉伸的角,但图像中心可以拉伸以适应这两个维度中的布局要求。 有关详细信息,请参阅 NineGrid

映像的资源限定和本地化

图像 源文件和缩放

应以多种建议大小创建图像源,以确保应用在 Windows 8缩放应用时看起来很棒。 为图像指定 时,可以对将正确资源用于特定于设备的缩放因素的资源使用命名约定。 这是由应用在运行时自动确定的。 有关要使用的命名约定的详细信息,请参阅 快速入门:使用文件或图像资源

有关如何正确设计图像进行缩放的详细信息,请参阅 布局和缩放的 UX 指南

使用未限定的资源

非限定资源是一种技术,可以在基本资源引用引用默认资源的位置使用,资源管理过程可以自动查找等效的本地化资源。 可以使用自动处理来访问具有当前规模和区域性限定符的未限定资源,或者可以将 ResourceManagerResourceMap 与区域性限定符和规模结合使用,以便直接获取资源。 有关详细信息,请参阅资源管理系统

FlowDirection for Image

如果将 FlowDirection 设置为 Image 的 RightToLeft ,则图像的视觉内容水平翻转。 但是,Image 元素不会从任何父元素继承 FlowDirection 值。 通常,你只需要图像中与布局相关的图像翻转行为,但不一定是嵌入文本或其他组件对从右到左受众没有意义翻转的元素。 若要获取图像翻转行为,必须在特定于 RightToLeft 的 Image 元素上设置 FlowDirection 元素,或在代码隐藏中设置 FlowDirection 属性。 请考虑通过 x:Uid 指令标识 Image 元素,并将 FlowDirection 值指定为Windows 运行时资源,以便本地化专家以后无需更改 XAML 或代码即可更改此值。

Image 类和辅助功能

Image 类不是真正的控件类,因为它不是 Control 的后代类。 不能将焦点调用到 Image 元素,也不能将 Image 元素置于选项卡序列中。 有关在 UI 中使用图像和 Image 元素的辅助功能方面的详细信息,请参阅 基本辅助功能信息

Windows 8 行为

对于Windows 8,资源可以使用资源限定符模式根据特定于设备的缩放来加载不同的资源。 但是,如果在应用运行时缩放因子发生更改,则不会自动重新加载资源。 在这种情况下,应用必须处理重载资源,方法是处理 DpiChanged 事件 (或已弃用的 LogicalDpiChanged 事件) 并使用 ResourceManager API 手动重新加载适合新缩放因子的资源。 从Windows 8.1开始,如果应用运行时缩放因子发生更改,则会自动重新评估最初为应用检索的任何资源。 此外,当该资源是 Image 对象的映像源时,会触发 ImageOpenedImageFailed) (源加载事件之一,因为系统请求新资源,然后将其应用到映像。 当有多个可用应用时,用户将应用移动到其他监视器时,可能会发生运行时缩放更改的情况。

如果将应用代码从Windows 8迁移到Windows 8.1可能需要考虑此行为更改,因为它会导致在处理缩放更改时在运行时发生的 ImageOpenedImageFailed 事件,即使在在 XAML 中设置的情况下也是如此。 此外,如果确实有处理 DpiChangedLogicalDpiChanged/ 并重置资源的代码,则应检查是否仍需要该代码,前提是新的Windows 8.1自动重新加载行为。

对于针对 Windows 8 编译的应用,如果它在 Windows 8.1 上运行,将继续使用 Windows 8 行为。

版本历史记录

Windows 版本 SDK 版本 增值
1607 14393 GetAlphaMask

构造函数

Image()

初始化 Image 类的新实例。

属性

AccessKey

获取或设置此元素的访问键 (助记) 。

(继承自 UIElement)
AccessKeyScopeOwner

获取或设置一个源元素,该元素提供此元素的访问键范围,即使它不在源元素的可视化树中也是如此。

(继承自 UIElement)
ActualHeight

获取 FrameworkElement 的呈现高度。 请参阅“备注”。

(继承自 FrameworkElement)
ActualOffset

获取此 UIElement 相对于其父级的位置,该位置是在布局过程的排列传递期间计算的。

(继承自 UIElement)
ActualSize

获取此 UIElement 在布局过程的排列传递期间计算的大小。

(继承自 UIElement)
ActualTheme

获取元素当前使用的 UI 主题,该主题可能与 RequestedTheme 不同。

(继承自 FrameworkElement)
ActualWidth

获取 FrameworkElement 的呈现宽度。 请参阅“备注”。

(继承自 FrameworkElement)
AllowDrop

获取或设置一个值,该值确定此 UIElement 是否可以作为拖放操作的放置目标。

(继承自 UIElement)
AllowFocusOnInteraction

获取或设置一个值,该值指示当用户与其交互时元素是否自动获取焦点。

(继承自 FrameworkElement)
AllowFocusWhenDisabled

获取或设置禁用的控件是否可以接收焦点。

(继承自 FrameworkElement)
BaseUri

获取一个统一资源标识符 (URI) ,该 URI 表示 XAML 构造对象的基统一资源标识符 (URI) 。 此属性适用于运行时统一资源标识符 (URI) 解析。

(继承自 FrameworkElement)
CacheMode

获取或设置一个值,该值指示应尽可能将呈现的内容缓存为复合位图。

(继承自 UIElement)
CanBeScrollAnchor

获取或设置一个值,该值指示 UIElement 是否可以成为滚动定位的候选项。

(继承自 UIElement)
CanDrag

获取或设置一个值,该值指示元素是否可以在拖放操作中作为数据拖动。

(继承自 UIElement)
CenterPoint

获取或设置元素的中心点,即发生旋转或缩放的点。 影响元素的呈现位置。

(继承自 UIElement)
Clip

获取或设置用于定义 UIElement 内容的大纲的 RectangleGeometry

(继承自 UIElement)
CompositeMode

获取或设置一个属性,该属性在其父布局和窗口中声明元素的备用组合和混合模式。 这与混合 XAML/Microsoft DirectX UI 中涉及的元素相关。

(继承自 UIElement)
ContextFlyout

获取或设置与此元素关联的浮出控件。

(继承自 UIElement)
DataContext

获取或设置 FrameworkElement 的数据上下文。 数据上下文的常见用途是 当 FrameworkElement 使用 {Binding} 标记扩展并参与数据绑定时。

(继承自 FrameworkElement)
DesiredSize

获取此 UIElement 在布局过程的度量值传递期间计算的大小。

(继承自 UIElement)
Dispatcher

获取与此对象关联的 CoreDispatcherCoreDispatcher 表示可以访问 UI 线程上的 DependencyObject 的设施,即使代码是由非 UI 线程启动的。

(继承自 DependencyObject)
ExitDisplayModeOnAccessKeyInvoked

获取或设置一个值,该值指定在调用访问密钥时是否消除访问密钥显示。

(继承自 UIElement)
FlowDirection

获取或设置文本和其他 UI 元素在控制其布局的任何父元素中流动的方向。 此属性可以设置为 LeftToRightRightToLeft。 将 FlowDirection 设置为 RightToLeft 的任何元素会将对齐方式设置为右侧、从右到左的阅读顺序以及要从右向左流动的控件布局。

(继承自 FrameworkElement)
FocusVisualMargin

获取或设置 FrameworkElement 焦点视觉对象的外部边距。

(继承自 FrameworkElement)
FocusVisualPrimaryBrush

获取或设置用于为 FrameworkElement 绘制或Reveal焦点视觉对象的外边框HighVisibility的画笔。

(继承自 FrameworkElement)
FocusVisualPrimaryThickness

获取或设置 FrameworkElement 的外边框或HighVisibilityReveal焦点视觉对象的粗细。

(继承自 FrameworkElement)
FocusVisualSecondaryBrush

获取或设置用于为 FrameworkElement 绘制或Reveal焦点视觉对象的内边框HighVisibility的画笔。

(继承自 FrameworkElement)
FocusVisualSecondaryThickness

获取或设置 FrameworkElementReveal或焦点视觉对象的内边框的HighVisibility粗细。

(继承自 FrameworkElement)
Height

获取或设置 FrameworkElement 的建议高度。

(继承自 FrameworkElement)
HighContrastAdjustment

获取或设置一个值,该值指示在启用高对比度主题时框架是否自动调整元素的视觉属性。

(继承自 UIElement)
HorizontalAlignment

获取或设置在布局父级(如面板或项控件)中组合时应用于 FrameworkElement 的水平对齐特征。

(继承自 FrameworkElement)
IsAccessKeyScope

获取或设置一个值,该值指示元素是否定义其自己的访问密钥范围。

(继承自 UIElement)
IsDoubleTapEnabled

获取或设置一个值,该值确定 DoubleTapped 事件是否可以源自该元素。

(继承自 UIElement)
IsHitTestVisible

获取或设置此 UIElement 的包含区域是否可以返回命中测试的真正值。

(继承自 UIElement)
IsHoldingEnabled

获取或设置一个值,该值确定 Holding 事件是否可以源自该元素。

(继承自 UIElement)
IsLoaded

获取一个值,该值指示是否已将元素添加到元素树,并且已准备好进行交互。

(继承自 FrameworkElement)
IsRightTapEnabled

获取或设置一个值,该值确定 RightTapped 事件是否可以源自该元素。

(继承自 UIElement)
IsTapEnabled

获取或设置一个值,该值确定 点击 事件是否可以源自该元素。

(继承自 UIElement)
KeyboardAcceleratorPlacementMode

获取或设置一个值,该值指示控件 工具提示 是否显示其关联的键盘加速器的键组合。

(继承自 UIElement)
KeyboardAcceleratorPlacementTarget

获取或设置一个值,该值指示显示快捷键组合的控件 工具提示

(继承自 UIElement)
KeyboardAccelerators

获取使用键盘调用操作的键组合的集合。

加速器通常分配给按钮或菜单项。

显示各种菜单项键盘快捷键的菜单示例
显示各种菜单项键盘快捷键的菜单示例

(继承自 UIElement)
KeyTipHorizontalOffset

获取或设置一个值,该值指示键提示相对于 UIElement 的左或向右放置。

(继承自 UIElement)
KeyTipPlacementMode

获取或设置一个值,该值指示在 UIElement 边界上放置访问键提示的位置。

(继承自 UIElement)
KeyTipTarget

获取或设置一个值,该值指示访问键提示面向的元素。

(继承自 UIElement)
KeyTipVerticalOffset

获取或设置一个值,该值指示键提示相对于 UI 元素的向上或向下放置的距离。

(继承自 UIElement)
Language

获取或设置适用于 FrameworkElement 的本地化/全球化语言信息,以及应用于对象表示形式和 UI 中当前 FrameworkElement 的所有子元素。

(继承自 FrameworkElement)
Lights

获取附加到此元素的 XamlLight 对象的集合。

(继承自 UIElement)
ManipulationMode

获取或设置用于 UIElement 行为和与手势交互的 ManipulationModes 值。 设置此值可处理应用代码中此元素的操作事件。

(继承自 UIElement)
Margin

获取或设置 FrameworkElement 的外部边距。

(继承自 FrameworkElement)
MaxHeight

获取或设置 FrameworkElement 的最大高度约束。

(继承自 FrameworkElement)
MaxWidth

获取或设置 FrameworkElement 的最大宽度约束。

(继承自 FrameworkElement)
MinHeight

获取或设置 FrameworkElement 的最小高度约束。

(继承自 FrameworkElement)
MinWidth

获取或设置 FrameworkElement 的最小宽度约束。

(继承自 FrameworkElement)
Name

获取或设置对象的标识名称。 当 XAML 处理器从 XAML 标记创建对象树时,运行时代码可以通过此名称引用 XAML 声明的对象。

(继承自 FrameworkElement)
NineGrid

获取或设置九网格隐喻的值,该值控制图像的大小。 使用九网格比喻,可以拉伸图像的边缘和角,使其与中心不同。 有关详细信息和插图,请参阅“备注”。

NineGridProperty

标识 NineGrid 依赖项属性。

Opacity

获取或设置对象的不透明度程度。

(继承自 UIElement)
OpacityTransition

获取或设置 ScalarTransition,该 ScalarTransition 对不透明度属性的更改进行动画处理。

(继承自 UIElement)
Parent

获取对象树中此 FrameworkElement 的父对象。

(继承自 FrameworkElement)
PlayToSource

获取图像用于“播放到”方案时传输的信息。

PlayToSourceProperty

标识 PlayToSource 依赖项属性。

PointerCaptures

获取所有捕获的指针集,这些指针表示为 指针 值。

(继承自 UIElement)
Projection

获取或设置呈现此元素时要应用的三维效果) (透视投影。

(继承自 UIElement)
RenderSize

获取 UIElement 的最终呈现大小。 不建议使用,请参阅“备注”。

(继承自 UIElement)
RenderTransform

获取或设置影响 UIElement 呈现位置的转换信息。

(继承自 UIElement)
RenderTransformOrigin

获取或设置 RenderTransform 声明的任何可能的呈现转换的原点,相对于 UIElement 边界。

(继承自 UIElement)
RequestedTheme

获取或设置 UIElement (及其子元素) 用于资源确定的 UI 主题。 使用 RequestedTheme 指定的 UI 主题可以替代应用级 RequestedTheme

(继承自 FrameworkElement)
Resources

获取本地定义的资源字典。 在 XAML 中,可以通过 XAML 隐式集合语法将资源项建立为属性元素的 frameworkElement.Resources 子对象元素。

(继承自 FrameworkElement)
Rotation

获取或设置顺时针旋转的角度(以度为单位)。 相对于 RotationAxis 和 CenterPoint 旋转。 影响元素的呈现位置。

(继承自 UIElement)
RotationAxis

获取或设置要围绕元素旋转的轴。

(继承自 UIElement)
RotationTransition

获取或设置 ScalarTransition,该 ScalarTransition 对 Rotation 属性的更改进行动画处理。

(继承自 UIElement)
Scale

获取或设置元素的规模。 相对于元素的 CenterPoint 进行缩放。 影响元素的呈现位置。

(继承自 UIElement)
ScaleTransition

获取或设置 Vector3Transition,该 Vector3Transition 对 Scale 属性的更改进行动画处理。

(继承自 UIElement)
Shadow

获取或设置元素强制转换的阴影效果。

(继承自 UIElement)
Source

获取或设置图像的源。

SourceProperty

标识 依赖项属性。

Stretch

获取或设置一个值,该值描述如何拉伸 图像 以填充目标矩形。

StretchProperty

标识 Stretch 依赖项属性。

Style

获取或设置在布局和呈现期间应用于此对象的实例 样式

(继承自 FrameworkElement)
TabFocusNavigation

获取或设置一个值,该值修改 Tabbing 和 TabIndex 对此控件的工作方式。

(继承自 UIElement)
Tag

获取或设置一个任意对象值,该值可用于存储有关此对象的自定义信息。

(继承自 FrameworkElement)
Transform3D

获取或设置呈现此元素时要应用的三维转换效果。

(继承自 UIElement)
TransformMatrix

获取或设置要应用于元素的转换矩阵。

(继承自 UIElement)
Transitions

获取或设置应用于 UIElementTransition 样式元素的集合。

(继承自 UIElement)
Translation

获取或设置元素的 x、y 和 z 呈现位置。

(继承自 UIElement)
TranslationTransition

获取或设置 Vector3Transition,该 Vector3Transition 对翻译属性的更改进行动画处理。

(继承自 UIElement)
Triggers

获取为 FrameworkElement 定义的动画的触发器集合。 通常不常用。 请参阅“备注”。

(继承自 FrameworkElement)
UIContext

获取元素的上下文标识符。

(继承自 UIElement)
UseLayoutRounding

获取或设置一个值,该值确定对象及其视觉子树的呈现是否应使用舍入行为,使呈现与整个像素对齐。

(继承自 UIElement)
VerticalAlignment

获取或设置在父对象(如面板或项控件)中组合时应用于 FrameworkElement 的垂直对齐特征。

(继承自 FrameworkElement)
Visibility

获取或设置 UIElement 的可见性。 不可见的 UIElement 不会呈现,并且不会将其所需的大小传达给布局。

(继承自 UIElement)
Width

获取或设置 FrameworkElement 的宽度。

(继承自 FrameworkElement)
XamlRoot

获取或设置在其中查看此元素的 XamlRoot。

(继承自 UIElement)
XYFocusDownNavigationStrategy

获取或设置一个值,该值指定用于确定向下导航的目标元素的策略。

(继承自 UIElement)
XYFocusKeyboardNavigation

获取或设置使用键盘方向箭头启用或禁用导航的值。

(继承自 UIElement)
XYFocusLeftNavigationStrategy

获取或设置一个值,该值指定用于确定左侧导航的目标元素的策略。

(继承自 UIElement)
XYFocusRightNavigationStrategy

获取或设置一个值,该值指定用于确定右侧导航的目标元素的策略。

(继承自 UIElement)
XYFocusUpNavigationStrategy

获取或设置一个值,该值指定用于确定向上导航的目标元素的策略。

(继承自 UIElement)

方法

AddHandler(RoutedEvent, Object, Boolean)

为指定的路由事件添加路由事件处理程序,并将该处理程序添加到当前元素的处理程序集合中。 将 handledEventsToo 指定为 true ,以调用提供的处理程序,即使事件在其他地方进行处理也是如此。

(继承自 UIElement)
Arrange(Rect)

定位子对象并确定 UIElement 的大小。 为其子元素实现自定义布局的父对象应从其布局重写实现中调用此方法,以形成递归布局更新。

(继承自 UIElement)
ArrangeOverride(Size)

提供布局的“排列”传递的行为。 类可以重写此方法以定义自己的“排列”传递行为。

(继承自 FrameworkElement)
CancelDirectManipulations()

取消任何包含当前 UIElementScrollViewer 父级上 (系统定义的平移/缩放) 正在进行的直接操作处理。

(继承自 UIElement)
CapturePointer(Pointer)

将指针捕获设置为 UIElement。 捕获后,只有具有捕获的元素才会触发与指针相关的事件。

(继承自 UIElement)
ClearValue(DependencyProperty)

清除依赖属性的本地值。

(继承自 DependencyObject)
FindName(String)

检索具有指定标识符名称的对象。

(继承自 FrameworkElement)
FindSubElementsForTouchTargeting(Point, Rect)

使 UIElement 子类能够公开有助于解析触摸目标的子元素。

(继承自 UIElement)
GetAlphaMask()

返回一个掩码,该掩码表示图像的 alpha 通道作为 CompositionBrush

GetAnimationBaseValue(DependencyProperty)

返回为依赖属性建立的任何基值,如果动画不处于活动状态,将适用该基值。

(继承自 DependencyObject)
GetAsCastingSource()

CastingSource 的形式返回图像。

GetBindingExpression(DependencyProperty)

返回表示指定属性上的绑定的 BindingExpression

(继承自 FrameworkElement)
GetChildrenInTabFocusOrder()

使 UIElement 子类能够公开参与 Tab 焦点的子元素。

(继承自 UIElement)
GetValue(DependencyProperty)

DependencyObject 返回依赖属性的当前有效值。

(继承自 DependencyObject)
GoToElementStateCore(String, Boolean)

在派生类中实现时,可以在代码中为控件模板启用可视化树的按状态构造,而不是在控件启动时加载所有状态的 XAML。

(继承自 FrameworkElement)
InvalidateArrange()

使 UIElement 的排列状态 (布局) 无效。 无效后, UIElement 将更新其布局,这将异步发生。

(继承自 UIElement)
InvalidateMeasure()

使 UIElement 的度量状态 (布局) 无效。

(继承自 UIElement)
InvalidateViewport()

使用于计算有效视区UIElement 的视区状态失效。

(继承自 FrameworkElement)
Measure(Size)

汇报 UIElementDesiredSize。 通常,为其布局子级实现自定义布局的对象从自己的 MeasureOverride 实现调用此方法,以形成递归布局更新。

(继承自 UIElement)
MeasureOverride(Size)

提供布局周期的“度量值”传递的行为。 类可以重写此方法以定义其自己的“度量值”传递行为。

(继承自 FrameworkElement)
OnApplyTemplate()

每当应用程序代码或内部进程 ((例如重新生成布局)) 调用 ApplyTemplate 时调用。 简言之,这意味着在应用中显示 UI 元素之前调用该方法。 重写此方法以影响类的默认模板后逻辑。

(继承自 FrameworkElement)
OnBringIntoViewRequested(BringIntoViewRequestedEventArgs)

BringIntoViewRequested 事件发生之前调用。

(继承自 UIElement)
OnCreateAutomationPeer()

在派生类中实现时,返回 Microsoft UI 自动化基础结构的特定于类的 AutomationPeer 实现。

(继承自 UIElement)
OnDisconnectVisualChildren()

重写此方法以实现当项从特定于类的内容或子属性中删除时布局和逻辑的行为方式。

(继承自 UIElement)
OnKeyboardAcceleratorInvoked(KeyboardAcceleratorInvokedEventArgs)

在应用中处理 键盘快捷方式 (或快捷键) 时调用。 重写此方法以处理调用键盘加速器时应用响应的方式。

(继承自 UIElement)
OnProcessKeyboardAccelerators(ProcessKeyboardAcceleratorEventArgs)

应用中处理键盘快捷方式 (或快捷键) 之前调用。 每当应用程序代码或内部进程调用 ProcessKeyboardAccelerators 时调用。 重写此方法以影响默认加速器处理。

(继承自 UIElement)
PopulatePropertyInfo(String, AnimationPropertyInfo)

定义可进行动画处理的属性。

(继承自 UIElement)
PopulatePropertyInfoOverride(String, AnimationPropertyInfo)

在派生类中重写时,定义可以进行动画处理的属性。

(继承自 UIElement)
ReadLocalValue(DependencyProperty)

如果设置了本地值,则返回依赖属性的本地值。

(继承自 DependencyObject)
RegisterPropertyChangedCallback(DependencyProperty, DependencyPropertyChangedCallback)

注册一个通知函数,用于侦听此 DependencyObject 实例上对特定 DependencyProperty 所做的更改。

(继承自 DependencyObject)
ReleasePointerCapture(Pointer)

释放指针捕获,以便通过此 UIElement 捕获一个特定指针。

(继承自 UIElement)
ReleasePointerCaptures()

释放此元素保留的所有指针捕获。

(继承自 UIElement)
RemoveHandler(RoutedEvent, Object)

从此 UIElement 中删除指定的路由事件处理程序。 通常, 添加的处理程序由 AddHandler 添加。

(继承自 UIElement)
SetBinding(DependencyProperty, BindingBase)

使用提供的绑定对象将绑定附加到 FrameworkElement

(继承自 FrameworkElement)
SetValue(DependencyProperty, Object)

设置 DependencyObject 上的依赖属性的本地值。

(继承自 DependencyObject)
StartAnimation(ICompositionAnimationBase)

开始元素上的指定动画。

(继承自 UIElement)
StartBringIntoView()

启动对 XAML 框架的请求,将元素引入其包含的任何可滚动区域中的视图中。

(继承自 UIElement)
StartBringIntoView(BringIntoViewOptions)

启动对 XAML 框架的请求,以使用指定的选项将元素引入视图。

(继承自 UIElement)
StartDragAsync(PointerPoint)

启动拖放操作。

(继承自 UIElement)
StopAnimation(ICompositionAnimationBase)

停止元素上的指定动画。

(继承自 UIElement)
TransformToVisual(UIElement)

返回一个转换对象,该对象可用于将 坐标从 UIElement 转换为指定对象。

(继承自 UIElement)
TryInvokeKeyboardAccelerator(ProcessKeyboardAcceleratorEventArgs)

尝试通过搜索 UIElement 的整个视觉树来调用 键盘快捷方式 (或快捷键)

(继承自 UIElement)
UnregisterPropertyChangedCallback(DependencyProperty, Int64)

取消以前通过调用 RegisterPropertyChangedCallback 注册的更改通知。

(继承自 DependencyObject)
UpdateLayout()

确保为布局正确更新 UIElement 子对象的所有位置。

(继承自 UIElement)

活动

AccessKeyDisplayDismissed

当不再显示访问密钥时发生。

(继承自 UIElement)
AccessKeyDisplayRequested

当用户请求显示访问密钥时发生。

(继承自 UIElement)
AccessKeyInvoked

当用户完成访问密钥序列时发生。

(继承自 UIElement)
ActualThemeChanged

当 ActualTheme 属性值发生更改时发生。

(继承自 FrameworkElement)
BringIntoViewRequested

在对此元素或其子代之一调用 StartBringIntoView 时发生。

(继承自 UIElement)
CharacterReceived

当输入队列接收单个组合字符时发生。

(继承自 UIElement)
ContextCanceled

当上下文输入手势继续进入操作手势时发生,以通知元素不应打开上下文浮出控件。

(继承自 UIElement)
ContextRequested

当用户完成上下文输入手势(如右键单击)时发生。

(继承自 UIElement)
DataContextChanged

FrameworkElement.DataContext 属性的值更改时发生。

(继承自 FrameworkElement)
DoubleTapped

在此元素的命中测试区域发生其他未处理的 DoubleTap 交互时发生。

(继承自 UIElement)
DragEnter

当输入系统报告具有此元素作为目标的基础拖动事件时发生。

(继承自 UIElement)
DragLeave

当输入系统报告具有此元素作为源的基础拖动事件时发生。

(继承自 UIElement)
DragOver

在输入系统报告出现以此元素为可能放置目标的基础拖动事件时发生。

(继承自 UIElement)
DragStarting

启动拖动操作时发生。

(继承自 UIElement)
Drop

在输入系统报告出现将此元素作为放置目标的基础放置事件时发生。

(继承自 UIElement)
DropCompleted

当以此元素作为源结束的拖放操作时发生。

(继承自 UIElement)
EffectiveViewportChanged

FrameworkElement的有效视区 更改时发生。

(继承自 FrameworkElement)
GettingFocus

UIElement 接收焦点之前发生。 此事件是同步引发的,以确保在事件浮泡时不会移动焦点。

(继承自 UIElement)
GotFocus

当 UIElement 收到焦点时发生。 此事件是异步引发的,因此焦点可以在浮泡完成之前再次移动。

(继承自 UIElement)
Holding

在此元素的命中测试区域发生其他未处理的 保留 交互时发生。

(继承自 UIElement)
ImageFailed

出现与图像检索或格式关联的错误时发生。

ImageOpened

下载映像源并解码时不失败时发生。 可以使用此事件来确定图像源的自然大小。

KeyDown

UIElement 具有焦点时按下键盘键时发生。

(继承自 UIElement)
KeyUp

UIElement 具有焦点时释放键盘键时发生。

(继承自 UIElement)
LayoutUpdated

当可视化树的布局发生更改时,由于与布局相关的属性更改值或刷新布局的其他一些操作。

(继承自 FrameworkElement)
Loaded

在构造并添加到对象树中并准备好交互时发生 FrameworkElement

(继承自 FrameworkElement)
Loading

FrameworkElement 开始加载时发生。

(继承自 FrameworkElement)
LosingFocus

UIElement 失去焦点之前发生。 此事件是同步引发的,以确保在事件浮泡时不会移动焦点。

(继承自 UIElement)
LostFocus

当 UIElement 失去焦点时发生。 此事件是异步引发的,因此焦点可以在浮泡完成之前再次移动。

(继承自 UIElement)
ManipulationCompleted

UIElement 上的操作完成时发生。

(继承自 UIElement)
ManipulationDelta

当输入设备在操作期间更改位置时发生。

(继承自 UIElement)
ManipulationInertiaStarting

在输入设备在操作期间与 UIElement 对象失去联系和延迟开始时发生。

(继承自 UIElement)
ManipulationStarted

在输入设备在 UIElement 上开始操作时发生。

(继承自 UIElement)
ManipulationStarting

在首次创建操作处理器时发生。

(继承自 UIElement)
NoFocusCandidateFound

当用户尝试通过制表符或方向箭头 (移动焦点时) 发生,但焦点不会移动,因为没有在移动方向找到任何焦点候选项。

(继承自 UIElement)
PointerCanceled

当使联系人异常丢失联系人的指针时发生。

(继承自 UIElement)
PointerCaptureLost

当此元素以前持有的指针捕获移动到另一个元素或其他地方时发生。

(继承自 UIElement)
PointerEntered

当指针进入此元素的命中测试区域时发生。

(继承自 UIElement)
PointerExited

当指针离开此元素的命中测试区域时发生。

(继承自 UIElement)
PointerMoved

当指针在指针保留在此元素的命中测试区域中时发生。

(继承自 UIElement)
PointerPressed

当指针设备在此元素中启动 操作时发生。

(继承自 UIElement)
PointerReleased

在此元素中释放以前启动 按下 操作的指针设备时发生。 请注意, 无法保证按下 操作的末尾触发 PointerReleased 事件;其他事件可能会触发。 有关详细信息,请参阅“备注”。

(继承自 UIElement)
PointerWheelChanged

当指针方向盘的增量值发生更改时发生。

(继承自 UIElement)
PreviewKeyDown

UIElement 具有焦点时按下键盘键时发生。

(继承自 UIElement)
PreviewKeyUp

UIElement 具有焦点时释放键盘键时发生。

(继承自 UIElement)
ProcessKeyboardAccelerators

按下 键盘快捷方式 (或快捷键) 时发生。

(继承自 UIElement)
RightTapped

当指针位于元素上方时发生右点击输入刺激时发生。

(继承自 UIElement)
SizeChanged

ActualHeightActualWidth 属性值在 FrameworkElement 上更改时发生。

(继承自 FrameworkElement)
Tapped

在此元素的命中测试区域发生其他未处理的 Tap 交互时发生。

(继承自 UIElement)
Unloaded

当此对象不再连接到主对象树时发生。

(继承自 FrameworkElement)

适用于

另请参阅