사용자 지정 종속성 속성

아티클
05/04/2023

이 항목에서는 WPF(Windows Presentation Foundation) 애플리케이션 개발자와 구성 요소 작성자가 사용자 지정 종속성 속성을 만들려고 하는 이유를 설명하고 구현 단계와 속성의 성능, 유용성 또는 다양성을 개선할 수 있는 일부 구현 옵션을 설명합니다.

필수 구성 요소

이 항목에서는 WPF 클래스에 대한 기존 종속성 속성의 소비자 관점에서 종속성 속성을 이해하고 종속성 속성 개요 항목을 읽었다고 가정합니다. 이 항목의 예제를 따르려면 XAML을 이해하고 WPF 애플리케이션을 작성하는 방법도 알아야 합니다.

종속성 속성이란?

CLR(공용 언어 런타임) 속성을 종속성 속성으로 구현하여 스타일 지정, 데이터 바인딩, 애니메이션, 기본값을 지원하도록 할 수 있습니다. 종속성 속성은 Register 메서드(또는 RegisterReadOnly)를 호출하여 WPF 속성 시스템에 등록되고 DependencyProperty 식별자 필드에서 지원되는 속성입니다. 종속성 속성은 DependencyObject 형식에서만 사용할 수 있지만 DependencyObject는 WPF 클래스 계층 구조에서 상당히 높기 때문에 WPF에서 사용할 수 있는 대부분의 클래스는 종속성 속성을 지원합니다. 종속성 속성 및 이 SDK에서 종속성 속성을 설명하는 데 사용된 일부 용어와 규칙에 대한 자세한 내용은 종속성 속성 개요를 참조하세요.

종속성 속성의 예

WPF 클래스에서 구현되는 종속성 속성의 예로는 무엇보다 Background 속성, Width 속성, Text 속성이 있습니다. 클래스에 의해 노출된 각 종속성 속성에는 동일한 클래스에서 노출된 DependencyProperty 형식의 해당 퍼블릭 정적 필드가 있습니다. 이는 종속성 속성의 식별자입니다. 식별자는 규칙을 사용하여 이름이 지정됩니다. 종속성 속성의 이름에는 문자열 Property가 추가됩니다. 예를 들어, Background 속성의 해당 DependencyProperty 식별자 필드는 BackgroundProperty입니다. 식별자는 종속성 속성이 등록될 때 이에 대한 정보를 저장했다가 나중에 SetValue 호출과 같은 종속성 속성과 관련된 다른 작업에 사용합니다.

종속성 속성 개요에서 언급했듯이 WPF의 모든 종속성 속성(대부분의 연결된 속성 제외)은 “래퍼” 구현으로 인해 CLR 속성이기도 합니다. 따라서 코드에서 다른 CLR 속성을 사용하는 것과 같은 방식으로 래퍼를 정의하는 CLR 접근자를 호출하여 종속성 속성을 가져오거나 설정할 수 있습니다. 설정된 종속성 속성의 소비자는 일반적으로 기본 속성 시스템에 대한 연결 지점인 DependencyObject 메서드 GetValue 및 SetValue를 사용하지 않습니다. 대신 기존 CLR 속성 구현은 식별자 필드를 적절하게 사용하여 속성의 get 및 set 래퍼 구현 내에 이미 GetValue 및 SetValue를 호출했을 것입니다. 사용자 지정 종속성 속성을 직접 구현하는 경우 유사한 방법으로 래퍼를 정의하게 됩니다.

종속성 속성의 구현 시기

클래스에서 속성을 구현할 때 클래스가 DependencyObject에서 파생되는 한 DependencyProperty 식별자로 속성을 지원하여 종속성 속성으로 만들 수 있는 옵션이 있습니다. 속성을 종속성 속성으로 만드는 것이 항상 필요하거나 적절한 것은 아니며 시나리오 요구에 따라 달라집니다. 때로는 개인 필드로 속성을 지원하는 일반적인 기술이 적합합니다. 그러나 속성에서 다음 WPF 기능 중 하나 이상을 지원하기를 원할 때마다 속성을 종속성 속성으로 구현해야 합니다.

스타일에 속성을 설정하려고 합니다. 자세한 내용은 스타일 지정 및 템플릿을 참조하세요.
속성에서 데이터 바인딩을 지원하게 하려고 합니다. 데이터 바인딩 종속성 속성에 대한 자세한 내용은 두 컨트롤의 속성 바인딩을 참조하세요.
동적 리소스 참조를 사용하여 속성을 설정하려고 합니다. 자세한 내용은 XAML 리소스를 참조하세요.
요소 트리의 부모 요소에서 속성 값을 자동으로 상속받도록 하려고 합니다. 이 경우 CLR 액세스에 대한 속성 래퍼를 만드는 경우에도 RegisterAttached 메서드에 등록합니다. 자세한 내용은 속성 값 상속을 참조하세요.
속성에 애니메이션 효과를 주려고 합니다. 자세한 내용은 애니메이션 개요를 참조하세요.
속성 시스템, 환경 또는 사용자가 수행한 작업을 통해 또는 스타일을 읽고 사용하여 이전 속성 값이 변경되었을 때 속성 시스템에서 보고하도록 하려고 합니다. 속성 메타데이터를 사용하여 속성 시스템에서 속성 값이 명확하게 변경되었다는 것을 확인할 때마다 호출되는 콜백 메서드를 속성이 지정할 수 있습니다. 관련 개념은 속성 값 강제 변환입니다. 자세한 내용은 종속성 속성 콜백 및 유효성 검사를 참조하세요.
속성 값 변경 시 레이아웃 시스템에서 요소의 시각적 개체를 재구성해야 하는지 여부를 보고하는 것과 같이 WPF 프로세스에서도 사용되는 설정된 메타데이터 규칙을 사용하려고 합니다. 또는 파생 클래스가 기본값과 같은 메타데이터 기반 특성을 변경할 수 있도록 메타데이터 재정의를 사용할 수 있도록 하려고 합니다.
사용자 지정 컨트롤 속성이 속성 창 편집과 같은 Visual Studio WPF 지원을 받도록 하려고 합니다. 자세한 내용은 컨트롤 제작 개요를 참조하세요.

이러한 시나리오를 검토할 때는 완전히 새로운 속성을 구현하는 대신 기존 종속성 속성의 메타데이터를 재정의하여 시나리오를 얻을 수 있는지 여부도 고려해야 합니다. 메타데이터 재정의가 실용적인지 여부는 시나리오 유형과 해당 시나리오가 기존 WPF 종속성 속성 및 클래스의 구현과 얼마나 유사한지에 따라 다릅니다. 기존 속성에서 메타데이터 재정의에 대한 자세한 내용은 종속성 속성 메타데이터를 참조하세요.

종속성 속성 정의를 위한 검사 목록

종속성 속성 정의는 4가지 고유한 개념으로 구성됩니다. 이러한 개념은 반드시 엄격한 절차적 단계는 아니며, 그중 일부는 구현 시 단일 코드 줄로 결합됩니다.

(선택 사항) 종속성 속성의 속성 메타데이터를 만듭니다.
속성 시스템에 속성 이름을 등록하여 소유자 유형과 속성 값의 유형을 지정합니다. 또한 사용되는 경우 속성 메타데이터를 지정합니다.
DependencyProperty 식별자를 소유자 형식의 publicstaticreadonly 필드로 정의합니다.
이름이 종속성 속성의 이름과 일치하는 CLR “래퍼” 속성을 정의합니다. CLR “래퍼” 속성의 get 및 set 접근자는 해당 속성을 지원하는 종속성 속성과 연결하도록 구현합니다.

속성 시스템에 속성 등록

속성이 종속성 속성이 되게 하려면 속성 시스템에서 유지하는 테이블에 해당 속성을 등록한 다음 나중에 속성 시스템 작업의 한정자로 사용되는 고유 식별자를 지정해야 합니다. 이러한 작업은 내부 작업이거나 속성 시스템 API를 호출하는 자체 코드일 수 있습니다. 속성을 등록하려면 클래스 본문(클래스 내부이지만 멤버 정의 외부)에서 Register 메서드를 호출합니다. 식별자 필드는 반환 값으로 Register 메서드 호출에 의해서도 제공됩니다. Register 호출이 다른 멤버 정의 외부에서 수행되는 이유는 이 반환 값을 사용하여 클래스의 일부로 DependencyProperty 형식의 publicstaticreadonly 필드를 할당하고 만들기 때문입니다. 이 필드는 종속성 속성의 식별자가 됩니다.

public static readonly DependencyProperty AquariumGraphicProperty = DependencyProperty.Register(
  "AquariumGraphic",
  typeof(Uri),
  typeof(AquariumObject),
  new FrameworkPropertyMetadata(null,
      FrameworkPropertyMetadataOptions.AffectsRender,
      new PropertyChangedCallback(OnUriChanged)
  )
);

Public Shared ReadOnly AquariumGraphicProperty As DependencyProperty = DependencyProperty.Register("AquariumGraphic", GetType(Uri), GetType(AquariumObject), New FrameworkPropertyMetadata(Nothing, FrameworkPropertyMetadataOptions.AffectsRender, New PropertyChangedCallback(AddressOf OnUriChanged)))

종속성 속성 이름 규칙

예외적인 상황을 제외하고 모든 상황에서 따라야 하는 종속성 속성과 관련하여 설정된 명명 규칙이 있습니다.

종속성 속성 자체는 이 예제에서처럼 기본 이름 “AquariumGraphic”을 사용하며 Register의 첫 번째 매개 변수로 제공됩니다. 그 이름은 각 등록 형식 내에서 고유해야 합니다. 기본 형식을 통해 상속된 종속성 속성은 이미 등록 형식의 일부로 간주되어 상속된 속성의 이름을 다시 등록할 수 없습니다. 그러나 종속성 속성이 상속되지 않는 경우에도 클래스를 종속성 속성의 소유자로 추가하는 기술이 있습니다. 자세한 내용은 종속성 속성 메타데이터를 참조하세요.

식별자 필드를 만들 때 이 필드의 이름을 등록할 때의 속성 이름과 접미사 Property로 지정합니다. 이 필드는 종속성 속성에 대한 식별자이며, 나중에 자체 코드로 속성에 대한 다른 코드 액세스에 의해, 허용하는 외부 코드 액세스에 의해, 속성 시스템에 의해, 잠재적으로 XAML 프로세서에 의해 래퍼에서 만드는 SetValue 및 GetValue 호출에 대한 입력으로 사용됩니다.

참고

클래스 본문에서 종속성 속성을 정의하는 것이 일반적인 구현이지만 클래스 정적 생성자에서 종속성 속성을 정의할 수도 있습니다. 이 접근 방식은 종속성 속성을 초기화하기 위해 두 줄 이상의 코드가 필요한 경우에 유용할 수 있습니다.

"래퍼" 구현

래퍼 구현은 get 구현에서 GetValue를 호출하고 set 구현에서 SetValue(원래 등록 호출 및 필드도 명확성을 위해 여기에 표시됨)를 호출해야 합니다.

예외적인 상황을 제외하고 래퍼 구현은 각각 GetValue 및 SetValue 작업만 수행해야 합니다. 그 이유는 XAML로드 및 종속성 속성 항목에서 설명합니다.

WPF 클래스에서 제공되는 모든 기존 퍼블릭 종속성 속성은 이 간단한 래퍼 구현 모델을 사용합니다. 종속성 속성 작동 방식의 대부분 복잡성은 본질적으로 속성 시스템의 동작이거나 속성 메타데이터를 통한 강제 변환 또는 속성 변경 콜백과 같은 다른 개념을 통해 구현됩니다.


public static readonly DependencyProperty AquariumGraphicProperty = DependencyProperty.Register(
  "AquariumGraphic",
  typeof(Uri),
  typeof(AquariumObject),
  new FrameworkPropertyMetadata(null,
      FrameworkPropertyMetadataOptions.AffectsRender,
      new PropertyChangedCallback(OnUriChanged)
  )
);
public Uri AquariumGraphic
{
  get { return (Uri)GetValue(AquariumGraphicProperty); }
  set { SetValue(AquariumGraphicProperty, value); }
}


Public Shared ReadOnly AquariumGraphicProperty As DependencyProperty = DependencyProperty.Register("AquariumGraphic", GetType(Uri), GetType(AquariumObject), New FrameworkPropertyMetadata(Nothing, FrameworkPropertyMetadataOptions.AffectsRender, New PropertyChangedCallback(AddressOf OnUriChanged)))
Public Property AquariumGraphic() As Uri
    Get
        Return CType(GetValue(AquariumGraphicProperty), Uri)
    End Get
    Set(ByVal value As Uri)
        SetValue(AquariumGraphicProperty, value)
    End Set
End Property

다시 말하면 규칙에 따라 래퍼 속성의 이름은 속성을 등록한 Register 호출의 첫 번째 매개 변수로 선택 및 제공된 이름과 같아야 합니다. 속성이 규칙을 따르지 않는다고 해서 가능한 모든 용도에 사용하지 못한다는 것은 아니지만 몇 가지 주목할 만한 문제가 발생하게 됩니다.

스타일과 템플릿의 특정 측면이 작동하지 않습니다.
대부분의 도구와 디자이너는 XAML을 제대로 직렬화하거나 속성별 수준에서 디자이너 환경 지원을 제공하기 위해 명명 규칙을 사용해야 합니다.
WPF XAML 로더의 현재 구현은 래퍼를 완전히 무시하고 특성 값을 처리할 때 명명 규칙을 사용합니다. 자세한 내용은 XAML로드 및 종속성 속성을 참조하세요.

새 종속성 속성의 속성 메타데이터

종속성 속성을 등록할 때 속성 시스템을 통한 등록은 속성 특성을 저장하는 메타데이터 개체를 만듭니다. 이들 중 많은 특성에는 속성이 Register의 단순 서명으로 등록된 경우 설정되는 기본값이 있습니다. Register의 다른 서명을 사용하면 속성을 등록할 때 원하는 메타데이터를 지정할 수 있습니다. 종속성 속성에 대해 지정된 가장 일반적인 메타데이터는 속성을 사용하는 새 인스턴스에 적용되는 기본값을 속성에 제공하는 것입니다.

FrameworkElement의 파생 클래스에 있는 종속성 속성을 만드는 경우 기본 PropertyMetadata 클래스가 아닌 좀 더 특수화된 메타데이터 클래스 FrameworkPropertyMetadata를 사용할 수 있습니다. FrameworkPropertyMetadata 클래스의 생성자에는 다양한 메타데이터 특성을 조합하여 지정할 수 있는 여러 서명이 있습니다. 기본값만 지정하려면 Object 형식의 단일 매개 변수를 사용하는 서명을 사용합니다. 해당 개체 매개 변수를 속성의 형식별 기본값으로 전달합니다. 제공된 기본값은 Register 호출에서 propertyType 매개 변수로 제공한 형식이어야 합니다.

FrameworkPropertyMetadata의 경우 속성에 메타데이터 옵션 플래그를 지정할 수도 있습니다. 이러한 플래그는 등록 후에 속성 메타데이터에서 불연속 속성으로 변환되며 특정 조건을 레이아웃 엔진과 같은 다른 프로세스와 통신하는 데 사용됩니다.

적절한 메타데이터 플래그 설정

속성(또는 값의 변경)이 UI(사용자 인터페이스)에 영향을 미치고 특히 레이아웃 시스템에서 페이지의 요소 크기를 지정하거나 렌더링하는 방법에 영향을 미치는 경우 AffectsMeasure, AffectsArrange, AffectsRender 중 하나 이상의 플래그를 설정합니다.
- AffectsMeasure는 이 속성을 변경하면 포함하는 개체가 부모 내에서 공간을 더 많거나 적게 요구할 수 있는 UI 렌더링을 변경해야 한다는 것을 나타냅니다. 예를 들어 "Width" 속성은 이 플래그를 설정해야 합니다.
- AffectsArrange는 이 속성을 변경하려면 일반적으로 전용 공간에서 변경해야 하는 것이 아니라 공간 내에서 위치가 변경되었다는 것을 나타내는 UI 렌더링을 변경해야 함을 의미합니다. 예를 들어 "Alignment" 속성은 이 플래그를 설정해야 합니다.
- AffectsRender는 레이아웃과 측정값에 영향을 주지 않지만 다른 렌더링이 필요한 다른 변경이 발생했다는 것을 나타냅니다. 예를 들어 기존 요소의 색상을 변경하는 "Background"와 같은 속성이 있습니다.
- 이러한 플래그는 종종 속성 시스템 또는 레이아웃 콜백의 자체 재정의 구현에 대한 메타데이터의 프로토콜로 사용됩니다. 예를 들어 인스턴스의 속성이 값 변경을 보고하고 AffectsArrange가 해당 메타데이터에서 true인 경우 InvalidateArrange를 호출하는 OnPropertyChanged 콜백이 있을 수 있습니다.
일부 속성은 위에 언급된 필수 크기의 변경 이상으로, 포함하는 부모 요소의 렌더링 특성에 영향을 줄 수 있습니다. 유동 문서 모델에서 사용되는 MinOrphanLines 속성이 그 예로, 해당 속성을 변경하면 단락이 포함된 유동 문서의 전체 렌더링을 변경할 수 있습니다. AffectsParentArrange 또는 AffectsParentMeasure를 사용하여 자체 속성에서 유사한 사례를 식별합니다.
기본적으로 종속성 속성은 데이터 바인딩을 지원합니다. 데이터 바인딩에 대한 현실적인 시나리오가 없거나 큰 개체에 대한 데이터 바인딩의 성능이 문제로 인식되는 경우 데이터 바인딩을 의도적으로 사용하지 않도록 설정할 수 있습니다.
기본적으로 종속성 속성에 대한 데이터 바인딩 Mode의 기본값은 OneWay입니다. 언제든지 바인딩 인스턴스별로 TwoWay가 되도록 바인딩을 변경할 수 있습니다. 자세한 내용은 바인딩 방향 지정을 참조하세요. 그러나 종속성 속성 작성자는 기본적으로 속성에서 TwoWay 바인딩 모드를 사용하도록 선택할 수 있습니다. 기존 종속성 속성의 예로는 MenuItem.IsSubmenuOpen이 있습니다. 이 속성에 대한 시나리오는 IsSubmenuOpen 설정 논리와 MenuItem의 합성이 기본 테마 스타일과 상호 작용한다는 것입니다. IsSubmenuOpen 속성 논리는 데이터 바인딩을 기본적으로 사용하여 다른 상태 속성 및 메서드 호출에 따라 속성 상태를 유지합니다. TwoWay를 기본적으로 바인딩하는 또 다른 속성의 예로는 TextBox.Text가 있습니다.
Inherits 플래그를 설정하여 사용자 지정 종속성 속성에서 속성 상속을 사용하도록 설정할 수도 있습니다. 속성 상속은 부모 요소와 자식 요소가 공통된 속성을 갖는 시나리오에 유용하며 자식 요소가 해당 특정 속성 값을 부모가 설정한 값과 동일한 값으로 설정하는 것이 적합합니다. 상속 가능한 속성의 예로는 DataContext가 있습니다. 이는 데이터 프레젠테이션에 중요한 마스터-세부 시나리오를 사용하기 위한 바인딩 작업에 사용됩니다. DataContext를 상속 가능하게 만들면 모든 자식 요소가 해당 데이터 컨텍스트도 상속받습니다. 속성 값 상속으로 인해 페이지 또는 애플리케이션 루트에서 데이터 컨텍스트를 지정할 수 있으며 가능한 모든 하위 요소의 바인딩에 대해 다시 지정할 필요가 없습니다. DataContext도 상속이 기본값을 재정의하지만 특정 자식 요소에 대해 항상 로컬로 설정할 수 있음을 보여 주는 좋은 예입니다. 자세한 내용은 계층적 데이터에 마스터-세부 패턴 사용을 참조하세요. 속성 값 상속을 사용하면 성능이 저하될 수 있으므로 꼭 필요할 때만 사용해야 합니다. 자세한 내용은 속성 값 상속을 참조하세요.
Journal 플래그를 설정하여 종속성 속성을 탐색 저널링 서비스에서 검색하거나 사용해야 하는지 여부를 나타냅니다. SelectedIndex 속성이 그 예로, 선택 컨트롤에서 선택된 항목은 저널링 기록을 탐색할 때 유지되어야 합니다.

읽기 전용 종속성 속성

읽기 전용인 종속성 속성을 정의할 수 있습니다. 그러나 속성을 읽기 전용으로 정의하는 이유에 대한 시나리오는 속성 시스템에 속성을 등록하고 식별자를 노출하는 절차와 약간 다릅니다. 자세한 내용은 읽기 전용 종속성 속성을 참조하세요.

컬렉션 형식 종속성 속성

컬렉션 형식 종속성 속성에는 고려할 몇 가지 추가 구현의 문제점이 있습니다. 자세한 내용은 컬렉션 형식 종속성 속성을 참조하세요.

종속성 속성 보안 고려 사항

종속성 속성은 공용 속성으로 선언해야 합니다. 종속성 속성 식별자 필드는 공용 정적 필드로 선언해야 합니다. 다른 액세스 수준(예: 보호됨)을 선언하려고 시도하더라도 속성 시스템 API와 함께 식별자를 통해 종속성 속성에 항상 액세스할 수 있습니다. 보호된 식별자 필드조차도 LocalValueEnumerator와 같은 속성 시스템의 일부인 메타데이터 보고 또는 값 결정 API로 인해 잠재적으로 액세스할 수 있습니다. 자세한 내용은 종속성 속성 보안을 참조하세요.

종속성 속성 및 클래스 생성자

클래스 생성자가 가상 메서드를 호출해서는 안 되는 관리 코드 프로그래밍(종종 FxCop와 같은 코드 분석 도구로 시행)에 일반적인 원칙이 있습니다. 이는 생성자가 파생 클래스 생성자의 기본 초기화로 호출될 수 있고 생성자를 통한 가상 메서드 입력이 생성 중인 개체 인스턴스의 불완전 초기화 상태에서 발생할 수 있기 때문입니다. DependencyObject에서 이미 파생된 클래스에서 파생되면 속성 시스템 자체가 내부적으로 가상 메서드를 호출하고 노출한다는 사실을 알고 있어야 합니다. 이 가상 메서드는 WPF 속성 시스템 서비스의 일부입니다. 메서드를 재정의하면 파생 클래스가 값 결정에 참여할 수 있습니다. 런타임 초기화 시 발생할 수 있는 문제를 방지하려면 매우 구체적인 생성자 패턴을 따라 클래스의 생성자 내에서 종속성 속성 값을 설정해야 합니다. 자세한 내용은 DependencyObjects의 안전한 생성자 패턴을 참조하세요.