FrameworkElement.Name プロパティ

定義

要素の識別名を取得または設定します。Gets or sets the identifying name of the element. この名前は参照を提供するため、イベント ハンドラー コードなどの分離コードは、XAMLXAML プロセッサによる処理の際に、構築された後のマークアップ要素を参照できます。The name provides a reference so that code-behind, such as event handler code, can refer to a markup element after it is constructed during processing by a XAMLXAML processor.

public:
 property System::String ^ Name { System::String ^ get(); void set(System::String ^ value); };
[System.Windows.Localizability(System.Windows.LocalizationCategory.NeverLocalize)]
public string Name { get; set; }
member this.Name : string with get, set
Public Property Name As String

プロパティ値

要素の名前。The name of the element. 既定値は空の文字列です。The default is an empty string.

実装

属性

次の例では、Name プロパティをコードで設定し、RegisterNameを呼び出すことによって、新しく作成された NameScope に名前を登録します。The following example sets the Name property in code, and then registers the name into the newly created NameScope by calling RegisterName. ここで説明する手法は、ストーリーボードを使用してアニメーション化するための要件です。これは、ストーリーボードが Nameによってターゲットにする必要があり、オブジェクト参照の対象にすることができないためです。The technique illustrated here is a requirement for animating with storyboards, because storyboards require targeting by the Name, and cannot be targeted by object reference.

//  
// Create a Rectangle
//
Rectangle myRectangle = new Rectangle();
myRectangle.Width = 200;
myRectangle.Height = 200;
myRectangle.Name = "myRectangle";
this.RegisterName(myRectangle.Name, myRectangle); 
'  
' Create a Rectangle
'
Dim myRectangle As New Rectangle()
myRectangle.Width = 200
myRectangle.Height = 200
myRectangle.Name = "myRectangle"
Me.RegisterName(myRectangle.Name, myRectangle)

注釈

このプロパティの最も一般的な使用方法は、マークアップの属性として XAMLXAML 要素名を指定することです。The most common usage of this property is to specify a XAMLXAML element name as an attribute in markup.

このプロパティは、基本的に、XAMLXAML X:Name ディレクティブを設定するための WPF フレームワークレベルの便宜的なプロパティを提供します。This property essentially provides a WPF framework-level convenience property to set the XAMLXAML x:Name Directive.

名前スコープ内で一意である必要があります。Names must be unique within a namescope. 詳細については、「 WPF XAML 名前スコープ」を参照してください。For more information, see WPF XAML Namescopes.

コードで要素を作成する場合は、Name を取得するのは一般的ではありません。Getting a Name if you are creating elements in code is not common. コードに適切な参照が既にある場合は、要素参照のメソッドとプロパティを呼び出すだけで、通常は Nameは必要ありません。If you have the appropriate reference in code already, you can just call methods and properties on the element reference and will not generally need the Name. これに対する例外は、Name 文字列にオーバーロードされた意味がある場合です。たとえば、UIUIにその名前を表示すると便利な場合です。An exception to this is if the Name string has some overloaded meaning, for instance if it is useful to display that name in UIUI. 元の Name をマークアップから設定した場合、分離コードから Name を設定することもお勧めしません。 XAMLXAML を読み込んだ後にプロパティを変更しても、元のオブジェクト参照は変更されません。Setting a Name from code-behind if the original Name was set from markup is also not recommended, and changing the property after loading the XAMLXAML will not change the original object reference. オブジェクト参照は、基になる名前スコープが解析中に明示的に作成された場合にのみ作成されます。The object references are created only when the underlying namescopes are explicitly created during parsing. 既に読み込まれている要素の Name プロパティを有効に変更するには、RegisterName を明示的に呼び出す必要があります。You must specifically call RegisterName to make an effective change to the Name property of an already loaded element.

コードから Name を設定することが重要なケースの1つは、ストーリーボードが実行される要素の名前を登録するときに、それらを実行時に参照できるようにすることです。One notable case where setting Name from code is important is when registering names for elements that storyboards will run against, so that they can be referenced at run time. 名前を登録する前に、をインスタンス化して NameScope インスタンスを割り当てる必要がある場合もあります。Before you can register a name, might also need to instantiate and assign a NameScope instance. 「例」または「ストーリーボードの概要」を参照してください。See the Example section, or Storyboards Overview.

コードから Name を設定するアプリケーションは限られていますが、Name によって要素を取得する方が一般的です。Setting Name from code has limited applications, but getting an element by Name is more common. 特定のシナリオとして、アプリケーションがアプリケーションにページを再読み込みするナビゲーションモデルがサポートされていて、実行時コードがそのページに対して定義された分離コードではない場合があります。One particular scenario is if your application supports a navigation model where pages reload into the application, and the run time code is not necessarily code-behind defined for that page. 任意の FrameworkElementから使用できるユーティリティメソッド FindNameは、その要素の論理ツリー内の Name によって要素を検索し、必要に応じてツリーを再帰的に検索できます。The utility method FindName, which is available from any FrameworkElement, can find any element by Name in the logical tree for that element, searching the tree recursively as necessary. または、LogicalTreeHelperFindLogicalNode 静的メソッドを使用して、引数として Name 文字列を受け取ることもできます。Or you can use the FindLogicalNode static method of LogicalTreeHelper, which also takes a Name string as an argument.

一般的に使用されるルート要素 (WindowPage など) は、インターフェイス INameScopeを実装します。Typically used root elements (Window, Page for example) implement the interface INameScope. このインターフェイスの実装では、その名前がスコープ内で明確になるようにする必要があります。Implementations of this interface are expected to enforce that names be unambiguous within their scope. このインターフェイスを定義するルート要素は、関連するすべての Api の名前スコープの動作の境界も定義します。The root elements that define this interface also define the namescope behavior boundaries for all the related APIs.

Name プロパティは、他のプロセスの識別子としても機能します。The Name property also serves as an identifier for other processes. たとえば、WPFWPF オートメーションモデルでは、クライアントとプロバイダーの AutomationId として Name が使用されます。For instance, the WPFWPF automation model will use Name as the AutomationId for clients and providers.

Name に使用される文字列値には、XAMLXAML の仕様で定義されている、基になるX:Name ディレクティブによって課せられるいくつかの制限があります。The string values used for Name have some restrictions, as imposed by the underlying x:Name Directive defined by the XAMLXAML specification. 特に、Name は文字またはアンダースコア () で始まり、アルファベット、数字、またはアンダースコアのみで構成されている必要があります。Most notably, a Name must start with a letter or the underscore character (), and must contain only letters, digits, or underscores. 詳細については、「 WPF XAML 名前スコープ」を参照してください。For more information, see WPF XAML Namescopes.

Name は、アニメーション化できない (IsAnimationProhibited がメタデータに true される) 非常に少ない依存関係プロパティの1つです。これは、アニメーションを対象とするために名前自体が不可欠であるためです。Name is one of the very few dependency properties that cannot be animated (IsAnimationProhibited is true in metadata), because the name itself is vital for targeting an animation. Name のデータバインディングは技術的には可能ですが、データバインド Name は、コードビハインドの識別子接続ポイントを提供するために、プロパティの主な目的を果たすことができないため、非常に一般的なシナリオです。Data binding a Name is technically possible, but is an extremely uncommon scenario because a data-bound Name cannot serve the main intended purpose of the property: to provide an identifier connection point for code-behind.

依存プロパティ情報Dependency Property Information

識別子フィールドIdentifier field NameProperty
メタデータプロパティが true に設定されるMetadata properties set to true IsAnimationProhibited

適用対象