[.NET] C#을 이용한 PropertyGrid 사용법에 대한 Summary

앞서 언급한대로, PropertyGrid에 List 컨트롤을 달아보자. 이 글을 쓰기에 앞서 List 컨트롤을 PropertyGrid에 달아보는 샘플 코드를 작성하면서, 뭐.. “이런 뷁스런”이란 생각이 들었다. 단지 컨트롤 하나 달기 위해 전역 변수이며 새로운 클래스를 2개씩이나 만들어줘야하다니.. .NET에 대한 실망이 쪼끔 인다. 그러나 이 방법말고 좀더 세련된 방법이 있을것이라 생각된다. 한번 시간날때 찾아봐야겠다.

여하튼, 지금 내가 알고 있는 방법을 정리해보자. 먼저 구현할 결과 화면은 다음과 같다.

즉, 우리가 추가할 프로퍼티의 이름은 ItemName이고 이 프로퍼티의 값으로 사과, 귤, 포도, 망고, 딸기을 선택할 수 있는 Combo List 컨트롤이라는 도우미를 붙인 형태를 구현하는 방법이다.

먼저 사과, 귤, 포도 등의 문자열들을 담을 string 배열에 대한 전역 변수를 선언한다.

internal class PropertyItemList
{
    internal static string[] _items;
}

비록 PropertyItemList라는 클래스를 전역변수로써 인스턴스화하지는 않겠지만, 맴버변수로 정적으로 선언함으로써 전역변수의 의미를 갖는다. 이렇게 정적으로 선언하여 전역처럼 쓰는 이유는 앞으로 추가할 2개의 새로운 클래스에서 이 PropertyItemList의 _items 정적변수에 접근해야하기 때문이다. 추가할 2개의 새로운 클래스에 대해서 살펴보기 전에 PropertyItemList의 _items 변수에 문자값들을 넣어주는 코드의 살펴보자.

private void Form1_Load(object sender, EventArgs e)
    {
        MyList listItem = new MyList();

        PropertyItemList._items = new String[5];
        PropertyItemList._items[0] = "사과(Apple)";
        PropertyItemList._items[1] = "귤(Orange)";
        PropertyItemList._items[2] = "포도(Grape)";
        PropertyItemList._items[3] = "망고(Mango)";
        PropertyItemList._items[4] = "딸기(Strawbery)";

        propertyGrid1.SelectedObject = listItem;
}

MyList는 앞으로 추가할 2개의 클래스 중 하나이며, propertyGrid의 SelectedObject 속성에 넣어주게 된다. 이는 이미 앞서 살펴봤으므로 이미 잘알고있을것이다.

이제 새로운게 추가할 두개의 클래스를 하나 하나 만들어 보자. 먼저 이미 나와버린 MyList 클래스이다.

public class MyList {
    private string _itemName;

    [Browsable(true)]
    [TypeConverter(typeof(MyConverter))]
    public string ItemName {
        get {
            string S = "";
            if (_itemName != null) {
                S = _itemName;
            } else {
                S = PropertyItemList._items[0];
            }

            return S;
        }

        set { _itemName = value; }
    }
}

ProperrtGrid에 추가할 프러퍼티인 ItemName을 가지고 있으며 Attribute를 지정하고 있다. 여기서 지정된 Attribute에 대해서 살펴보면, Browsable와 TypeConverter이다. Browsable는 원래 지정하지 않아도 되는데, 기본값으로 true이기 때문이다. 의미그대로 PropertyGrid에 나타낼 것이냐 말것이냐를 정하는 것이다. 그리고 TypeConverter가 바로 우리가 추가한 프로퍼티에 리스트 컨트롤을 달게 하는 역활을 하는 Attribute이다. 즉, TyperConverter의 인자로써 어떤 클래스를 주는데, 바로 이 어떤 클래스를 통해 프로퍼티에 리스트 컨트롤을 달거나 프로퍼티를 사용자가 직접값을 수정하게 하거나 리스트 컨트롤에서 선택만 하게 하거나 등의 특성을 지정하는 것이다. 그렇다면 이제 마지막으로 이 어떤 클래스인 MyConverter에 대해 살펴보자.

public class MyConverter : StringConverter
{
    public override bool GetStandardValuesSupported(
        ITypeDescriptorContext context) {
        return true;
    }

    public override bool GetStandardValuesExclusive(
        ITypeDescriptorContext context) {
	return true;
    }

    public override 
        System.ComponentModel.TypeConverter.StandardValuesCollection
        GetStandardValues(ITypeDescriptorContext context) {
        return new StandardValuesCollection(PropertyItemList._items);
    }
}

다소, 뷁스러운 클래스라고 생각하는데, 이 하나의 클래스에서 생전보도 못한 .NET 클래스가 참 많이도 나오기 때문이다. 다 집어치우고 필요한 것만 골라 따져보면, 먼저 override한 GetStandardValuesSupported에서 true를 반환해야만 Combo List 컨트롤을 볼수가 있으며 false를 반환하면 우리의 노력은 물거품이 되고 만다. 그리고 GetStandardValuesExclusive라는 매서드의 반환값을 true로 하면 단시 List에서 선택만 할 수 있고 키보드로 문자열값을 변경할 수 없게된다. 마지막으로 GetStandardValues는 List 컨트롤에 나열된 문자열값을 지정해주기 위한 매서드이다.

필자는 “뭔가 잘못된 것 같다”라는 생각이 들었다. 단지 컴보 리스트 컨트롤 하나 추가하기 위한 과정이 이처럼 복잡하다는 이유에서가 아니라, 반드시 전역변수를 선언해야만(여기서는 같은 효과를 위해 정적변수를 선언했다) 한다는 것에서였다. 이 문제는 차츰 해결될 것이라고 생각된다.

끝으로 Blog에 어제부터 google의 AdSense를 달아놨는데.. 이 글이 도움이 되셨다면 댓글말고, 옆에 AdSense 클릭 좀 해주시길~ 댓글은 쓰기 힘드실까봐~ ㅋ –;;

[.NET] C#을 이용한 PropertyGrid 사용법에 대한 Summary

일단 생긴 것 부터가 범창치 않은 이 컨트롤은 활용하기에 따라서 큰 활용도가 있을 것이다. 아래는 Visual Studio.NET 2005에 붙어 있는 속성창으로써 95% 이상이 PropertyGrid라는 컨트롤로 만들어진 UI이다.


필자가 이 PropertyGrid에 큰 관심을 두는 까닭은 VS의 속성창에 해당하는 델파이의 Object Inspector에 대한 필요성에서였다. 델파이의 Object Inspector 역시 PropertyGird와 같은 기능을 하는 VCL 컴포넌트로 만들어진 UI인데, 델파이의 개발사인 볼렌드는 해당 컴포넌트를 공개하지 않고 내부적으로만 사용하여왔으며, 지금 역시 그러하다. 그래서 필요하다면 천상 만들어 쓰던지, 어디서 찾아 쓰던지 사던지 해야할 것이였다. 이런 기능을 하는 컴포넌트를 하나 만들자니 배보다 배꼽이 더 커져버리게 될 모냥이고, 찾아 쓰자니 기존의 Object Inspector에 의해 눈이 높아져버려 마음에 드는 녀석을 찾아볼 수가 없었다. 그런데 MS는 PropertyGrid 컨트롤을 그냥 기본적은 .NET 컨트롤군에 포함시켜 사용자들이 쉽게 사용할 수 있도록 공개해 놓았다. MS의 개발자 지원에서 얼마나 큰 힘을 실고 있는지를 볼 수 있는 또 하나의 해석이라고 보여진다.

기능이 다양하고 강력한 만큼 PropertyGrid 컨트롤은 사용하기가 그렇게 호락 호락 하지 않은 녀석이다. .NET 기술이 태동되기 이전인 ATL 기술에서 채용되기 시작한 Attribute 방식을 사용하여 .NET에서 PropertyGrid를 사용한다. OOP 방식과 Attribute 방식 만남이다.

여기서는 기본적인 PropertyGrid의 사용법에서 고급사용법까지 몇단계에 걸치 그 사용법을 정리하고자 한다. 먼저 기본적인 사용법을 알아보겠다. 기보적인 사용법을 알아보기 위해 하나의 예제를 작성해 볼 것이다. 또한 그 예제의 결과 화면은 아래와 같다.


일단 Category는 ID Settings와 Marketting Settings로 2개이다.  ID Settings는 Address, Age, DateOfBirth, Name, SSN, TestColor이라는 이름의 Property를 가지고 있으며, Marketting Settings는 Email과 FrequentBuyer이라는 프로퍼트를 가지고 있다.

먼저 PropertyGrid의 사용법에 대한 큰 개념은 이렇다. Category를 지정하고 지정된 Category에 속하는 속성명과 속성의 Type을 지정하는 하나의 class를 만든 후, PropertyGrid의 SelectedObject에 그 class의 인스턴스를 할당한다. 이것이 전부다. SelectObject에 class의 인스턴스를 할당하는 거야 간단한 것이고, 문제는 그 문제의 class를 만드는 것이다. 바로 이 class를 만드는 것에 대해 살펴보자.

문제의 class의 빼대는 아래와 같다.

public class Customer
{
    private string _name;
    private int _age;
    private DateTime _dateOfBirth;
    private string _SSN;
    private string _address;
    private string _email;
    private bool _frequentBuyer;
    private Color _color;

    public Customer() {}
}

_name, _age, _dateOfBirth, _SSN, _address, _email, _frequentBuyer, _color이라는 변수들은 앞서 살펴본 구현할 결과 Property에 하나 하나가 매칭된다. 그러나 여기에는 크게 2가지 문제점이 있다. _name, _age등의 접근자는 private이므로 PropertyGrid는 이 변수들을 읽어낼 수도 변경할 수도 없다. 그래서 PropertyGrid와의 소통을 위해서 이 변수들에 대한 Property 지시자를 통해 Property로 만들어보자. 그 코드는 아래와 같다.

public class Customer
{
    private string _name;
    private int _age;
    private DateTime _dateOfBirth;
    private string _SSN;
    private string _address;
    private string _email;
    private bool _frequentBuyer;
    private Color _color;

    public Customer()  {}

    public string Name
    {
        get { return _name; }
        set { _name = value; }
    }

    public Color TestColor
    {
        get { return _color; }
        set { _color = value; }
    }

    public string SSN
    {
        get { return _SSN; }
        set {_SSN = value; }
    }

    public string Address
    {
        get { return _address;}
        set {_address = value; }
    }

    public DateTime DateOfBirth
    {
        get {return _dateOfBirth; }
        set {_dateOfBirth = value; }
    }

    public int Age
    {
        get { return _age; }
        set {_age = value; }
    }

    public bool FrequentBuyer
    {
        get {return _frequentBuyer; }
        set { _frequentBuyer = value; }
    }

    public string Email
    {
        get { return _email;}
        set {_email = value;}
    }
}

이렇게 해서 데이터를 Property화하여 외부와의 데이터 통신을 위한 Public 처리를 마쳤다. 이제 남은 문제는 이러한 데이터를 각 Category 별로 분류를 해야한다는 것이다. 앞서 분류는 ID Settings는 Address, Age, DateOfBirth, Name, SSN, TestColor이라는 이름의 Property를 가지고 있으며, Marketting Settings는 Email과 FrequentBuyer이라는 프로퍼트를 가진다라고 하였다. 바로 여기서부터 Attribute 기법이 들어간다. Attribute 기법은 ‘[‘와 ‘]’를 통해 지정되며 클래스나 프로퍼티등에 특정한 특성(Attribute에 대한 해석은 속성이 아닌 특성으로 해야한다)을 지정하도록 하는 것이다. Category 별로 Property를 분류하기 위한 Attribute의 지시자는 CategoryAttribute이며 그 사용법은 실제 코드에 적용된 것을 살펴보면 쉽게 알 수 있을 것이다. 아래는 실제 적용되어 덧 붙여진 코드이다.

[DefaultPropertyAttribute("Name")]
public class Customer
{
    private string _name;
    private int _age;
    private DateTime _dateOfBirth;
    private string _SSN;
    private string _address;
    private string _email;
    private bool _frequentBuyer;
    private Color _color;

    public Customer() {}

    [CategoryAttribute("ID Settings"), 
    DescriptionAttribute("Name of the customer")]
    public string Name
    {
        ....
    }

    [CategoryAttribute("ID Settings"), 
    DescriptionAttribute("Color of the customer")]
    public Color TestColor
    {
        ....
    }

    [CategoryAttribute("ID Settings"),
    DescriptionAttribute("Social Security Number of the customer")]
    public string SSN
    {
        ....
    }

    [CategoryAttribute("ID Settings"),
    DescriptionAttribute("Address of the customer")]
    public string Address
    {
        ....
    }

    [CategoryAttribute("ID Settings"),
    DescriptionAttribute("Date of Birth of the Customer (optional)")]
    public DateTime DateOfBirth
    {
        ....
    }

    [CategoryAttribute("ID Settings"),
    DescriptionAttribute("Age of the customer")]
    public int Age
    {
        ....
    }

    [CategoryAttribute("Marketting Settings"),
    DescriptionAttribute("If the customer as bought more \
    than 10 times, this is set to true")]
    public bool FrequentBuyer
    {
        ....
    }

    [CategoryAttribute("Marketting Settings"),
    DescriptionAttribute("Most current e-mail of the customer")]
    public string Email
    {
        ....
    }
}

CategoryAttribute를 통해 각 Property의 Category를 지정하고 있다. CategoryAttribute 이외에 Attribute 지시자로 DescriptionAttribute와 DefaultPropertyAttribute 속성이 있는데 먼저 DefaultPropertyAttribute는 PropertyGrid가 처음 구동될때 기본적으로 선택되어질 속성을 지시하는 것이며 DescriptionAttribute는 Property를 선택했을때 PropertyGrid 컨트롤 하단의 Property의 설명에 나타날 문자열이다.

이렇게 문제의 Class를 제작했고 실제 PropertyGrid 컨트롤에 지정하는 방법은 아래와 같다. 당연이 폼상에 PropertyGrid 컨트롤을 마우스로 끌어와 넣었다는 가정에서 말이다.

private void Form1_Load(object sender, EventArgs e)
{
     Customer bill = new Customer();

    bill.Age = 50;
    bill.Address = " 114 Maple Drive ";
    bill.DateOfBirth = Convert.ToDateTime("78/9/4");
    bill.SSN = "123-345-3566";
    bill.Email = "bill@aol.com";
    bill.Name = "Bill Smith"; 
    bill.TestColor = Color.Red;

    propertyGrid1.SelectedObject = bill;
}

이제 실행해보면 애초에 원하던 결과가 나타날 것이다. 이상이 PropertyGrid의 기본적인 사용법에 대해서 살펴보았다. 다음에는 고급 사용법인 PropertyGrid에 Combo List와 사용자정의 컨트롤 등을 올리는 방법들 하나 하나를 나눠 정리해보도록 하겠다.

도움이 되었다면, 댓글이라도 하나 남겨주는 센스를 잃지 않으셨으면 합니다~ ^^*