FontIcon 类
定义
重要
一些信息与预发行产品相关，相应产品在发行之前可能会进行重大修改。 对于此处提供的信息，Microsoft 不作任何明示或暗示的担保。
表示使用指定字体中的字形的图标。
/// [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 FontIcon : IconElement[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 class FontIcon : IconElementPublic Class FontIcon
Inherits IconElement<FontIcon .../>
- 继承
- 属性
Windows 要求
| 设备系列 |
Windows 10 (在 10.0.10240.0 中引入)
|
| API contract |
Windows.Foundation.UniversalApiContract (在 v1.0 中引入)
|
示例
提示
有关详细信息、设计指南和代码示例，请参阅 命令栏。
WinUI 2 库应用包括大多数 WinUI 2 控件、特性和功能的交互式示例。 通过 Microsoft Store 获取应用，或在 GitHub 上获取源代码。
此示例演示具有 FontIcon 的 AppBarToggleButton 。
<AppBarToggleButton Label="FontIcon" Click="AppBarButton_Click">
<AppBarToggleButton.Icon>
<FontIcon FontFamily="Segoe MDL2 Assets" Glyph=""/>
</AppBarToggleButton.Icon>
</AppBarToggleButton>
var newAppBarButton = new AppBarButton();
var fontIcon = new FontIcon();
fontIcon.FontFamily = new FontFamily("Segoe MDL2 Assets");
fontIcon.Glyph = "\xE790";
newAppBarButton.Icon = fontIcon;
using namespace winrt::Windows::UI::Xaml;
...
auto newAppBarButton = Controls::AppBarButton{};
auto fontIcon = Controls::FontIcon{};
fontIcon.FontFamily(Media::FontFamily{ L"Segoe MDL2 Assets" });
fontIcon.Glyph(L"\xE790");
newAppBarButton.Icon(fontIcon);
注解
使用 FontIcon 使用 FontFamily 的字形值指定图标。 必须具有可供字形显示的字体。 字形值由字体开发人员分配给不映射到现有码位的专用 Unicode 值。 Windows 10使用 Segoe MDL2 Assets FontFamily，字形包含在 Symbol 枚举中。
可以将 MirroredWhenRightToLeft 属性设置为在 FlowDirection 为 RightToLeft 时镜像字形。 当 FontIcon 用于将图标显示为控件模板的一部分，并且该图标需要与控件的其余部分一起镜像时，通常会使用此属性。
注意
可以在 AppBarButton 或 FontIcon 上设置 Foreground 属性。 如果在 AppBarButton 上设置前台，则它仅应用于默认视觉状态。 它不适用于 AppBarButton 模板中定义的其他视觉状态，例如 MouseOver。 如果在 FontIcon 上设置 前景 ，则颜色将应用于所有视觉状态。
构造函数
| FontIcon() |
初始化 FontIcon 类的新实例。 |
属性
| 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) ，表示 XAML 加载时 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 |
获取与此对象关联的 CoreDispatcher 。 CoreDispatcher 表示可以访问 UI 线程上的 DependencyObject 的工具，即使代码是由非 UI 线程启动的。 (继承自 DependencyObject) |
| ExitDisplayModeOnAccessKeyInvoked |
获取或设置一个值，该值指定在调用访问密钥时是否消除访问键显示。 (继承自 UIElement) |
| FlowDirection |
获取或设置文本和其他 UI 元素在控制其布局的任何父元素中的流动方向。 此属性可以设置为 LeftToRight 或 RightToLeft。 在任何元素上将 FlowDirection 设置为 RightToLeft 会将对齐方式设置为右对齐，将阅读顺序设置为从右到左，并将控件的布局设置为从右到左流动。 (继承自 FrameworkElement) |
| FocusVisualMargin |
获取或设置 FrameworkElement 的焦点视觉对象的外部边距。 (继承自 FrameworkElement) |
| FocusVisualPrimaryBrush |
获取或设置用于为 FrameworkElement 绘制或 |
| FocusVisualPrimaryThickness |
获取或设置 FrameworkElement 或 |
| FocusVisualSecondaryBrush |
获取或设置用于为 FrameworkElement 绘制或 |
| FocusVisualSecondaryThickness |
获取或设置 FrameworkElement 或 |
| FontFamily |
获取或设置用于显示图标字形的字体。 |
| FontFamilyProperty |
获取 FontFamily 依赖属性的标识符。 |
| FontSize |
获取或设置图标字形的大小。 |
| FontSizeProperty |
获取 FontSize 依赖属性的标识符。 |
| FontStyle |
获取或设置图标字形的字体样式。 |
| FontStyleProperty |
获取 FontStyle 依赖属性的标识符。 |
| FontWeight |
获取或设置图标标志符号的粗细。 |
| FontWeightProperty |
获取 FontWeight 依赖属性的标识符。 |
| Foreground |
获取或设置一个用于描述前景色的画笔。 (继承自 IconElement) |
| Glyph |
获取或设置标识图标标志符号的字符代码。 |
| GlyphProperty |
获取 Glyph 依赖属性的标识符。 |
| Height |
获取或设置 FrameworkElement 的建议高度。 (继承自 FrameworkElement) |
| HighContrastAdjustment |
获取或设置一个值，该值指示在启用高对比度主题时框架是否自动调整元素的视觉属性。 (继承自 UIElement) |
| HorizontalAlignment |
获取或设置在布局父级（如面板或项控件）中组合时应用于 FrameworkElement 的水平对齐特征。 (继承自 FrameworkElement) |
| IsAccessKeyScope |
获取或设置一个值，该值指示元素是否定义其自己的访问键范围。 (继承自 UIElement) |
| IsDoubleTapEnabled |
获取或设置一个值，该值确定 DoubleTapped 事件是否可以源自该元素。 (继承自 UIElement) |
| IsHitTestVisible |
获取或设置此 UIElement 的包含区域是否可以为命中测试返回 true 值。 (继承自 UIElement) |
| IsHoldingEnabled |
获取或设置一个值，该值确定 Holding 事件是否可以源自该元素。 (继承自 UIElement) |
| IsLoaded |
获取一个值，该值指示元素是否已添加到元素树中并已准备好进行交互。 (继承自 FrameworkElement) |
| IsRightTapEnabled |
获取或设置一个值，该值确定 RightTapped 事件是否可以源自该元素。 (继承自 UIElement) |
| IsTapEnabled |
获取或设置一个值，该值确定 Tapped 事件是否可以源自该元素。 (继承自 UIElement) |
| IsTextScaleFactorEnabled |
获取或设置是否启用自动文本放大，以反映系统文本大小设置。 |
| IsTextScaleFactorEnabledProperty |
标识 IsTextScaleFactorEnabled 依赖属性。 |
| 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) |
| MinHeight |
获取或设置 FrameworkElement 的最小高度约束。 (继承自 FrameworkElement) |
| MinWidth |
获取或设置 FrameworkElement 的最小宽度约束。 (继承自 FrameworkElement) |
| MirroredWhenRightToLeft |
获取或设置一个值，该值指示 当 FlowDirection 为 RightToLeft 时图标是否镜像。 |
| MirroredWhenRightToLeftProperty |
标识 MirroredWhenRightToLeft 依赖属性。 |
| Name |
获取或设置对象的标识名称。 当 XAML 处理器从 XAML 标记创建对象树时，运行时代码可以按此名称引用 XAML 声明的对象。 (继承自 FrameworkElement) |
| Opacity |
获取或设置对象的不透明度的程度。 (继承自 UIElement) |
| OpacityTransition |
获取或设置对 Opacity 属性的更改进行动画处理的 ScalarTransition。 (继承自 UIElement) |
| Parent |
获取对象树中此 FrameworkElement 的父对象。 (继承自 FrameworkElement) |
| PointerCaptures |
获取所有捕获的指针的集合，表示为 Pointer 值。 (继承自 UIElement) |
| Projection |
获取或设置呈现此元素时要应用的透视投影 (三维效果) 。 (继承自 UIElement) |
| RenderSize |
获取 UIElement 的最终呈现大小。 不建议使用，请参阅备注。 (继承自 UIElement) |
| RenderTransform |
获取或设置影响 UIElement 呈现位置的转换信息。 (继承自 UIElement) |
| RenderTransformOrigin |
获取或设置 RenderTransform 声明的任何可能呈现转换相对于 UIElement 边界的原点。 (继承自 UIElement) |
| RequestedTheme |
获取或设置 UIElement (使用的 UI 主题及其子元素) 用于资源确定。 使用 RequestedTheme 指定的 UI 主题可以替代应用级 RequestedTheme。 (继承自 FrameworkElement) |
| Resources |
获取本地定义的资源字典。 在 XAML 中，可以通过 XAML 隐式集合语法将资源项建立为属性元素的 |
| Rotation |
获取或设置顺时针旋转的角度（以度为单位）。 相对于 RotationAxis 和 CenterPoint 旋转。 影响元素的呈现位置。 (继承自 UIElement) |
| RotationAxis |
获取或设置旋转元素的轴。 (继承自 UIElement) |
| RotationTransition |
获取或设置 ScalarTransition，该 ScalarTransition 对 Rotation 属性的更改进行动画处理。 (继承自 UIElement) |
| Scale |
获取或设置 元素的刻度。 相对于元素的 CenterPoint 缩放。 影响元素的呈现位置。 (继承自 UIElement) |
| ScaleTransition |
获取或设置 Vector3Transition，该 Vector3Transition 对 Scale 属性的更改进行动画处理。 (继承自 UIElement) |
| Shadow |
获取或设置 由 元素投射的阴影效果。 (继承自 UIElement) |
| Style |
获取或设置在布局和呈现期间为此对象应用的实例 Style 。 (继承自 FrameworkElement) |
| TabFocusNavigation |
获取或设置一个值，该值修改 tabbing 和 TabIndex 对此控件的工作方式。 (继承自 UIElement) |
| Tag |
获取或设置可用于存储有关此对象的自定义信息的任意对象值。 (继承自 FrameworkElement) |
| Transform3D |
获取或设置呈现此元素时要应用的三维转换效果。 (继承自 UIElement) |
| TransformMatrix |
获取或设置要应用于 元素的转换矩阵。 (继承自 UIElement) |
| Transitions |
获取或设置应用于 UIElement 的 Transition 样式元素的集合。 (继承自 UIElement) |
| Translation |
获取或设置元素的 x、y 和 z 呈现位置。 (继承自 UIElement) |
| TranslationTransition |
获取或设置对 Translation 属性的更改进行动画处理的 Vector3Transition。 (继承自 UIElement) |
| Triggers |
获取为 FrameworkElement 定义的动画触发器的集合。 不常用。 请参阅“备注”。 (继承自 FrameworkElement) |
| UIContext |
获取 元素的上下文标识符。 (继承自 UIElement) |
| UseLayoutRounding |
获取或设置一个值，该值确定对象及其可视子树的呈现是否应使用将呈现与整个像素对齐的舍入行为。 (继承自 UIElement) |
| VerticalAlignment |
获取或设置在父对象（如面板或项控件）中组合时应用于 FrameworkElement 的垂直对齐特征。 (继承自 FrameworkElement) |
| Visibility |
获取或设置 UIElement 的可见性。 不可见的 UIElement 不会呈现，也不会将其所需大小传达给布局。 (继承自 UIElement) |
| Width |
获取或设置 FrameworkElement 的宽度。 (继承自 FrameworkElement) |
| XamlRoot |
获取或设置 |
| XYFocusDownNavigationStrategy |
获取或设置一个值，该值指定用于确定向下导航的目标元素的策略。 (继承自 UIElement) |
| XYFocusKeyboardNavigation |
获取或设置一个值，该值使用键盘方向箭头启用或禁用导航。 (继承自 UIElement) |
| XYFocusLeftNavigationStrategy |
获取或设置一个值，该值指定用于确定左侧导航的目标元素的策略。 (继承自 UIElement) |
| XYFocusRightNavigationStrategy |
获取或设置一个值，该值指定用于确定右导航目标元素的策略。 (继承自 UIElement) |
| 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) |
| GettingFocus |
在 UIElement 接收焦点之前发生。 此事件是同步引发的，以确保在事件冒泡时不会移动焦点。 (继承自 UIElement) |
| GotFocus |
在 UIElement 接收焦点时发生。 此事件以异步方式引发，因此焦点可以在冒泡完成之前再次移动。 (继承自 UIElement) |
| Holding |
在此元素的命中测试区域上发生未处理的 保留 交互时发生。 (继承自 UIElement) |
| 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 |
当指针设备在此元素中启动 Press 操作时发生。 (继承自 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) |