사용자 지정 Attached Property의 이해

안녕하세요.
이번 포스팅에서는 사용자 지정 Attached Property에 대해 이해와, 예제를 다룹니다.

1. 다른건 다 기본 내용을 쓰고싶은데, 이거 하나만 추가하고싶어,,

예를 들어서, ListBox에서 여러개를 선택가능하게 하되, 최대갯수를 제한하고 싶은 경우를 봅시다.
기본의 ListBox에서는 MultiSelect를 할수있게/없게 하는 기능은 있어도, 최대 갯수를 지정할 수는 없습니다.
이를 구현하는데 쉽게 생각할 수 있는 방법은 상속입니다. 부모의 기능은 그대로 사용하고 싶은데, 내것 하나만 추가됬으면 하는 경우 니까요

public class MaxSelectionListBox : ListBox // 1. 리스트 박스를 상속받습니다. { public int MaxSelectionCount // 2. 필요한 Property를 DependencyProperty로 구현합니다. { get { return (int)GetValue(MaxSelectionCountProperty); } set { SetValue(MaxSelectionCountProperty, value); } } // Using a DependencyProperty as the backing store for MaxSelectionCount. This enables animation, styling, binding, etc... public static readonly DependencyProperty MaxSelectionCountProperty = DependencyProperty.Register("MaxSelectionCount", typeof(int), typeof(MaxSelectionListBox), new UIPropertyMetadata(int.MaxValue)); // 3. 새로 추가한 Property가 제대로 동작할 수 있도록 적절히 구현해줍니다. protected override void OnSelectionChanged(SelectionChangedEventArgs e) { base.OnSelectionChanged(e); if (this.SelectedItems.Count > MaxSelectionCount) { for (int i = this.SelectedItems.Count; i > MaxSelectionCount - 1; i--) { if (this.SelectedItems.Count <= i) continue; this.SelectedItems.Remove(this.SelectedItems[i]); } } } }

상속을 이용한 MultiSelectionCount 구현

하지만, 이렇게 구현하게되면 하나의 프로퍼티 때매, 전체를상속 받아야 하며,  새로 구현한 아이만을 사용해서 구현하여야 합니다.
좀 더 효과적으로 구현할 수 있는 방법이 있까요?!
이번 포스팅에서 설명하고하 하는 사용자 지정 Attached property를 사용하면 됩니다.

우선
사용자 지정 Attached property를 설명하기 앞써, 사용자 지정을 뺀 Attached property에 대해 이야기 해봅시다.

2.  Attached property란?
    Attacted Property란 어떤 객체에서든지 설정할 수 있는 global한 속성입니다. 
    보통의 경우 부모요소에 포함된 값을 부모가 직접 지정할 수는 없고,  자식요소가 지정해야할 경우에 사용할 수 있도록 해줍니다.
    그러기 위해서  global하게 구현이 되어 있고요.   
    먼가 말로 표현하니 어렵게 느껴지는데요, 평소에 많이 사용하던 Property로 예제를 보면 무릎을 탁 치시게 될꺼에요.

<DockPanel> <CheckBox DockPanel.Dock="Top">Hello</CheckBox> </DockPanel>

평소에도 많이 사용하는 Attatced Property.  (DockPanel.Dock)
  
즉, 여기서 DockPanel.Dock속성은 부모인 DockPanel에서 정할 수 있는 것이 아니라,
DockPanel안에 포함되는 자식 요소에서 설정되어야 하기 때문에, DockPanel 클래스 안에서는 DockProeperty를 static Dependency Property로 만든 다음 GetDock과 SetDock Metheod를 public으로 제공합니다.

바로 이게 정의는 내가하나, 남들이 정의해서 써야할때-_-!! 사용하는 것이 Attached Property입니다. 
평소에도 사용하시면서 보셨거죠?
 
자 , 그럼 본론으로 들어가 봅시다.

3.  사용자 지정 Attacted Property란?

 위에서 구현하고자 했었던 ListBox에서 여러개를 선택가능하게 하되, 최대갯수를 제한하려고 해 봅시다.
 바로 이 Attacted Property를 이용해서 말이지요. 
 다음과 같이 구현하면 됩니다.

public static class SimpleHelper // 1. static으로 class를 만듭니다. 여기서는 SimpleHelper라고 하지요. { public static int GetMaxSelectionCount(DependencyObject obj) { return (int)obj.GetValue(MaxSelectionCountProperty); } public static void SetMaxSelectionCount(DependencyObject obj, int value) { obj.SetValue(MaxSelectionCountProperty, value); } // 2. propa를 이용해서 MaxSelectionCount Property를 생성합니다. // Using a DependencyProperty as the backing store for MaxSelectionCount. This enables animation, styling, binding, etc... public static readonly DependencyProperty MaxSelectionCountProperty = DependencyProperty.RegisterAttached("MaxSelectionCount", typeof(int), typeof(SimpleHelper), new UIPropertyMetadata(int.MaxValue, OnMaxSelectionCountChanged)); // 3. 새로 추가한 Property가 제대로 동작할 수 있도록 적절히 구현해줍니다. // * 위의 OnSelectionChanged와 구현내용은 비슷합니다. private static void OnMaxSelectionCountChanged(DependencyObject sender, DependencyPropertyChangedEventArgs e) { ListBox MultiSelector = sender as ListBox; if ((int)e.OldValue == int.MaxValue) { MultiSelector.SelectionChanged += (ss, ee) => CoerceSelectionCount(MultiSelector); } CoerceSelectionCount(MultiSelector); } private static void CoerceSelectionCount(ListBox MultiSelector) { int MaxSelectedCount = GetMaxSelectionCount(MultiSelector); if (MultiSelector.SelectedItems.Count > MaxSelectedCount) { for (int i = MultiSelector.SelectedItems.Count; i > MaxSelectedCount - 1; i--) { if (MultiSelector.SelectedItems.Count <= i) continue; MultiSelector.SelectedItems.Remove(MultiSelector.SelectedItems[i]); } } } }
사용자 정의 Atteched Property를 사용할 경우

* 10원 팁 : 아래와 같이 propa를 치게되면 인텔리센스가 적당히 atteched Property를 생성하는것을 도와줍니다.

4. 사용을 해보자.

xaml에서 그럼 실제로 구현한 내용을 적용해 봅시다.

<!-- 사용자 정의 AttachedProperty 를 이용해서 구현한 경우 --> <StackPanel Grid.Column="0" Grid.Row="0"> <!-- 별도로 정의된 GlobalProperty기 때문에, ClassName.PropertyName으로 사용합니다. --> <ListBox x:Name="nomalListBoxUsingSimpleHelper" SelectionMode="Multiple" S:SimpleHelper.MaxSelectionCount="5"/> <!-- 다른곳에 바인딩 해서 사용할 경우엔 ()를 이용해서 사용하면 됩니다. --> <TextBlock Text="{Binding Path = (S:SimpleHelper.MaxSelectionCount), ElementName=nomalListBoxUsingSimpleHelper, StringFormat=SimpleHelper 이용 MaxSelectionCount : \{0\}}"/> </StackPanel> <!-- 상속받은 MaxSelectionListBox 를 이용해서 구현한 경우 --> <StackPanel Grid.Column="1" Grid.Row="0"> <!-- Class안에 미리 정의되어있기 때문에, 그냥 사용하시면 됩니다. 컴파일하시면 인텔리센스에도 나타납니다. --> <S:MaxSelectionListBox x:Name="customListBox" SelectionMode="Multiple" MaxSelectionCount="5"/> <!-- 다른곳에 바인딩 해서 사용할 경우엔 평소처럼 사용하면 됩니다. --> <TextBlock Text="{Binding Path = MaxSelectionCount, ElementName=customListBox, StringFormat=MaxSelectionListBox 이용 MaxSelectionCount : \{0\}}"/> </StackPanel>

사용자 정의 Attacted Property를 사용할 경우 vs ListBox를 상속받아 구현할 경우 사용

* 별첨

nomalListBoxUsingSimpleHelper.SetValue(SimpleHelper.MaxSelectionCountProperty, 5); nomalListBoxUsingSimpleHelper.MaxHeight

C#코드에서 사용자 정의 Property를 사용하는 방법

어찌보면 extention method 와 비슷하다고 보실 수 있네요.
전체 예제는 아래에 첨부합니다.