本文转载自silvergingko的专栏
在Xaml中定义了一个元素后,如果后面要使用该元素,则必须为该元素定义一个元素名称,在随后的Xaml中,通过元素名称来使用该元素。
在Xaml中,元素的名称定义有两种方式:
1、通过Xaml的标记特性x:Name指定;
2、通过WPF的依赖项属性Name指定。
- <!--Xaml code-->
- <StackPanel Name="stackPanel">
- <!--在StackPanel中定义两个椭圆,并为它们指定名称为ellipseOne和ellipseTwo,
- 使用不同的填充色来区别这两个椭圆。随后的两个椭圆ellipseThree和ellipseFour,
- 它们的填充色分别与ellipseOne和ellipseTwo对应,通过WPF绑定机制实现-->
- <Ellipse x:Name="ellipseOne" Fill="AliceBlue" Width="50" Height="50"/>
- <Ellipse Name="ellipseTwo" Fill="AntiqueWhite" Width="50" Height="50"/>
- <Ellipse Name="ellipseThree" Width="50" Height="50"
- Fill="{Binding ElementName=ellipseOne, Path=Fill}"/>
- <Ellipse Name="ellipseFour" Width="50" Height="50"
- Fill="{Binding ElementName=ellipseTwo, Path=Fill}"/>
- </StackPanel>
当加载窗口时,响应窗口加载的Loaded事件,添加处理过程 Window_Loaded,在处理过程中通过代码,创建另外两个椭圆,
这两个椭圆ellipseFive和ellipseSix的填充色,也分别使用的是ellipseOne和ellipseTwo的填充色:
- //C# code
- private void Window_Loaded(object sender, RoutedEventArgs e)
- {
- //定义两个椭圆,并使用ellipseOne和ellipseTwo的填充色来分别填充这两个椭圆
- Ellipse ellipseFive = new Ellipse();
- Ellipse ellipseSix = new Ellipse();
- ellipseFive.Fill = ellipseOne.Fill;
- ellipseFive.Width = 50;
- ellipseFive.Height = 50;
- ellipseSix.Fill = ellipseTwo.Fill;
- ellipseSix.Width = 50;
- ellipseSix.Height = 50;
- stackPanel.Children.Add(ellipseFive);
- stackPanel.Children.Add(ellipseSix);
- }
运行时截图:
在以上的例子中,可以发现无论是通过x:Name还是Name来定义椭圆的名称,代码都能正常工作。因此,一般情况下,使用x:Name,还是Name,并无讲究。
x:Name与Name有两个不同点:
1、x:Name是Xaml的标记特性,任何在Xaml中定义的元素,都可以使用x:Name来为元素指定名称。
Name是FrameworkElement定义的依赖项属性(String类型),只有FrameworkElement的派生类才可以使用Name。
例如,Ellipse的Fill属性的类型是Brush,Brush不是FrameworkElement的子类,它没有Name属性。
因此,在Xaml中,为Brush指定名称时,只能使用x:Name标记特性:
- <!--Xaml code-->
- <Ellipse>
- <Ellipse.Fill>
- <SolidColorBrush x:Name="aliceBlue" Color="AliceBlue"/>
- <!--注销上面一行的代码,使用下面一行的代码无法通过编译-->
- <!--<SolidColorBrush Name="aliceBlue" Color="AliceBlue"/>-->
- </Ellipse.Fill>
- </Ellipse>
2、在FrameworkElement的定义中,添加了System.Windows.Markup.RuntimeNamePropertyAttribute特性:
- //C# code
- [RuntimeNamePropertyAttribute("Name")]
该特性的作用是,当在Xaml中,使用x:Name后,该值将被自动赋给FrameworkElement的Name属性。
可以使用RuntimeNamePropertyAttribut,为自己定义的类添加名称特性:
- //C# code
- [RuntimeNamePropertyAttribute("Nickname")]
- public class Person : UIElement
- {
- public String Nickname { get; set; }
- public String Name { get; set; }
- }
- <!--Xaml code-->
- <StackPanel>
- <Zyj:Person x:Name="小李探花"/>
- <TextBlock>Name:</TextBlock>
- <TextBlock Text="{Binding ElementName=小李探花, Path=Name}"/>
- <TextBlock>Nickname:</TextBlock>
- <TextBlock Text="{Binding ElementName=小李探花, Path=Nickname}"/>
- </StackPanel>
运行时截图:
在以上的例子中,Xaml中定义了一个Person元素,使用x:Name指定该元素为“小李探花”,在两个TextBlock中分别显示“小李探花.Name” 和“小李探花.Nickname”,
因为在Person的类定义中,将RuntimeNamePropertyAttribut特性指定到“Nickname”,因此x:Name的值被赋予给了Nickname属性。
RuntimeNamePropertyAttribut特性只能在类定义中使用:
- //C# code
- [AttributeUsageAttribute(AttributeTargets.Class)]
- public sealed class RuntimeNamePropertyAttribute : Attribute
RuntimeNamePropertyAttribut特性指定的属性可以是一般属性,依赖项属性不是必须的,尽管FrameworkElement.Name是一个依赖项属性。
在自己的类定义中,如果使用RuntimeNamePropertyAttribut特性,一般情况下,将它指定到类的Name属性,同FrameworkElement保持一致。
除了FrameworkElement类定义了Name属性以外,FrameworkContentElement也定义了Name属性,并使用了RuntimeNamePropertyAttribute特性。