WPF XAML 이름 범위

  • 아티클

XAML 이름 범위는 XAML에 정의된 개체를 식별하는 개념입니다. XAML 이름 범위의 이름은 XAML로 정의된 개체 이름과 개체 트리에서 그에 해당하는 인스턴스 간의 관계를 설정하는 데 사용할 수 있습니다. 일반적으로 WPF 관리 코드의 XAML 이름 범위는 XAML 애플리케이션의 개별 XAML 페이지 루트를 로드할 때 만들어집니다. 프로그래밍 개체로서의 XAML 이름 범위는 INameScope 인터페이스로 정의되며 실제 클래스 NameScope로 구현됩니다.

로드된 XAML 애플리케이션의 이름 범위

더욱 폭넓은 프로그래밍이나 컴퓨터 과학의 측면에서 프로그래밍 개념에는 흔히 개체에 액세스하는 데 사용할 수 있는 고유한 식별자 또는 이름의 원칙이 포함됩니다. 식별자나 이름을 사용하는 시스템의 경우 이름 범위는 해당 이름의 개체가 요청되는 경우 프로세스 또는 기술을 통해 검색할 위치의 경계나 식별 이름의 고유성이 적용되는 경계를 정의합니다. 이러한 일반적인 원칙은 XAML 이름 범위에도 해당됩니다. WPF에서 XAML 이름 범위는 페이지가 로드될 때 XAML 페이지의 루트 요소에 만들어집니다. XAML 페이지 내의 페이지 루트에서부터 지정된 각 이름은 관련 XAML 이름 범위에 추가됩니다.

WPF XAML에서 공통 루트 요소에 해당되는 요소(예: Page 및 Window)는 항상 XAML 이름 범위를 제어합니다. FrameworkElement 또는 FrameworkContentElement와 같은 요소가 태그에 있는 페이지의 루트 요소인 경우, XAML 프로세서는 Page에서 유효한 XAML 이름 범위를 제공할 수 있도록 암시적으로 Page 루트를 추가합니다.

참고

WPF 빌드 작업에서는 XAML 태그의 모든 요소에 대해 Name 또는 x:Name 특성이 정의되지 않은 경우에도 XAML 프로덕션을 위한 XAML 이름 범위가 만들어집니다.

한 XAML 이름 범위에서 같은 이름을 두 번 사용하려고 하면 예외가 발생합니다. 코드 숨김 파일이 있고 컴파일된 애플리케이션의 일부인 WPF XAML의 경우에는 빌드 시 WPF 빌드 작업에서 초기 태그 컴파일 중 페이지에 대해 생성된 클래스를 만들 때 예외가 발생합니다. 빌드 작업을 통해 태그 컴파일되지 않은 XAML의 경우에는 XAML이 로드될 때 XAML 이름 범위 문제와 관련된 예외가 발생할 수 있습니다. XAML 디자이너가 디자인 타임에 XAML 이름 범위 문제를 예상할 수도 있습니다.

런타임 개체 트리에 개체 추가

XAML이 구문 분석되는 시점은 WPF XAML 이름 범위가 만들어지고 정의되는 시점입니다. 개체 트리를 생성한 XAML이 구문 분석된 후에 개체 트리에 개체를 추가할 경우에는 새 개체의 Name 또는 x:Name 값에 따라 XAML 이름 범위의 정보가 자동으로 업데이트되지 않습니다. XAML이 로드된 후에 WPF XAML 이름 범위에 개체의 이름을 추가하려면 XAML 이름 범위를 정의하는 개체에 대해 적절히 구현된 RegisterName을 호출해야 합니다. 이름이 등록되지 않으면 추가된 개체를 FindName 같은 메서드를 통해 이름으로 참조할 수 없으며, 애니메이션 대상 지정에 해당 이름을 사용할 수 없습니다.

애플리케이션 개발자의 경우 가장 일반적인 시나리오는 RegisterName을 사용하여 페이지의 현재 루트에 있는 XAML 이름 범위에 이름을 등록하는 것입니다. RegisterName은 애니메이션을 위한 개체를 대상으로 하는 스토리보드에 대한 중요한 시나리오의 일부에 속합니다. 자세한 내용은 스토리보드 개요를 참조하세요.

XAML 이름 범위를 정의하는 개체 이외의 다른 개체에서 RegisterName을 호출할 경우, 개체를 정의하는 XAML 이름 범위에서 RegisterName을 호출할 때와 마찬가지로 호출하는 개체가 포함된 XAML 이름 범위에 해당 이름이 등록됩니다.

코드의 XAML 이름 범위

코드에서 XAML 이름 범위를 만든 다음 사용할 수 있습니다. XAML 이름 범위를 만드는 데 관련된 API 및 개념은 순수형 코드를 사용하는 경우에도 동일합니다. WPF용 XAML 프로세서에서는 XAML 자체를 처리할 때 이러한 API 및 개념을 사용하기 때문입니다. 이 개념 및 API는 대개 일부 또는 전체가 XAML로 정의된 개체 트리 내에서 개체를 이름으로 찾을 수 있도록 하기 위한 것입니다.

프로그래밍 방식으로 만들어졌으며 로드한 XAML을 기반으로 하지 않는 애플리케이션의 경우, 해당 인스턴스에서 XAML 이름 범위의 생성을 지원하려면 XAML 이름 범위를 정의하는 개체가 INameScope를 구현하거나 FrameworkElement 또는 FrameworkContentElement의 파생 클래스여야 합니다.

또한 XAML 프로세서로 로드 및 처리되지 않는 모든 요소에 대해서는 기본적으로 개체의 XAML 이름 범위가 만들어지거나 초기화되지 않습니다. 따라서 이후에 이름을 등록하려는 모든 개체에 대해 명시적으로 새 XAML 이름 범위를 만들어야 합니다. XAML 이름 범위를 만들려면 정적 SetNameScope 메서드를 호출합니다. XAML 이름 범위를 소유할 개체를 dependencyObject 매개 변수로 지정하고 새 NameScope 생성자 호출을 value 매개 변수로 지정합니다.

SetNameScope에 대해 dependencyObject로 제공된 개체가 INameScope 구현, FrameworkElement 또는 FrameworkContentElement가 아닌 경우, 자식 요소에 대한 RegisterName 호출이 적용되지 않습니다. 새 XAML 이름 범위를 명시적으로 만들지 못한 경우, RegisterName을 호출하면 예외가 발생합니다.

코드에서 XAML 이름 범위 API를 사용하는 예제를 보려면 이름 범위 정의를 참조하세요.

스타일 및 템플릿의 XAML 이름 범위

WPF의 스타일 및 템플릿을 사용하면 간편하게 콘텐츠를 다시 사용 및 적용할 수 있지만 템플릿 수준에서 XAML 이름이 정의된 요소가 스타일 및 템플릿에 포함될 수 있습니다. 이런 템플릿은 한 페이지에서 여러 번 사용될 수 있기 때문에 스타일과 템플릿은 모두 해당 스타일 또는 템플릿이 적용되는 개체 트리 내의 위치와는 상관없이 고유한 XAML 이름 범위를 정의합니다.

다음과 같은 예제를 참조하세요.

<Page
  xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
  xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
  >
  <Page.Resources>
    <ControlTemplate x:Key="MyButtonTemplate" TargetType="{x:Type Button}">
      <Border BorderBrush="Red" Name="TheBorder" BorderThickness="2">
        <ContentPresenter/>
      </Border>      
    </ControlTemplate>
  </Page.Resources>
  <StackPanel>
    <Button Template="{StaticResource MyButtonTemplate}">My first button</Button>
    <Button Template="{StaticResource MyButtonTemplate}">My second button</Button>
  </StackPanel>
</Page>

여기에서는 두 개의 단추에 동일한 템플릿이 적용됩니다. 템플릿에 개별 XAML 이름 범위가 없으면 템플릿에 사용된 TheBorder 이름 때문에 XAML 이름 범위에서 이름 충돌이 발생합니다. 템플릿의 각 인스턴스에는 고유한 XAML 이름 범위가 있으므로 이 예제에서 인스턴스화된 각 템플릿의 XAML 이름 범위에는 정확하게 하나의 이름만 포함됩니다.

스타일도 고유한 XAML 이름 범위를 정의하므로 대부분의 경우 스토리보드의 각 부분에 특정 이름이 할당될 수 있습니다. 이러한 이름을 사용하면 컨트롤 사용자 지정 과정에서 템플릿이 재정의된 경우에도 해당 이름의 요소를 대상으로 하는 특정 동작을 제어할 수 있습니다.

XAML 이름 범위가 분리되어 있으므로 템플릿에서 명명된 요소를 찾는 것이 페이지에서 템플릿 형식이 아닌 명명된 요소를 찾는 것보다 복잡합니다. 먼저 템플릿이 적용된 컨트롤의 Template 속성 값을 가져와 적용된 템플릿을 확인해야 합니다. 그런 다음, 템플릿이 두 번째 매개 변수로 적용된 컨트롤을 전달하여 템플릿 버전의 FindName을 호출합니다.

컨트롤 작성자가 적용된 템플릿에서 명명된 특정 요소가 컨트롤 자체로 정의되는 동작의 대상이 되는 규칙을 생성하려는 경우 컨트롤 구현 코드의 GetTemplateChild 메서드를 사용할 수 있습니다. GetTemplateChild 메서드는 보호되어 있으므로 컨트롤 작성자만 액세스할 수 있습니다.

템플릿 내에서 작업하고 템플릿이 적용되는 XAML 이름 범위에 도달해야 할 경우, TemplatedParent의 값을 가져온 다음 거기서 FindName을 호출합니다. 적용된 템플릿의 요소에서 이벤트가 발생되는 이벤트 처리기를 구현하는 경우가 템플릿 내에서 작업하는 예에 해당합니다.

FrameworkElement는 FindName, RegisterName 및 UnregisterName 메서드를 갖습니다. 이러한 메서드를 호출하는 개체에 고유한 XAML 이름 범위가 있는 경우 이러한 메서드는 관련 XAML 이름 범위의 메서드를 호출합니다. 그렇지 않은 경우에는 부모 요소에 고유한 XAML 이름 범위가 있는지 확인하며, 이 확인 과정은 XAML 이름 범위를 찾을 때까지 재귀적으로 계속됩니다(XAML 프로세서의 동작 때문에 루트에는 반드시 XAML 이름 범위가 있음). FrameworkContentElement에도 이와 유사한 동작이 있지만 FrameworkContentElement에는 XAML 이름 범위가 없다는 점이 다릅니다. 따라서 메서드는 FrameworkContentElement에 존재하므로 결국에는 호출을 FrameworkElement 부모 요소로 전달할 수 있습니다.

SetNameScope는 새 XAML 이름 범위를 기존 개체에 매핑하는 데 사용됩니다. XAML 이름 범위를 다시 설정하거나 지우기 위해 SetNameScope를 여러 번 호출할 수 있지만 이것은 일반적인 사용 방법은 아닙니다. 또한 GetNameScope는 대체로 코드에서도 잘 사용되지 않습니다.

XAML 이름 범위 구현

다음 클래스는 INameScope를 직접 구현합니다.

ResourceDictionary는 사전 구현에 속하므로 XAML 이름 또는 이름 범위를 사용하지 않고 그 대신 키를 사용합니다. ResourceDictionary에서 INameScope를 구현하는 유일한 이유는 실제 XAML 이름 범위와 ResourceDictionary의 키 처리 방식을 명확하게 구분할 수 있도록 사용자 코드에서 예외를 발생시켜 XAML 이름 범위가 부모 요소에 의해 ResourceDictionary에 적용되지 않도록 하기 위해서입니다.

FrameworkTemplate 및 Style은 명시적 인터페이스 정의를 통해 INameScope를 구현합니다. 명시적 구현을 사용하면 INameScope 인터페이스를 통해 XAML 이름 범위에 액세스할 때 이러한 XAML 이름 범위가 규칙에 따라 작동할 수 있습니다. 이러한 방식으로 WPF 내부 프로세스에서 XAML 이름 범위가 전달됩니다. 하지만 FrameworkTemplate 및 Style에서 직접 INameScope 메서드를 호출해야 하는 경우가 거의 없으므로 명시적 인터페이스 정의는 FrameworkTemplate 및 Style의 기존 API 노출 영역에 속하지 않으며 그 대신 GetTemplateChild 등의 다른 API를 사용합니다.

다음 클래스에서는 System.Windows.NameScope 도우미 클래스를 사용하고 NameScope.NameScope 연결된 속성을 통해 XAML 이름 범위 구현에 연결하여 고유한 XAML 이름 범위를 정의합니다.

참고 항목