Setter 类

定义

命名空间:

Windows.UI.Xaml

将值应用于 Style 或 VisualState 中的属性。

public ref class Setter sealed : SetterBase

/// [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(Windows.UI.Xaml.ISetterFactory, 65536, "Windows.Foundation.UniversalApiContract")]
/// [Windows.Foundation.Metadata.Activatable(65536, "Windows.Foundation.UniversalApiContract")]
class Setter final : SetterBase

[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(typeof(Windows.UI.Xaml.ISetterFactory), 65536, "Windows.Foundation.UniversalApiContract")]
[Windows.Foundation.Metadata.Activatable(65536, "Windows.Foundation.UniversalApiContract")]
public sealed class Setter : SetterBase

Public NotInheritable Class Setter
Inherits SetterBase

<Setter .../>

继承

Object Platform::Object IInspectable DependencyObject SetterBase Setter

属性

ActivatableAttribute ContractVersionAttribute MarshalingBehaviorAttribute ThreadingAttribute

Windows 要求

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

示例

此示例演示如何以 TextBlock 元素的样式使用 Setter 语句。

<StackPanel>
    <StackPanel.Resources>
        <!-- Create a Style for a TextBlock to specify that the
             Foreground equals Navy, FontSize equals 14, and
             VerticalAlignment equals Bottom. -->
        <Style TargetType="TextBlock" x:Key="TextBlockStyle">
            <Setter Property="Foreground" Value="Navy"/>
            <Setter Property="FontSize" Value="14"/>
            <Setter Property="VerticalAlignment" Value="Bottom"/>
        </Style>
    </StackPanel.Resources>

    <!-- Apply the TextBlockStyle to 2 different TextBlocks. -->
    <TextBlock Style="{StaticResource TextBlockStyle}" Text="Hello"/>
    <TextBlock Style="{StaticResource TextBlockStyle}" Text="World"/>
</StackPanel>

此示例演示如何在 VisualState.Setters 属性中使用多个 Setter 语句对各种元素应用离散属性值更改， (应用 VisualState 时无需动画) 。

<Page>
    <Grid Background="{ThemeResource ApplicationPageBackgroundThemeBrush}">
        <VisualStateManager.VisualStateGroups>
            <VisualStateGroup>
                <VisualState x:Name="NarrowState">
                    <VisualState.Setters>
                        <Setter Target="myPanel.Orientation" Value="Vertical"/>
                        <Setter Target="myPanel.Width" Value="380"/>
                        <Setter Target="myTextBlock.MaxLines" Value="3"/>
                    </VisualState.Setters>
                </VisualState>
            </VisualStateGroup>
        </VisualStateManager.VisualStateGroups>

        <StackPanel x:Name="myPanel" Orientation="Horizontal">
            <TextBlock x:Name="myTextBlock" MaxLines="5" Style="{ThemeResource BodyTextBlockStyle}"/>
        </StackPanel>
    </Grid>
</Page>

还可以通过在 AttachedPropertyProvider 中指定附加的属性名称，将 setter 应用于附加的属性值。PropertyName 窗体。 例如，若要对附加属性 Canvas.Left 使用 Setter，请使用此 XAML。

<Setter Property="Canvas.Left" Value="100"/>

若要使用 Target更新附加属性的值，请将附加属性路径放在括号内。 此示例演示如何更新 RelativePanel.AlignRightWithPanel 名为“TitleTextBlock”的元素上的值。

<RelativePanel>
    <TextBlock x:Name="TitleTextBlock" Text="Title"/>
</RelativePanel>

...

<Setter Target="TitleTextBlock.(RelativePanel.AlignRightWithPanel)" Value="True"/>

注解

使用 Setter 语句在 Style 或 VisualState 中设置属性值。

Setter.Target 属性可以在 Style 或 VisualState 中使用，但以不同的方式使用。 在 Style 中使用时，可以直接指定需要修改的属性。 在 VisualState 中使用时，必须为 Target 属性提供 TargetPropertyPath (点状语法，并且目标元素和属性显式指定) 。

Setter.Property 属性只能在 Style 中使用，不能在 VisualState 中使用。 从 Windows 10 开始，可以在任何位置使用 Setter.Target，而不是 Setter.Property。

必须在 Setter 上同时指定“值”和“目标”或“属性”。 否则，将引发异常 (分析异常或运行时错误，具体取决于是使用 XAML 创建 Setter 还是在代码) 中修改。

如果使用代码访问 Setter 实例，则如果父 Style 上的 IsSealed 属性的值为 true，则无法更改 Setter 实例的任何属性的值。 单个 Setter 上的 IsSealed 属性也报告了这一点。 当运行时将样式应用于 UI 元素并在 UI 中显示它们时，系统会将这些属性设置为 true 。 尝试更改密封的 Setter 会引发运行时错误。

迁移说明

• Windows Presentation Foundation (WPF) 和 Microsoft Silverlight 支持使用 Binding 表达式为 Style 中的 Setter 提供值的功能。 Windows 运行时不支持 Setter.Value 的绑定用法， (绑定不会评估并且 Setter 不起作用，你不会收到错误，但你不会) 得到所需的结果。 从 Windows Presentation Foundation (WPF) 或 Microsoft Silverlight XAML 转换 XAML 样式时，请将任何 Binding 表达式用法替换为设置值的字符串或对象，或将值重构为共享 {StaticResource} 标记扩展值，而不是绑定获取的值。

构造函数

Setter()	初始化不带初始属性或 Value 的 Setter 类的新实例。
Setter(DependencyProperty, Object)	使用初始属性和值信息初始化 Setter 类的新实例。

属性

Dispatcher	获取与此对象关联的 CoreDispatcher 。 CoreDispatcher 表示可以访问 UI 线程上的 DependencyObject 的工具，即使代码是由非 UI 线程启动的。 (继承自 DependencyObject)
IsSealed	获取一个值，该值指示此对象是否为不可变状态。 (继承自 SetterBase)
Property	获取或设置要应用 Value 的属性。
Target	获取或设置目标元素上要应用 Value 的属性的路径。
Value	获取或设置要应用于 Setter 指定的属性的值。

方法

ClearValue(DependencyProperty)	清除依赖属性的本地值。 (继承自 DependencyObject)
GetAnimationBaseValue(DependencyProperty)	返回为依赖属性建立的任何基值，该基值适用于动画未处于活动状态的情况。 (继承自 DependencyObject)
GetValue(DependencyProperty)	从 DependencyObject 返回依赖属性的当前有效值。 (继承自 DependencyObject)
ReadLocalValue(DependencyProperty)	如果设置了本地值，则返回依赖属性的本地值。 (继承自 DependencyObject)
RegisterPropertyChangedCallback(DependencyProperty, DependencyPropertyChangedCallback)	注册通知函数，用于侦听此 DependencyObject 实例上对特定 DependencyProperty 的更改。 (继承自 DependencyObject)
SetValue(DependencyProperty, Object)	设置 DependencyObject 上依赖属性的本地值。 (继承自 DependencyObject)
UnregisterPropertyChangedCallback(DependencyProperty, Int64)	取消以前通过调用 RegisterPropertyChangedCallback 注册的更改通知。 (继承自 DependencyObject)

另请参阅

• SetterBase
• TargetPropertyPath
• Setters
• Style
• 迁移或 XAML/代码到