MediaPlayerElement 类
定义
重要
一些信息与预发行产品相关,相应产品在发行之前可能会进行重大修改。 对于此处提供的信息,Microsoft 不作任何明示或暗示的担保。
表示一个对象,该对象使用 MediaPlayer 将音频和视频呈现给显示器。
/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 196608)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
class MediaPlayerElement : Control
[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 196608)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
public class MediaPlayerElement : Control
Public Class MediaPlayerElement
Inherits Control
<MediaPlayerElement .../>
- 继承
- 属性
Windows 要求
设备系列 |
Windows 10 Anniversary Edition (在 10.0.14393.0 中引入)
|
API contract |
Windows.Foundation.UniversalApiContract (在 v3.0 中引入)
|
示例
此代码创建一个 MediaPlayerElement,其中 AutoPlay 属性 显式设置为 true , 并将 Source 设置为应用中包含的视频文件的路径。
<MediaPlayerElement Source="ms-appx:///Media/video1.mp4" AutoPlay="True" />
此示例创建启用了传输控件的 MediaPlayerElement。
<MediaPlayerElement x:Name="mediaPlayer"
Source="ms-appx:///Media/video1.mp4"
AreTransportControlsEnabled="True" />
此示例演示如何在弹出窗口中使用 MediaPlayerElement。
<Grid>
<Button Content="Show Popup" Click="ShowPopupClicked"/>
<Popup x:Name="mediaPlayerPopup">
<StackPanel Height="1400" Width="1400" Background="Blue">
<MediaPlayerElement x:Name="mediaPlayer"
AreTransportControlsEnabled="True"
Source="ms-appx:///Media/Intro.wmv"/>
<TextBlock Text="Simple Popup"/>
<Button Content="Close" Click="ClosePopupClicked"/>
</StackPanel>
</Popup>
</Grid>
long token;
protected override void OnNavigatedTo(NavigationEventArgs e)
{
token = mediaPlayer.RegisterPropertyChangedCallback(MediaPlayerElement.IsFullWindowProperty, OnMPEFullWindowChanged);
base.OnNavigatedTo(e);
}
protected override void OnNavigatedFrom(NavigationEventArgs e)
{
mediaPlayer.UnregisterPropertyChangedCallback(MediaPlayerElement.IsFullWindowProperty, token);
}
private void OnMPEFullWindowChanged(DependencyObject sender, DependencyProperty dp)
{
MediaPlayerElement mpe = (MediaPlayerElement)sender;
if (mpe != null && dp == MediaPlayerElement.IsFullWindowProperty)
{
if (mpe.IsFullWindow == true)
{
mediaPlayerPopup.Visibility = Visibility.Collapsed;
}
else
{
mediaPlayerPopup.Visibility = Visibility.Visible;
}
}
}
private void ClosePopupClicked(object sender, RoutedEventArgs e)
{
// If the Popup is open, then close it.
if (mediaPlayerPopup.IsOpen) { mediaPlayerPopup.IsOpen = false; }
}
// Handles the Click event on the Button on the page and opens the Popup.
private void ShowPopupClicked(object sender, RoutedEventArgs e)
{
// Open the Popup if it isn't open already.
if (!mediaPlayerPopup.IsOpen) { mediaPlayerPopup.IsOpen = true; }
}
注解
提示
有关详细信息、设计指南和代码示例,请参阅 媒体播放。
有关 MediaPlayerElement 支持的媒体格式的信息,请参阅 支持的编解码器。
体系结构概述
MediaPlayerElement 是一个轻型 XAML 控件,用作可靠 MediaPlayer 类的呈现图面,该类是 Windows.Media.Playback 命名空间的一部分。 大部分媒体功能位于基础 MediaPlayer 类上,可通过 MediaPlayerElement.MediaPlayer 属性访问该类。
有关 MediaPlayer 类的详细信息,包括有关如何从 MediaElement 转换到 MediaPlayerElement 的指南,请参阅 媒体播放 页。
设置媒体源
将 MediaPlayerElement 的 Source 属性设置为指向音频或视频文件。 可以将它设置为 MediaSource、 MediaPlaybackItem 或 MediaPlaybackList。 媒体文件可以包含在应用包中,也可以位于网络上。
默认情况下, 由 Source 属性定义的媒体在加载 MediaPlayerElement 对象后不会立即播放。 若要自动启动媒体播放,请将 “自动播放” 属性设置为 true。
下面介绍如何在 XAML 中创建 MediaPlayerElement,其中 Source 设置为应用中包含的视频文件的路径,并且 自动播放 属性显式设置为 true。
<MediaPlayerElement Source="ms-appx:///Media/video1.mp4" AutoPlay="True"/>
下面介绍如何在代码中创建 MediaPlayerElement。
MediaPlayerElement mediaPlayerElement1 = new MediaPlayerElement();
mediaPlayerElement1.Source = MediaSource.CreateFromUri(new Uri("ms-appx:///Media/video1.mp4"));
mediaPlayerElement1.AutoPlay = true;
设置基础媒体播放器
在 MediaPlayerElement 上设置 Source 属性或 自动播放 属性时,如果基础 MediaPlayer 尚不存在,它将自动创建一个。 或者,可以创建自己的 MediaPlayer, 并使用 SetMediaPlayer 方法在 MediaPlayerElement 上设置它。 下面是如何在代码中设置基础 MediaPlayer 的示例。
<MediaPlayerElement x:Name="mpe"/>
MediaPlayer mediaPlayer = new MediaPlayer();
mpe.SetMediaPlayer(mediaPlayer);
mpe.Source = MediaSource.CreateFromUri(new Uri("ms-appx:///Media/video1.mp4"));
mpe.AutoPlay = true;
注意
设置 MediaPlayerElement 属性将设置其基础 MediaPlayer 上的相应属性。 可以选择直接使用基础 MediaPlayer, 而不是使用 MediaPlayerElement 属性。 请注意,直接使用 MediaPlayer (如果可以使用等效的 MediaPlayerElement 属性),否则可能会导致意外行为。 这是因为 MediaPlayerElement 不知道其基础 MediaPlayer 发生的所有情况。 例如,如果直接在 MediaPlayer 上设置源,则 MediaPlayerElement 的 Source 属性不会反映更改。 因此,在使用 MediaPlayerElement 属性或直接使用基础 MediaPlayer 时,必须保持一致。 本文档将尽可能使用 MediaPlayerElement 属性。
分离基础媒体播放器
销毁 MediaPlayerElement 或使用 SetMediaPlayer 设置新的 MediaPlayer 时,MediaPlayer 将从 MediaPlayerElement 分离。 分离时,MediaPlayerElement 以不同的方式对待基础 MediaPlayer ,具体取决于它是由 MediaPlayerElement 创建的还是使用 SetMediaPlayer 设置的。
如果 MediaPlayer 是由 MediaPlayerElement 创建的,它将为你正确 关闭MediaPlayer 。
如果使用 SetMediaPlayer 在 MediaPlayerElement 上设置了 MediaPlayer,则负责确保 MediaPlayer 正确关闭。 否则可能会导致 MediaPlayer 中出现致命的播放错误。 下面介绍如何在代码中正确分离和 关闭MediaPlayer 。
<MediaPlayerElement x:Name="mpe"/>
MediaPlayer mediaPlayer = mpe.MediaPlayer;
IMediaPlaybackSource source = mpe.Source;
// 1. Pause playback if able.
if (mediaPlayer.PlaybackSession.CanPause)
{
mediaPlayer.Pause();
}
// 2. Disconnect the MediaPlayer from its source. This can be done by setting
// the MediaPlayerElement Source property to null or by directly setting the
// source to null on the underlying MediaPlayer.
mpe.Source = null;
// 3. Disconnect the MediaPlayer from MediaPlayerElement.
mpe.SetMediaPlayer(null);
// 4. Dispose of the MediaPlayer or Source if they're no longer needed.
if (source is MediaSource mediaSource)
{
mediaSource.Dispose();
}
mediaPlayer.Dispose();
处理媒体事件
可以响应位于基础 MediaPlayer 上的常见媒体事件,例如 MediaOpened、 MediaEnded 和 MediaFailed。 如果已将源设置为 MediaPlaybackItem 或 MediaPlaybackList,则应响应这些类上的媒体事件,因为它们提供了详细信息。
传输控件
将 AreTransportControlsEnabled 属性设置为以编程方式启用和禁用 MediaPlayerElement 的内置传输控件。 内置的传输控件提供用于播放、停止、暂停和查找媒体的 UI,以及用于音量、静音、全屏、轨道选择、隐藏式字幕和剩余时间的 UI。
可以通过将 AreTransportControlsEnabled 设置为 false 并使用 MediaPlayer 上的 Play 和 Pause 方法来创建自己的媒体传输控件。 还可以使用基础 MediaPlayer (如 Position、 Volume、 IsMuted、 IsLoopingEnabled 和 PlaybackRate)控制一组丰富的属性。
提示
为了提高性能,请避免将数据绑定到 Position 属性,以反映频繁的位置更新 (例如使用进度栏) 。 请改用 DispatcherTimer 查询 Position 属性。
有关详细信息和示例,请参阅 创建自定义传输控件。
全屏播放
使用 IsFullWindow 属性启用和禁用全屏呈现。 在全屏模式下,当不再检测到用户操作时,将自动阻止停用显示。
注意
建议不要在 Popup 控件中使用 MediaPlayerElement。 如果 弹出窗口 中托管的 MediaPlayerElement 切换到全屏模式,则 弹出窗口 将呈现在 MediaPlayerElement 的顶部。 如果必须在 弹出窗口中使用 MediaPlayerElement,则应在 MediaPlayerElement 进入全屏模式时折叠 弹出窗口 ,并在 MediaPlayerElement 退出全屏模式时还原 弹出窗口 。 使用 DependencyProperty.RegisterPropertyChangedCallback 在 MediaPlayerElement.IsFullWindow 属性更改时收到通知。 有关示例,请参阅“示例”部分。
保持媒体播放
若要防止在 MediaPlayerElement 未处于全屏模式时停用显示,可以调用 DisplayRequest.RequestActive。 若要节省电源并延长电池寿命,应调用 DisplayRequest.RequestRelease 以在不再需要显示请求时立即将其释放。
在以下情况下应该释放显示请求:
- 例如,由于用户操作、缓冲或有限带宽引起的调整需要暂停视频播放。
- 播放停止。 例如,视频播放完毕或完成演示文稿。
- 出现播放错误。 例如,存在网络连接问题或损坏的文件。
在这里,使用 PlaybackStateChanged 事件来检测这些情况。 然后,使用 MediaPlayer.PlaybackSession 的 NaturalVideoHeight 属性来确定音频或视频文件是否正在播放,并且仅在播放视频时使屏幕保持活动状态。
<MediaPlayerElement x:Name="mpe" Source="ms-appx:///Media/video1.mp4"/>
// Create this variable at a global scope. Set it to null.
private DisplayRequest appDisplayRequest = null;
protected override void OnNavigatedTo(NavigationEventArgs e)
{
mpe.MediaPlayer.PlaybackSession.PlaybackStateChanged += MediaPlayerElement_CurrentStateChanged;
base.OnNavigatedTo(e);
}
private void MediaPlayerElement_CurrentStateChanged(MediaPlaybackSession sender, object args)
{
MediaPlaybackSession playbackSession = sender as MediaPlaybackSession;
if (playbackSession != null && playbackSession.NaturalVideoHeight != 0)
{
if(playbackSession.PlaybackState == MediaPlaybackState.Playing)
{
if(appDisplayRequest == null)
{
// This call creates an instance of the DisplayRequest object
appDisplayRequest = new DisplayRequest();
appDisplayRequest.RequestActive();
}
}
else // PlaybackState is Buffering, None, Opening, or Paused.
{
if(appDisplayRequest != null)
{
// Deactivate the display request and set the var to null.
appDisplayRequest.RequestRelease();
appDisplayRequest = null;
}
}
}
}
海报源
可以使用 PosterSource 属性在加载媒体之前或播放纯音频媒体时为 MediaPlayerElement 提供视觉表示形式。 . PosterSource 是一个图像,如屏幕快照、电影海报或专辑封面,用于代替媒体显示。 PosterSource 将在以下情况下显示:
- 在没有设置有效的源时。 例如,未设置 源 , 源 设置为 Null,或源无效 (如 MediaFailed 事件触发) 。
- 加载媒体时。 例如,设置了有效的源,但 尚未触发 MediaOpened 事件。
- 当媒体流式传输到其他设备时。
- 当媒体仅限音频时。
构造函数
MediaPlayerElement() |
初始化 MediaPlayerElement 类的新实例。 |
属性
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) |
AreTransportControlsEnabled |
获取或设置一个值,该值确定是否启用标准传输控件。 |
AreTransportControlsEnabledProperty |
标识 AreTransportControlsEnabled 依赖属性。 |
AutoPlay |
获取或设置一个值,该值指示设置 Source 属性时媒体是否自动开始播放。 |
AutoPlayProperty |
标识 AutoPlay 依赖属性。 |
Background |
获取或设置提供控件背景的画笔。 (继承自 Control) |
BackgroundSizing |
获取或设置一个值,该值指示背景相对于此元素边框的延伸程度。 (继承自 Control) |
BaseUri |
获取统一资源标识符 (URI) ,表示 XAML 加载时 XAML 构造对象的基本统一资源标识符 (URI) 。 此属性在运行时用于统一资源标识符 (URI) 解析。 (继承自 FrameworkElement) |
BorderBrush |
获取或设置描述控件边框填充的画笔。 (继承自 Control) |
BorderThickness |
获取或设置控件的边框宽度。 (继承自 Control) |
CacheMode |
获取或设置一个值,该值指示应尽可能将呈现的内容缓存为复合位图。 (继承自 UIElement) |
CanBeScrollAnchor |
获取或设置一个值,该值指示 UIElement 是否可以成为滚动定位的候选项。 (继承自 UIElement) |
CanDrag |
获取或设置一个值,该值指示是否可以在拖放操作中将元素作为数据拖动。 (继承自 UIElement) |
CenterPoint |
获取或设置 元素的中心点,该中心点是关于发生旋转或缩放的点。 影响元素的呈现位置。 (继承自 UIElement) |
CharacterSpacing |
获取或设置字符之间的统一间距,单位为 1/1000 em。 (继承自 Control) |
Clip |
获取或设置用于定义 UIElement 内容的大纲的 RectangleGeometry。 (继承自 UIElement) |
CompositeMode |
获取或设置一个属性,该属性声明元素在其父布局和窗口中的替代组合和混合模式。 这与混合 XAML/Microsoft DirectX UI 中涉及的元素相关。 (继承自 UIElement) |
ContextFlyout |
获取或设置与此元素关联的浮出控件。 (继承自 UIElement) |
CornerRadius |
获取或设置控件边框角的半径。 (继承自 Control) |
DataContext |
获取或设置 FrameworkElement 的数据上下文。 数据上下文的常见用途是 当 FrameworkElement 使用 {Binding} 标记扩展并参与数据绑定时。 (继承自 FrameworkElement) |
DefaultStyleKey |
获取或设置引用控件的默认样式的键。 自定义控件的作者使用此属性更改其控件使用的样式的默认值。 (继承自 Control) |
DefaultStyleResourceUri |
获取或设置包含控件的默认样式的资源文件的路径。 (继承自 Control) |
DesiredSize |
获取此 UIElement 在布局过程的度量传递期间计算的大小。 (继承自 UIElement) |
Dispatcher |
获取与此对象关联的 CoreDispatcher 。 CoreDispatcher 表示可以访问 UI 线程上的 DependencyObject 的工具,即使代码是由非 UI 线程启动的。 (继承自 DependencyObject) |
ElementSoundMode |
获取或设置一个值,该值指定控件是否播放声音的首选项。 (继承自 Control) |
ExitDisplayModeOnAccessKeyInvoked |
获取或设置一个值,该值指定在调用访问密钥时是否消除访问密钥显示。 (继承自 UIElement) |
FlowDirection |
获取或设置文本和其他 UI 元素在控制其布局的任何父元素中的流动方向。 此属性可以设置为 LeftToRight 或 RightToLeft。 在任何元素上将 FlowDirection 设置为 RightToLeft 会将对齐方式设置为右对齐,将阅读顺序设置为从右到左,并将控件的布局设置为从右到左流动。 (继承自 FrameworkElement) |
FocusState |
获取一个值,该值指定此控件是否具有焦点,以及获取焦点的模式。 (继承自 Control) |
FocusVisualMargin |
获取或设置 FrameworkElement 的焦点视觉对象的外部边距。 (继承自 FrameworkElement) |
FocusVisualPrimaryBrush |
获取或设置用于为 FrameworkElement 绘制或 |
FocusVisualPrimaryThickness |
获取或设置 FrameworkElement 或 |
FocusVisualSecondaryBrush |
获取或设置用于为 FrameworkElement 绘制或 |
FocusVisualSecondaryThickness |
获取或设置 FrameworkElement 或 |
FontFamily |
获取或设置用于显示控件中的文本的字体。 (继承自 Control) |
FontSize |
获取或设置此控件中文本的大小。 (继承自 Control) |
FontStretch |
获取或设置字体在屏幕上紧缩或加宽的程度。 (继承自 Control) |
FontStyle |
获取或设置呈现文本的样式。 (继承自 Control) |
FontWeight |
获取或设置指定字体的粗细。 (继承自 Control) |
Foreground |
获取或设置一个用于描述前景色的画笔。 (继承自 Control) |
Height |
获取或设置 FrameworkElement 的建议高度。 (继承自 FrameworkElement) |
HighContrastAdjustment |
获取或设置一个值,该值指示框架是否在启用高对比度主题时自动调整元素的视觉属性。 (继承自 UIElement) |
HorizontalAlignment |
获取或设置在布局父级(如面板或项控件)中组合时应用于 FrameworkElement 的水平对齐特征。 (继承自 FrameworkElement) |
HorizontalContentAlignment |
获取或设置控件内容的水平对齐方式。 (继承自 Control) |
IsAccessKeyScope |
获取或设置一个值,该值指示元素是否定义其自己的访问键范围。 (继承自 UIElement) |
IsDoubleTapEnabled |
获取或设置一个值,该值确定 DoubleTapped 事件是否可以源自该元素。 (继承自 UIElement) |
IsEnabled |
获取或设置一个值,该值指示用户是否可以与控件交互。 (继承自 Control) |
IsFocusEngaged |
获取或设置一个值,该值指示焦点是否受限于游戏板/远程交互) 的控制边界 (。 (继承自 Control) |
IsFocusEngagementEnabled |
获取或设置一个值,该值指示是否可以在游戏板/远程交互) (控制边界内限制焦点。 (继承自 Control) |
IsFullWindow |
获取或设置一个值,该值指定 MediaPlayerElement 是否以全屏模式呈现。 |
IsFullWindowProperty |
标识 IsFullWindow 依赖属性。 |
IsHitTestVisible |
获取或设置此 UIElement 的包含区域是否可以为命中测试返回 true 值。 (继承自 UIElement) |
IsHoldingEnabled |
获取或设置一个值,该值确定 Holding 事件是否可以源自该元素。 (继承自 UIElement) |
IsLoaded |
获取一个值,该值指示元素是否已添加到元素树中并已准备好进行交互。 (继承自 FrameworkElement) |
IsRightTapEnabled |
获取或设置一个值,该值确定 RightTapped 事件是否可以源自该元素。 (继承自 UIElement) |
IsTabStop |
获取或设置一个值,该值指示是否将某个控件包含在 Tab 导航中。 (继承自 Control) |
IsTapEnabled |
获取或设置一个值,该值确定 点击 事件是否可以源自该元素。 (继承自 UIElement) |
IsTextScaleFactorEnabled |
获取或设置是否启用自动文本放大,以反映系统文本大小设置。 (继承自 Control) |
KeyboardAcceleratorPlacementMode |
获取或设置一个值,该值指示控件 工具提示 是否显示其关联键盘快捷键的组合。 (继承自 UIElement) |
KeyboardAcceleratorPlacementTarget |
获取或设置一个值,该值指示显示快捷键组合的控件 工具提示 。 (继承自 UIElement) |
KeyboardAccelerators |
获取使用键盘调用操作的组合键的集合。 加速键通常分配给按钮或菜单项。
|
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) |
MediaPlayer |
获取用于呈现媒体 的 MediaPlayer 实例。 |
MediaPlayerProperty |
标识 MediaPlayer 依赖属性。 |
MinHeight |
获取或设置 FrameworkElement 的最小高度约束。 (继承自 FrameworkElement) |
MinWidth |
获取或设置 FrameworkElement 的最小宽度约束。 (继承自 FrameworkElement) |
Name |
获取或设置对象的标识名称。 当 XAML 处理器从 XAML 标记创建对象树时,运行时代码可以按此名称引用 XAML 声明的对象。 (继承自 FrameworkElement) |
Opacity |
获取或设置对象的不透明度程度。 (继承自 UIElement) |
OpacityTransition |
获取或设置对 Opacity 属性的更改进行动画处理的 ScalarTransition。 (继承自 UIElement) |
Padding |
获取或设置控件内部的填充边距。 (继承自 Control) |
Parent |
获取对象树中此 FrameworkElement 的父对象。 (继承自 FrameworkElement) |
PointerCaptures |
获取所有捕获的指针的集合,表示为 Pointer 值。 (继承自 UIElement) |
PosterSource |
获取或设置在 MediaPlayerElement 加载转换状态期间用于占位符图像的图像源。 |
PosterSourceProperty |
标识 PosterSource 依赖属性。 |
Projection |
获取或设置呈现此元素时要应用的透视投影 (三维效果) 。 (继承自 UIElement) |
RenderSize |
获取 UIElement 的最终呈现大小。 不建议使用,请参阅备注。 (继承自 UIElement) |
RenderTransform |
获取或设置影响 UIElement 呈现位置的转换信息。 (继承自 UIElement) |
RenderTransformOrigin |
获取或设置 RenderTransform 声明的任何可能呈现转换相对于 UIElement 边界的原点。 (继承自 UIElement) |
RequestedTheme |
获取或设置 UIElement (使用的 UI 主题及其子元素) 用于资源确定。 使用 RequestedTheme 指定的 UI 主题可以替代应用级 RequestedTheme。 (继承自 FrameworkElement) |
RequiresPointer |
获取或设置 UI 元素是否支持鼠标模式,该模式模拟非指针输入设备(如游戏板或遥控器)的指针交互体验。 (继承自 Control) |
Resources |
获取本地定义的资源字典。 在 XAML 中,可以通过 XAML 隐式集合语法将资源项建立为属性元素的 |
Rotation |
获取或设置顺时针旋转的角度(以度为单位)。 相对于 RotationAxis 和 CenterPoint 旋转。 影响元素的呈现位置。 (继承自 UIElement) |
RotationAxis |
获取或设置旋转元素的轴。 (继承自 UIElement) |
RotationTransition |
获取或设置 ScalarTransition,该 ScalarTransition 对 Rotation 属性的更改进行动画处理。 (继承自 UIElement) |
Scale |
获取或设置 元素的刻度。 相对于元素的 CenterPoint 缩放。 影响元素的呈现位置。 (继承自 UIElement) |
ScaleTransition |
获取或设置 Vector3Transition,该 Vector3Transition 对 Scale 属性的更改进行动画处理。 (继承自 UIElement) |
Shadow |
获取或设置 由 元素投射的阴影效果。 (继承自 UIElement) |
Source |
获取或设置 MediaPlayerElement 上的媒体源。 |
SourceProperty |
标识 Source 依赖属性。 |
Stretch |
获取或设置一个值,该值描述应如何拉伸 MediaPlayerElement 以填充目标矩形。 |
StretchProperty |
标识 Stretch 依赖属性。 |
Style |
获取或设置在布局和呈现期间为此对象应用的实例 Style 。 (继承自 FrameworkElement) |
TabFocusNavigation |
获取或设置一个值,该值修改 tabbing 和 TabIndex 对此控件的工作方式。 (继承自 UIElement) |
TabIndex |
获取或设置一个值,该值指示当用户使用 Tab 键浏览应用 UI 时元素接收焦点的顺序。 (继承自 Control) |
TabNavigation |
获取或设置一个值,该值修改 tabbing 和 TabIndex 对此控件的工作方式。 注意 对于Windows 10 创意者更新 (内部版本 10.0.15063) 及更新版本,TabFocusNavigation 属性在 UIElement 基类上可用,以包括选项卡序列中不使用 ControlTemplate 的对象。 |
Tag |
获取或设置可用于存储有关此对象的自定义信息的任意对象值。 (继承自 FrameworkElement) |
Template |
获取或设置控件模板。 控件模板在 UI 中定义控件的视觉外观,并在 XAML 标记中定义。 (继承自 Control) |
Transform3D |
获取或设置呈现此元素时要应用的三维转换效果。 (继承自 UIElement) |
TransformMatrix |
获取或设置要应用于 元素的转换矩阵。 (继承自 UIElement) |
Transitions |
获取或设置应用于 UIElement 的 Transition 样式元素的集合。 (继承自 UIElement) |
Translation |
获取或设置元素的 x、y 和 z 呈现位置。 (继承自 UIElement) |
TranslationTransition |
获取或设置对 Translation 属性的更改进行动画处理的 Vector3Transition。 (继承自 UIElement) |
TransportControls |
获取或设置媒体的传输控件。 |
Triggers |
获取为 FrameworkElement 定义的动画触发器的集合。 不常用。 请参阅“备注”。 (继承自 FrameworkElement) |
UIContext |
获取 元素的上下文标识符。 (继承自 UIElement) |
UseLayoutRounding |
获取或设置一个值,该值确定对象及其可视子树的呈现是否应使用将呈现与整个像素对齐的舍入行为。 (继承自 UIElement) |
UseSystemFocusVisuals |
获取或设置一个值,该值指示控件是使用系统绘制的焦点视觉对象还是控件模板中定义的视觉对象。 (继承自 Control) |
VerticalAlignment |
获取或设置在父对象(如面板或项控件)中组合时应用于 FrameworkElement 的垂直对齐特征。 (继承自 FrameworkElement) |
VerticalContentAlignment |
获取或设置控件内容的垂直对齐方式。 (继承自 Control) |
Visibility |
获取或设置 UIElement 的可见性。 不可见的 UIElement 不会呈现,也不会将其所需大小传达给布局。 (继承自 UIElement) |
Width |
获取或设置 FrameworkElement 的宽度。 (继承自 FrameworkElement) |
XamlRoot |
获取或设置 |
XYFocusDown |
获取或设置当用户按下方向键 (方向键) 时获取焦点的对象。 (继承自 Control) |
XYFocusDownNavigationStrategy |
获取或设置一个值,该值指定用于确定向下导航的目标元素的策略。 (继承自 UIElement) |
XYFocusKeyboardNavigation |
获取或设置一个值,该值使用键盘方向箭头启用或禁用导航。 (继承自 UIElement) |
XYFocusLeft |
获取或设置当用户向左按方向键 (方向键时获取焦点的对象) 。 (继承自 Control) |
XYFocusLeftNavigationStrategy |
获取或设置一个值,该值指定用于确定左侧导航的目标元素的策略。 (继承自 UIElement) |
XYFocusRight |
获取或设置当用户向右按方向键 (方向键时获取焦点的对象) 。 (继承自 Control) |
XYFocusRightNavigationStrategy |
获取或设置一个值,该值指定用于确定右导航目标元素的策略。 (继承自 UIElement) |
XYFocusUp |
获取或设置当用户按下方向键 (方向键) 时获取焦点的对象。 (继承自 Control) |
XYFocusUpNavigationStrategy |
获取或设置一个值,该值指定用于确定向上导航目标元素的策略。 (继承自 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) |
FocusDisengaged |
当焦点从游戏板/远程交互) 的控制边界 (释放时发生。 (继承自 Control) |
FocusEngaged |
当焦点限制在游戏板/远程交互) 的控制边界 (时发生。 (继承自 Control) |
GettingFocus |
在 UIElement 接收焦点之前发生。 此事件是同步引发的,以确保在事件冒泡时不会移动焦点。 (继承自 UIElement) |
GotFocus |
在 UIElement 收到焦点时发生。 此事件是异步引发的,因此焦点可以在浮升完成之前再次移动。 (继承自 UIElement) |
Holding |
当此元素的命中测试区域发生其他未处理的 保持 交互时发生。 (继承自 UIElement) |
IsEnabledChanged |
在 IsEnabled 属性更改时发生。 (继承自 Control) |
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 |
在释放之前启动 Press 操作的指针设备时发生,而此元素中。 请注意, 不保证按下 操作的结束会触发 PointerReleased 事件;其他事件可能会改为触发。 有关详细信息,请参阅备注。 (继承自 UIElement) |
PointerWheelChanged |
当指针滚轮的增量值更改时发生。 (继承自 UIElement) |
PreviewKeyDown |
在 UIElement 具有焦点时按下键盘键时发生。 (继承自 UIElement) |
PreviewKeyUp |
在 UIElement 具有焦点时释放键盘键时发生。 (继承自 UIElement) |
ProcessKeyboardAccelerators |
按下 键盘快捷方式 (或快捷键) 时发生。 (继承自 UIElement) |
RightTapped |
当指针位于 元素上时发生右点击输入刺激时发生。 (继承自 UIElement) |
SizeChanged |
当 ActualHeight 或 ActualWidth 属性更改 FrameworkElement 上的值时发生。 (继承自 FrameworkElement) |
Tapped |
在此元素的命中测试区域上发生其他未经处理的 点击 交互时发生。 (继承自 UIElement) |
Unloaded |
当此对象不再连接到main对象树时发生。 (继承自 FrameworkElement) |
适用于
另请参阅
反馈
https://aka.ms/ContentUserFeedback。
即将发布:在整个 2024 年,我们将逐步淘汰作为内容反馈机制的“GitHub 问题”,并将其取代为新的反馈系统。 有关详细信息,请参阅:提交和查看相关反馈