ToggleButton 类2

最新推荐文章于 2025-03-18 16:59:52 发布

转载最新推荐文章于 2025-03-18 16:59:52 发布 · 945 阅读

文章标签：

#silverlight #object #radiobutton #triggers #windows phone #command

本文介绍了如何在WPF中创建一个支持两种或三种状态的切换按钮，详细解释了三态按钮的工作原理及其实现方法。

可切换状态的控件的基类，例如 CheckBox 和 RadioButton。

继承层次结构

System.Object
   System.Windows.DependencyObject
     System.Windows.UIElement
       System.Windows.FrameworkElement
         System.Windows.Controls.Control
           System.Windows.Controls.ContentControl
             System.Windows.Controls.Primitives.ButtonBase
               System.Windows.Controls.Primitives.ToggleButton
                 更多...

命名空间： System.Windows.Controls.Primitives
程序集： System.Windows（在 System.Windows.dll 中）

语法

复制

[TemplateVisualStateAttribute(Name = "Normal", GroupName = "CommonStates")]
[TemplateVisualStateAttribute(Name = "MouseOver", GroupName = "CommonStates")]
[TemplateVisualStateAttribute(Name = "Pressed", GroupName = "CommonStates")]
[TemplateVisualStateAttribute(Name = "Disabled", GroupName = "CommonStates")]
[TemplateVisualStateAttribute(Name = "Unfocused", GroupName = "FocusStates")]
[TemplateVisualStateAttribute(Name = "Focused", GroupName = "FocusStates")]
[TemplateVisualStateAttribute(Name = "Checked", GroupName = "CheckStates")]
[TemplateVisualStateAttribute(Name = "Unchecked", GroupName = "CheckStates")]
[TemplateVisualStateAttribute(Name = "Indeterminate", GroupName = "CheckStates")]
public class ToggleButton : ButtonBase

XAML 对象元素用法

复制

<ToggleButton .../>
-or-
<ToggleButton>
  singleObject
</ToggleButton>
-or-
<ToggleButton>contentString</ToggleButton>

XAML 值

singleObject

一个声明内容的对象元素。

contentString

一个字符串，它显示为通过默认模板 ContentPresenter 的内容。有关更多信息，请参见 ContentControl 的“ContentControl 的字符串内容”部分。

ToggleButton 类型公开以下成员。

构造函数

	名称	说明
	ToggleButton	初始化 ToggleButton 类的新实例。

页首

属性

	名称	说明
	ActualHeight	获取 FrameworkElement 的呈现高度。（继承自 FrameworkElement。）
	ActualWidth	获取 FrameworkElement 的呈现宽度。（继承自 FrameworkElement。）
	AllowDrop	获取或设置一个值，该值确定此 UIElement 是否可用作 Silverlight 拖放操作的放目标。（继承自 UIElement。）
	Background	获取或设置一个用于提供控件背景的画笔。（继承自 Control。）
	BorderBrush	获取或设置一个用于描述控件的边框背景的画笔。（继承自 Control。）
	BorderThickness	获取或设置控件的边框宽度。（继承自 Control。）
	CacheMode	获取或设置一个值，该值指示应在可能时高速缓存已呈现内容。（继承自 UIElement。）
	CharacterSpacing	获取或设置以字体大小的千分之一为单位测量的控件中的文本字符之间的距离。（继承自 Control。）
	ClickMode	获取或设置 Click 事件何时发生。（继承自 ButtonBase。）
	Clip	获取或设置用于定义 UIElement 的内容边框的 Geometry。（继承自 UIElement。）
	Command	获取或设置当按此按钮时要调用的命令。（继承自 ButtonBase。）
	CommandParameter	获取或设置要传递给 Command 属性的参数。（继承自 ButtonBase。）
	Content	获取或设置 ContentControl 依赖项属性的值。（继承自 ContentControl。）
	ContentTemplate	获取或设置用于显示 ContentControl 内容的数据模板。（继承自 ContentControl。）
	Cursor	获取或设置鼠标指针悬停在 FrameworkElement 上时所显示的光标图像。（继承自 FrameworkElement。）
	DataContext	获取或设置 FrameworkElement 参与数据绑定时的数据上下文。（继承自 FrameworkElement。）
	DefaultStyleKey	获取或设置一个键，该键引用控件的默认样式。（继承自 Control。）
	DesiredSize	获取此 UIElement 在布局过程的测量处理过程中计算的大小。（继承自 UIElement。）
	Dispatcher	获取与此对象关联的 Dispatcher。（继承自 DependencyObject。）
	Effect	获取或设置用于呈现此 UIElement 的像素着色器效果。（继承自 UIElement。）
	FlowDirection	获取或设置文本和其他用户界面元素在控制其布局的任何父元素中的流动方向。（继承自 FrameworkElement。）
	FontFamily	获取或设置用于在控件中显示文本的字体。（继承自 Control。）
	FontSize	获取或设置此控件中文本的大小。（继承自 Control。）
	FontStretch	获取或设置字体在屏幕上的压缩或扩展程度。（继承自 Control。）
	FontStyle	获取或设置呈现文本时使用的样式。（继承自 Control。）
	FontWeight	获取或设置指定字体的粗细。（继承自 Control。）
	Foreground	获取或设置一个用于描述前景色的画笔。（继承自 Control。）
	Height	获取或设置 FrameworkElement 的建议高度。（继承自 FrameworkElement。）
	HorizontalAlignment	获取或设置在布局父级（如面板或项控件）中构成 FrameworkElement 时应用于此元素的水平对齐特征。（继承自 FrameworkElement。）
	HorizontalContentAlignment	获取或设置控件内容的水平对齐方式。（继承自 Control。）
	IsChecked	获取或设置是否选中 ToggleButton。
	IsEnabled	获取或设置一个值，该值指示用户是否可以与控件交互。（继承自 Control。）
	IsFocused	获取一个确定按钮是否具有焦点的值。（继承自 ButtonBase。）
	IsHitTestVisible	获取或设置此 UIElement 的包含区域是否可为命中测试返回 true 值。（继承自 UIElement。）
	IsMouseOver	获取一个指示鼠标指针是否位于此按钮控件上的值。（继承自 ButtonBase。）
	IsPressed	获取一个指示 ButtonBase 当前是否处于按下状态的值。（继承自 ButtonBase。）
	IsTabStop	获取或设置一个值，该值指示是否将某个控件包含在 Tab 导航中。（继承自 Control。）
	IsThreeState	获取或设置指示控件是支持两种状态还是三种状态的值。
	Language	获取或设置应用于 FrameworkElement 的本地化/全球化语言信息。（继承自 FrameworkElement。）
	Margin	获取或设置 FrameworkElement 的外边距。（继承自 FrameworkElement。）
	MaxHeight	获取或设置 FrameworkElement 的最大高度约束。（继承自 FrameworkElement。）
	MaxWidth	获取或设置 FrameworkElement 的最大宽度约束。（继承自 FrameworkElement。）
	MinHeight	获取或设置 FrameworkElement 的最小高度约束。（继承自 FrameworkElement。）
	MinWidth	获取或设置 FrameworkElement 的最小宽度约束。（继承自 FrameworkElement。）
	Name	获取或设置对象的标识名称。在 XAML 处理器从 XAML 标记创建对象树后，运行时代码可以使用此名称引用 XAML 声明的对象。（继承自 FrameworkElement。）
	Opacity	获取或设置对象的不透明度。（继承自 UIElement。）
	OpacityMask	获取或设置用于改变此对象区域的不透明度的画笔。（继承自 UIElement。）
	Padding	获取或设置控件内的边距。（继承自 Control。）
	Parent	获取对象树中此 FrameworkElement 的父对象。（继承自 FrameworkElement。）
	Projection	获取或设置在呈现此 UIElement 时要应用的透视投影（三维效果）。（继承自 UIElement。）
	RenderSize	获取 UIElement 的最终呈现大小。（继承自 UIElement。）
	RenderTransform	获取或设置影响 UIElement 的呈现位置的变换信息。（继承自 UIElement。）
	RenderTransformOrigin	获取或设置由 RenderTransform 声明的任何可能呈现变换的原点，相对于 UIElement 的边界。（继承自 UIElement。）
	Resources	获取本地定义的资源字典。在 XAML 中，可以通过 XAML 隐式集合语法，将资源项建立为 frameworkElement.Resources 属性元素的子对象元素。（继承自 FrameworkElement。）
	Style	获取或设置呈现过程中应用于此对象的实例 Style。（继承自 FrameworkElement。）
	TabIndex	获取或设置一个值，该值决定在用户使用 Tab 键在控件中导航时元素接收焦点的顺序。（继承自 Control。）
	TabNavigation	获取或设置一个值，该值修改 Tab 键和 TabIndex 针对此控件的工作方式。（继承自 Control。）
	Tag	获取或设置一个可用于存储有关此对象的自定义信息的任意对象值。（继承自 FrameworkElement。）
	Template	获取或设置控件模板。（继承自 Control。）
	Triggers	获取为 FrameworkElement 定义的动画的触发器的集合。（继承自 FrameworkElement。）
	UseLayoutRounding	获取或设置一个值，该值确定对象及其可视化子树的呈现是否应使用将呈现与整像素对齐的舍入行为。（继承自 UIElement。）
	VerticalAlignment	获取或设置在父对象（如面板或项控件）中构成 FrameworkElement 时应用于此元素的垂直对齐特征。（继承自 FrameworkElement。）
	VerticalContentAlignment	获取或设置控件内容的垂直对齐方式。（继承自 Control。）
	Visibility	获取或设置 UIElement 的可见性。不可见的 UIElement 不呈现，也不将其所需大小告知布局。（继承自 UIElement。）
	Width	获取或设置 FrameworkElement 的宽度。（继承自 FrameworkElement。）

页首

方法

	名称	说明
	AddHandler	为指定的路由事件添加路由事件处理程序，并将该处理程序添加到当前元素的处理程序集合中。将 handledEventsToo 指定为 true 时，可为已标记为由其他元素在事件路由过程中处理的路由事件调用所提供的处理程序。（继承自 UIElement。）
	ApplyTemplate	加载相关的控件模板，以便可以引用其部件。（继承自 Control。）
	Arrange	定位子对象并确定 UIElement 的大小。为其子元素实现自定义布局的父对象应从其布局重写实现调用此方法以形成递归布局更新。（继承自 UIElement。）
	ArrangeOverride	提供 Silverlight 布局的排列处理过程的行为。类可以重写该方法来定义其自己的排列处理过程行为。（继承自 FrameworkElement。）
	CaptureMouse	将鼠标捕获设置为 UIElement。（继承自 UIElement。）
	CheckAccess	确定调用线程是否可以访问此对象。（继承自 DependencyObject。）
	ClearValue	清除依赖项属性的本地值。（继承自 DependencyObject。）
	Equals(Object)	确定指定的 Object 是否等于当前的 Object。（继承自 Object。）
	Finalize	允许对象在垃圾回收对 Object 进行回收之前尝试释放资源并执行其他清理操作。（继承自 Object。）
	FindName	检索具有指定标识符名称的对象。（继承自 FrameworkElement。）
	Focus	尝试设置控件的焦点。（继承自 Control。）
	GetAnimationBaseValue	返回为 Silverlight 依赖项属性设置的任意基值，在动画不活动时将应用它们。（继承自 DependencyObject。）
	GetBindingExpression	检索 BindingExpression 中已建立绑定的依赖项属性。（继承自 FrameworkElement。）
	GetHashCode	用作特定类型的哈希函数。（继承自 Object。）
	GetTemplateChild	在实例化的 ControlTemplate 可视化树中检索已命名的元素。（继承自 Control。）
	GetType	获取当前实例的 Type。（继承自 Object。）
	GetValue	从 DependencyObject 返回依赖项属性的当前有效值。（继承自 DependencyObject。）
	InvalidateArrange	使 UIElement 的排列状态（布局）无效。使其无效后，将会更新 UIElement 的布局（以异步方式进行）。（继承自 UIElement。）
	InvalidateMeasure	使 UIElement 的测量状态（布局）无效。（继承自 UIElement。）
	Measure	更新 UIElement 的 DesiredSize。一般地，实现其布局子级的自定义布局的对象从自己的 MeasureOverride 实现调用此方法以形成递归布局更新。（继承自 UIElement。）
	MeasureOverride	提供 Silverlight 布局的度量处理过程的行为。类可以重写该方法来定义其自己的度量处理过程行为。（继承自 FrameworkElement。）
	MemberwiseClone	创建当前 Object 的浅表副本。（继承自 Object。）
	OnApplyTemplate	当应用新模板时生成 Slider 控件的可视化树。（继承自 ButtonBase。）在 Silverlight for Windows Phone 中，此成员由 OnApplyTemplate 重写。
	OnClick	当通过鼠标或键盘单击 ToggleButton 时调用。（重写 ButtonBase.OnClick。）
	OnContentChanged	当 ContentControl 属性更改时调用。（重写 ContentControl.OnContentChanged(Object, Object)。）
	OnCreateAutomationPeer	返回一个供 Silverlight 自动化基础结构使用的 ToggleButtonAutomationPeer。（重写 UIElement.OnCreateAutomationPeer。）
	OnDoubleTap	在 DoubleTap 事件发生之前调用。（继承自 Control。）
	OnDragEnter	在 DragEnter 事件发生之前调用。（继承自 Control。）
	OnDragLeave	在 DragLeave 事件发生之前调用。（继承自 Control。）
	OnDragOver	在 DragOver 事件发生之前调用。（继承自 Control。）
	OnDrop	在 Drop 事件发生之前调用。（继承自 Control。）
	OnGotFocus	为 GotFocus 事件提供处理。（继承自 ButtonBase。）
	OnHold	在 Hold 事件发生之前调用。（继承自 Control。）
	OnIsPressedChanged	当 IsPressed 属性的值更改时调用。（继承自 ButtonBase。）
	OnKeyDown	为在此控件具有焦点的情况下用户按任意键时发生的 KeyDown 事件提供类处理。（继承自 ButtonBase。）
	OnKeyUp	为在此控件有焦点的情况下用户释放任意键时发生的 KeyUp 路由事件提供类处理。（继承自 ButtonBase。）
	OnLostFocus	为 LostFocus 事件提供处理。（继承自 ButtonBase。）
	OnLostMouseCapture	为 LostMouseCapture 事件提供处理。（继承自 ButtonBase。）
	OnManipulationCompleted	在 ManipulationCompleted 事件发生之前调用。（继承自 Control。）
	OnManipulationDelta	在 ManipulationDelta 事件发生之前调用。（继承自 Control。）
	OnManipulationStarted	在 ManipulationStarted 事件发生之前调用。（继承自 Control。）
	OnMouseEnter	为当鼠标进入此控件时发生的 MouseEnter 事件提供类处理。（继承自 ButtonBase。）
	OnMouseLeave	为当鼠标离开元素时发生的 MouseLeave 路由事件提供类处理。（继承自 ButtonBase。）
	OnMouseLeftButtonDown	为在鼠标指针悬停在此控件上的情况下按下鼠标左键时发生的 MouseLeftButtonDown 事件提供类处理。（继承自 ButtonBase。）
	OnMouseLeftButtonUp	为在鼠标指针悬停在此控件上的情况下松开鼠标左键时发生的 MouseLeftButtonUp 事件提供类处理。（继承自 ButtonBase。）
	OnMouseMove	为在鼠标指针悬停在此元素上的情况下移动鼠标指针时发生的 MouseMove 事件提供类处理。（继承自 ButtonBase。）
	OnMouseRightButtonDown	在 MouseRightButtonDown 事件发生之前调用。（继承自 Control。）
	OnMouseRightButtonUp	在 MouseRightButtonUp 事件发生之前调用。（继承自 Control。）
	OnMouseWheel	在 MouseWheel 事件发生之前调用，用于在不附加委托的情况下为派生类中的事件提供处理。（继承自 Control。）
	OnTap	在 Tap 事件发生之前调用。（继承自 Control。）
	OnTextInput	在 TextInput 事件发生之前调用。（继承自 Control。）
	OnTextInputStart	在 TextInputStart 事件发生之前调用。（继承自 Control。）
	OnTextInputUpdate	在 TextInputUpdate 事件发生之前调用。（继承自 Control。）
	OnToggle	由 OnClick 方法调用以实现切换行为。
	ReadLocalValue	返回依赖项属性的本地值（如果设置了本地值）。（继承自 DependencyObject。）
	ReleaseMouseCapture	从 UIElement 中移除鼠标捕获。在此调用后，一般没有对象具有鼠标捕获。（继承自 UIElement。）
	RemoveHandler	从此 UIElement 中移除指定的路由事件处理程序。（继承自 UIElement。）
	SetBinding	使用提供的绑定对象，将绑定附加到 FrameworkElement 上，并返回 BindingExpressionBase 以供以后使用。（继承自 FrameworkElement。）
	SetValue	对 DependencyObject 设置依赖项属性的本地值。（继承自 DependencyObject。）
	ToString	返回 ToggleButton 对象的字符串表示形式。（重写 Object.ToString。）
	TransformToVisual	返回一个变换对象，该变换对象可用于将 UIElement 中的坐标变换为指定的对象。（继承自 UIElement。）
	UpdateLayout	请确保 UIElement 的所有子对象位置都正确地进行了布局更新。（继承自 UIElement。）

页首

事件

	名称	说明
	BindingValidationError	在绑定源报告数据验证错误时发生。（继承自 FrameworkElement。）
	Checked	在选中 ToggleButton 时发生。
	Click	在单击 Button 时发生。（继承自 ButtonBase。）
	DataContextChanged	当此元素的数据上下文更改时发生。（继承自 FrameworkElement。）
	DoubleTap	在此 UIElement 上方提交 DoubleTap 手势时发生。（继承自 UIElement。）
	DragEnter	在输入系统报告将此元素作为目标的基础拖动事件时发生。（继承自 UIElement。）
	DragLeave	在输入系统报告将此元素作为来源的基础拖动事件时发生。（继承自 UIElement。）
	DragOver	在输入系统报告将此元素作为潜在放置目标的基础拖动事件时发生。（继承自 UIElement。）
	Drop	在输入系统报告将此元素作为放置目标的基础放置事件时发生。（继承自 UIElement。）
	GotFocus	当 UIElement 收到焦点时发生。（继承自 UIElement。）
	Hold	在此 UIElement 上方提交 Hold 手势时发生。（继承自 UIElement。）
	Indeterminate	当 ToggleButton 的状态切换到不确定状态时发生。
	IsEnabledChanged	当 IsEnabled 属性更改时发生。（继承自 Control。）
	KeyDown	在 UIElement 具有焦点的情况下按下键盘上的某个键时发生。（继承自 UIElement。）
	KeyUp	在 UIElement 具有焦点的情况下释放键盘上的某个键时发生。（继承自 UIElement。）
	LayoutUpdated	当 Silverlight 可视化树的布局更改时发生。（继承自 FrameworkElement。）
	Loaded	当已构造 FrameworkElement 并将其添加到对象树中时发生。（继承自 FrameworkElement。）
	LostFocus	当 UIElement 失去焦点时发生。（继承自 UIElement。）
	LostMouseCapture	在 UIElement 失去鼠标捕获时发生。（继承自 UIElement。）
	ManipulationCompleted	对于 UIElement 的操作和延时完毕时发生。（继承自 UIElement。）
	ManipulationDelta	当输入设备在操作期间更改位置时发生。（继承自 UIElement。）
	ManipulationStarted	当输入设备对 UIElement 开始操作时发生。（继承自 UIElement。）
	MediaCommand	在按下遥控器上的某个按钮时发生。（继承自 UIElement。）
	MouseEnter	当鼠标（或触笔）进入 UIElement 的边界区域时发生。（继承自 UIElement。）
	MouseLeave	当鼠标（或触笔）离开 UIElement 的边界区域时发生。（继承自 UIElement。）
	MouseLeftButtonDown	当按下鼠标左键（或触笔的笔尖接触 Tablet）并且鼠标指针悬停在 UIElement 上时发生。（继承自 UIElement。）
	MouseLeftButtonUp	当鼠标（或触笔）悬停在 UIElement 上（或 UIElement 具有鼠标捕获）并且用户松开鼠标左键（或从 Tablet 上移开触笔的笔尖）时发生。（继承自 UIElement。）
	MouseMove	当鼠标（或触笔）的坐标位置更改并且悬停在 UIElement 上（或 UIElement 具有鼠标捕获）时发生。（继承自 UIElement。）
	MouseRightButtonDown	当鼠标指针位于 UIElement 上并按下鼠标右键时发生。（继承自 UIElement。）
	MouseRightButtonUp	当鼠标指针位于 UIElement 上并释放鼠标右键时发生。但是，只有在调用方将前面的 MouseRightButtonDown 事件标记为“已处理”时才引发此事件；请参见“备注”。（继承自 UIElement。）
	MouseWheel	在以下情况下发生：当鼠标指针悬停在 UIElement 上时或 UIElement 具有焦点时，用户滚动鼠标滚轮。（继承自 UIElement。）
	SizeChanged	当 FrameworkElement 上的 ActualHeight 或 ActualWidth 属性的值发生更改时发生。（继承自 FrameworkElement。）
	Tap	在此 UIElement 上方提交 Tap 手势时发生。（继承自 UIElement。）
	TextInput	在 UI 元素以与设备无关的方式获取文本时发生。（继承自 UIElement。）
	TextInputStart	在 UI 元素以与设备无关的方式最初获取文本时发生。（继承自 UIElement。）
	TextInputUpdate	当通过输入方法编辑器 (IME) 继续编写文本时发生。（继承自 UIElement。）
	Unchecked	在未选中 ToggleButton 时发生。
	Unloaded	当此对象不再与主对象树连接时发生。（继承自 FrameworkElement。）

页首

字段

	名称	说明
	IsCheckedProperty	标识 IsChecked 依赖项属性。
	IsThreeStateProperty	标识 IsThreeState 依赖项属性。

页首

备注

IsChecked 属性指定 ToggleButton 的状态。 IsThreeState 属性指定 ToggleButton 是具有两种状态还是三种状态。如果 ToggleButton 配置为具有三种状态，则它允许用户选择第三种不确定状态。例如，您可以使用一个三态切换按钮来指示"是"、"否"或"不适用"。

内容模型： ToggleButton 为 ContentControl。其内容属性为 Content。有关更多信息，请参见控件内容模型。

示例

下面的示例演示如何创建一个三态 ToggleButton 控件。

运行此示例

XAML

复制

<ToggleButton Margin="5" Content="Three State" Width="150" IsThreeState="True"/>
<ToggleButton Margin="5" Content="Two State" Width="150" IsThreeState="False" />