PropertyDescriptor クラス

定義

名前空間:

System.ComponentModel

アセンブリ:

System.ComponentModel.TypeConverter.dll

ソース:

PropertyDescriptor.cs

クラスのプロパティの抽象化を提供します。

public ref class PropertyDescriptor abstract : System::ComponentModel::MemberDescriptor

public abstract class PropertyDescriptor : System.ComponentModel.MemberDescriptor

type PropertyDescriptor = class
    inherit MemberDescriptor

Public MustInherit Class PropertyDescriptor
Inherits MemberDescriptor

継承

Object

MemberDescriptor

PropertyDescriptor

派生

System.ComponentModel.DependencyPropertyDescriptor

System.ComponentModel.TypeConverter.SimplePropertyDescriptor

例

次のコード例は、PropertyDescriptorCollection クラスの例に基づいて構築されています。 ボタンのテキストの情報 (カテゴリ、説明、表示名) をテキスト ボックスに出力します。 フォームで button1 と textbox1 がインスタンス化されていることを前提としています。

// Creates a new collection and assign it the properties for button1.
PropertyDescriptorCollection^ properties = TypeDescriptor::GetProperties( button1 );

// Sets an PropertyDescriptor to the specific property.
System::ComponentModel::PropertyDescriptor^ myProperty = properties->Find( "Text", false );

// Prints the property and the property description.
textBox1->Text = String::Concat( myProperty->DisplayName, "\n" );
textBox1->Text = String::Concat( textBox1->Text, myProperty->Description, "\n" );
textBox1->Text = String::Concat( textBox1->Text, myProperty->Category, "\n" );

// Creates a new collection and assign it the properties for button1.
PropertyDescriptorCollection properties = TypeDescriptor.GetProperties(button1);

// Sets an PropertyDescriptor to the specific property.
System.ComponentModel.PropertyDescriptor myProperty = properties.Find("Text", false);

// Prints the property and the property description.
textBox1.Text = myProperty.DisplayName + '\n';
textBox1.Text += myProperty.Description + '\n';
textBox1.Text += myProperty.Category + '\n';

' Creates a new collection and assign it the properties for button1.
Dim properties As PropertyDescriptorCollection = TypeDescriptor.GetProperties(Button1)

' Sets an PropertyDescriptor to the specific property.
Dim myProperty As PropertyDescriptor = properties.Find("Text", False)

' Prints the property and the property description.
TextBox1.Text += myProperty.DisplayName & Microsoft.VisualBasic.ControlChars.Cr
TextBox1.Text += myProperty.Description & Microsoft.VisualBasic.ControlChars.Cr
TextBox1.Text += myProperty.Category & Microsoft.VisualBasic.ControlChars.Cr

次のコード例は、プロパティの読み取り専用ラッパーを提供するカスタム プロパティ記述子を実装する方法を示しています。 SerializeReadOnlyPropertyDescriptor は、コントロールの Size プロパティの読み取り専用プロパティ記述子を提供するために、カスタム デザイナーで使用されます。

using System;
using System.Collections;
using System.ComponentModel;
using System.Text;

namespace ReadOnlyPropertyDescriptorTest
{
    // The SerializeReadOnlyPropertyDescriptor shows how to implement a 
    // custom property descriptor. It provides a read-only wrapper 
    // around the specified PropertyDescriptor. 
    internal sealed class SerializeReadOnlyPropertyDescriptor : PropertyDescriptor
    {
        private PropertyDescriptor _pd = null;

        public SerializeReadOnlyPropertyDescriptor(PropertyDescriptor pd)
            : base(pd)
        {
            this._pd = pd;
        }

        public override AttributeCollection Attributes
        {
            get
            {
                return( AppendAttributeCollection(
                    this._pd.Attributes, 
                    ReadOnlyAttribute.Yes) );
            }
        }

        protected override void FillAttributes(IList attributeList)
        {
            attributeList.Add(ReadOnlyAttribute.Yes);
        }

        public override Type ComponentType
        {
            get
            {
                return this._pd.ComponentType;
            }
        }

        // The type converter for this property.
        // A translator can overwrite with its own converter.
        public override TypeConverter Converter
        {
            get
            {
                return this._pd.Converter;
            }
        }

        // Returns the property editor 
        // A translator can overwrite with its own editor.
        public override object GetEditor(Type editorBaseType)
        {
            return this._pd.GetEditor(editorBaseType);
        }

        // Specifies the property is read only.
        public override bool IsReadOnly
        {
            get
            {
                return true;
            }
        }

        public override Type PropertyType
        {
            get
            {
                return this._pd.PropertyType;
            }
        }

        public override bool CanResetValue(object component)
        {
            return this._pd.CanResetValue(component);
        }

        public override object GetValue(object component)
        {
            return this._pd.GetValue(component);
        }

        public override void ResetValue(object component)
        {
            this._pd.ResetValue(component);
        }

        public override void SetValue(object component, object val)
        {
            this._pd.SetValue(component, val);
        }

        // Determines whether a value should be serialized.
        public override bool ShouldSerializeValue(object component)
        {
            bool result = this._pd.ShouldSerializeValue(component);

            if (!result)
            {
                DefaultValueAttribute dva = (DefaultValueAttribute)_pd.Attributes[typeof(DefaultValueAttribute)];
                if (dva != null)
                {
                    result = !Object.Equals(this._pd.GetValue(component), dva.Value);
                }
                else
                {
                    result = true;
                }
            }

            return result;
        }

        // The following Utility methods create a new AttributeCollection
        // by appending the specified attributes to an existing collection.
        static public AttributeCollection AppendAttributeCollection(
            AttributeCollection existing, 
            params Attribute[] newAttrs)
        {
            return new AttributeCollection(AppendAttributes(existing, newAttrs));
        }

        static public Attribute[] AppendAttributes(
            AttributeCollection existing, 
            params Attribute[] newAttrs)
        {
            if (existing == null)
            {
                throw new ArgumentNullException(nameof(existing));
            }

            newAttrs ??= new Attribute[0];

            Attribute[] attributes;

            Attribute[] newArray = new Attribute[existing.Count + newAttrs.Length];
            int actualCount = existing.Count;
            existing.CopyTo(newArray, 0);

            for (int idx = 0; idx < newAttrs.Length; idx++)
            {
                if (newAttrs[idx] == null)
                {
                    throw new ArgumentNullException("newAttrs");
                }

                // Check if this attribute is already in the existing
                // array.  If it is, replace it.
                bool match = false;
                for (int existingIdx = 0; existingIdx < existing.Count; existingIdx++)
                {
                    if (newArray[existingIdx].TypeId.Equals(newAttrs[idx].TypeId))
                    {
                        match = true;
                        newArray[existingIdx] = newAttrs[idx];
                        break;
                    }
                }

                if (!match)
                {
                    newArray[actualCount++] = newAttrs[idx];
                }
            }

            // If some attributes were collapsed, create a new array.
            if (actualCount < newArray.Length)
            {
                attributes = new Attribute[actualCount];
                Array.Copy(newArray, 0, attributes, 0, actualCount);
            }
            else
            {
                attributes = newArray;
            }

            return attributes;
        }
    }
}

Imports System.Collections
Imports System.ComponentModel
Imports System.Text

' The SerializeReadOnlyPropertyDescriptor shows how to implement a 
' custom property descriptor. It provides a read-only wrapper 
' around the specified PropertyDescriptor. 
Friend NotInheritable Class SerializeReadOnlyPropertyDescriptor
    Inherits PropertyDescriptor
    Private _pd As PropertyDescriptor = Nothing


    Public Sub New(ByVal pd As PropertyDescriptor)
        MyBase.New(pd)
        Me._pd = pd

    End Sub


    Public Overrides ReadOnly Property Attributes() As AttributeCollection
        Get
            Return AppendAttributeCollection(Me._pd.Attributes, ReadOnlyAttribute.Yes)
        End Get
    End Property


    Protected Overrides Sub FillAttributes(ByVal attributeList As IList)
        attributeList.Add(ReadOnlyAttribute.Yes)

    End Sub


    Public Overrides ReadOnly Property ComponentType() As Type
        Get
            Return Me._pd.ComponentType
        End Get
    End Property


    ' The type converter for this property.
    ' A translator can overwrite with its own converter.
    Public Overrides ReadOnly Property Converter() As TypeConverter
        Get
            Return Me._pd.Converter
        End Get
    End Property


    ' Returns the property editor 
    ' A translator can overwrite with its own editor.
    Public Overrides Function GetEditor(ByVal editorBaseType As Type) As Object
        Return Me._pd.GetEditor(editorBaseType)

    End Function

    ' Specifies the property is read only.
    Public Overrides ReadOnly Property IsReadOnly() As Boolean
        Get
            Return True
        End Get
    End Property


    Public Overrides ReadOnly Property PropertyType() As Type
        Get
            Return Me._pd.PropertyType
        End Get
    End Property


    Public Overrides Function CanResetValue(ByVal component As Object) As Boolean
        Return Me._pd.CanResetValue(component)

    End Function


    Public Overrides Function GetValue(ByVal component As Object) As Object
        Return Me._pd.GetValue(component)

    End Function


    Public Overrides Sub ResetValue(ByVal component As Object)
        Me._pd.ResetValue(component)

    End Sub


    Public Overrides Sub SetValue(ByVal component As Object, ByVal val As Object)
        Me._pd.SetValue(component, val)

    End Sub

    ' Determines whether a value should be serialized.
    Public Overrides Function ShouldSerializeValue(ByVal component As Object) As Boolean
        Dim result As Boolean = Me._pd.ShouldSerializeValue(component)

        If Not result Then
            Dim dva As DefaultValueAttribute = _
                CType(_pd.Attributes(GetType(DefaultValueAttribute)), DefaultValueAttribute)
            If Not (dva Is Nothing) Then
                result = Not [Object].Equals(Me._pd.GetValue(component), dva.Value)
            Else
                result = True
            End If
        End If

        Return result

    End Function


    ' The following Utility methods create a new AttributeCollection
    ' by appending the specified attributes to an existing collection.
    Public Shared Function AppendAttributeCollection( _
        ByVal existing As AttributeCollection, _
        ByVal ParamArray newAttrs() As Attribute) As AttributeCollection

        Return New AttributeCollection(AppendAttributes(existing, newAttrs))

    End Function

    Public Shared Function AppendAttributes( _
        ByVal existing As AttributeCollection, _
        ByVal ParamArray newAttrs() As Attribute) As Attribute()

        If existing Is Nothing Then
            Throw New ArgumentNullException("existing")
        End If

        If newAttrs Is Nothing Then
            newAttrs = New Attribute(-1) {}
        End If

        Dim attributes() As Attribute

        Dim newArray(existing.Count + newAttrs.Length) As Attribute
        Dim actualCount As Integer = existing.Count
        existing.CopyTo(newArray, 0)

        Dim idx As Integer
        For idx = 0 To newAttrs.Length
            If newAttrs(idx) Is Nothing Then
                Throw New ArgumentNullException("newAttrs")
            End If

            ' Check if this attribute is already in the existing
            ' array.  If it is, replace it.
            Dim match As Boolean = False
            Dim existingIdx As Integer
            For existingIdx = 0 To existing.Count - 1
                If newArray(existingIdx).TypeId.Equals(newAttrs(idx).TypeId) Then
                    match = True
                    newArray(existingIdx) = newAttrs(idx)
                    Exit For
                End If
            Next existingIdx

            If Not match Then
                actualCount += 1
                newArray(actualCount) = newAttrs(idx)
            End If
        Next idx

        ' If some attributes were collapsed, create a new array.
        If actualCount < newArray.Length Then
            attributes = New Attribute(actualCount) {}
            Array.Copy(newArray, 0, attributes, 0, actualCount)
        Else
            attributes = newArray
        End If

        Return attributes

    End Function
End Class

次のコード例は、カスタム デザイナーで SerializeReadOnlyPropertyDescriptor を使用する方法を示しています。

using System.Collections;
using System.ComponentModel;
using System.Windows.Forms.Design;

namespace ReadOnlyPropertyDescriptorTest
{
    class DemoControlDesigner : ControlDesigner
    {
        // The PostFilterProperties method replaces the control's 
        // Size property with a read-only Size property by using 
        // the SerializeReadOnlyPropertyDescriptor class.
        protected override void PostFilterProperties(IDictionary properties)
        {
            if (properties.Contains("Size"))
            {
                PropertyDescriptor original = properties["Size"] as PropertyDescriptor;
                SerializeReadOnlyPropertyDescriptor readOnlyDescriptor = 
                    new SerializeReadOnlyPropertyDescriptor(original);

                properties["Size"] = readOnlyDescriptor;
            }

            base.PostFilterProperties(properties);
        }
    }
}

Imports System.Collections
Imports System.ComponentModel
Imports System.Text
Imports System.Windows.Forms.Design

Class DemoControlDesigner
    Inherits ControlDesigner
    
    ' The PostFilterProperties method replaces the control's 
    ' Size property with a read-only Size property by using 
    ' the SerializeReadOnlyPropertyDescriptor class.
    Protected Overrides Sub PostFilterProperties(ByVal properties As IDictionary) 
        If properties.Contains("Size") Then
            Dim original As PropertyDescriptor = properties("Size")
            
            Dim readOnlyDescriptor As New SerializeReadOnlyPropertyDescriptor(original)
            
            properties("Size") = readOnlyDescriptor
        End If
        
        MyBase.PostFilterProperties(properties)
    
    End Sub
End Class

using System.ComponentModel;
using System.Windows.Forms;

namespace ReadOnlyPropertyDescriptorTest
{
    [Designer(typeof(DemoControlDesigner))]
    public class DemoControl : Control
    {
        public DemoControl()
        {
        }
    }
}

Imports System.ComponentModel
Imports System.ComponentModel.Design
Imports System.Text
Imports System.Windows.Forms
Imports System.Windows.Forms.Design


<Designer(GetType(DemoControlDesigner))>  _
Public Class DemoControl
    Inherits Control
    
    Public Sub New() 
    
    End Sub
End Class

注釈

プロパティの説明は、名前、属性、プロパティが関連付けられているコンポーネント クラス、およびプロパティの型で構成されます。

PropertyDescriptor には、次のプロパティとメソッドが用意されています。

• Converter には、このプロパティの TypeConverter が含まれています。

• IsLocalizable は、このプロパティをローカライズする必要があるかどうかを示します。

• GetEditor は、指定した型のエディターを返します。

PropertyDescriptor には、次の abstract のプロパティとメソッドも用意されています。

• ComponentType には、このプロパティがバインドされているコンポーネントの型が含まれています。

• IsReadOnly は、このプロパティが読み取り専用かどうかを示します。

• PropertyType プロパティの型を取得します。

• CanResetValue は、コンポーネントをリセットするとコンポーネントの値が変更されるかどうかを示します。

• GetValue は、コンポーネントのプロパティの現在の値を返します。

• ResetValue コンポーネントのこのプロパティの値をリセットします。

• SetValue コンポーネントの値を別の値に設定します。

• ShouldSerializeValue は、このプロパティの値を永続化する必要があるかどうかを示します。

通常、abstract メンバーはリフレクションによって実装されます。 リフレクションの詳細については、「リフレクション」のトピックを参照してください。

コンストラクター

PropertyDescriptor(MemberDescriptor)	指定した MemberDescriptorの名前と属性を使用して、PropertyDescriptor クラスの新しいインスタンスを初期化します。
PropertyDescriptor(MemberDescriptor, Attribute[])	指定した MemberDescriptor 内の名前と、MemberDescriptor と Attribute 配列の両方の属性を使用して、PropertyDescriptor クラスの新しいインスタンスを初期化します。
PropertyDescriptor(String, Attribute[])	指定した名前と属性を使用して、PropertyDescriptor クラスの新しいインスタンスを初期化します。

プロパティ

AttributeArray	属性の配列を取得または設定します。 (継承元 MemberDescriptor)
Attributes	このメンバーの属性のコレクションを取得します。 (継承元 MemberDescriptor)
Category	CategoryAttributeで指定されているメンバーが属するカテゴリの名前を取得します。 (継承元 MemberDescriptor)
ComponentType	派生クラスでオーバーライドされると、このプロパティがバインドされているコンポーネントの型を取得します。
Converter	このプロパティの型コンバーターを取得します。
Description	DescriptionAttributeで指定されているメンバーの説明を取得します。 (継承元 MemberDescriptor)
DesignTimeOnly	DesignOnlyAttributeで指定されているように、このメンバーをデザイン時にのみ設定するかどうかを取得します。 (継承元 MemberDescriptor)
DisplayName	プロパティ ウィンドウなど、ウィンドウに表示できる名前を取得します。 (継承元 MemberDescriptor)
IsBrowsable	BrowsableAttributeで指定されているメンバーが参照できるかどうかを示す値を取得します。 (継承元 MemberDescriptor)
IsLocalizable	LocalizableAttributeで指定されているように、このプロパティをローカライズする必要があるかどうかを示す値を取得します。
IsReadOnly	派生クラスでオーバーライドされると、このプロパティが読み取り専用かどうかを示す値を取得します。
Name	メンバーの名前を取得します。 (継承元 MemberDescriptor)
NameHashCode	GetHashCode()で指定されているメンバーの名前のハッシュ コードを取得します。 (継承元 MemberDescriptor)
PropertyType	派生クラスでオーバーライドされると、プロパティの型を取得します。
SerializationVisibility	DesignerSerializationVisibilityAttributeで指定されているように、このプロパティをシリアル化するかどうかを示す値を取得します。
SupportsChangeEvents	このプロパティの値変更通知がプロパティ記述子の外部から送信される可能性があるかどうかを示す値を取得します。

メソッド

AddValueChanged(Object, EventHandler)	このプロパティが変更されたときに他のオブジェクトに通知できるようにします。
CanResetValue(Object)	派生クラスでオーバーライドされると、オブジェクトをリセットしてその値を変更するかどうかを返します。
CreateAttributeCollection()	コンストラクターに渡される属性の配列を使用して、属性のコレクションを作成します。 (継承元 MemberDescriptor)
CreateInstance(Type)	指定した型のインスタンスを作成します。
Equals(Object)	これを別のオブジェクトと比較して、同等であるかどうかを確認します。
FillAttributes(IList)	親クラスの指定した属性リストに PropertyDescriptor の属性を追加します。
GetChildProperties()	既定の PropertyDescriptorCollectionを返します。
GetChildProperties(Attribute[])	指定した属性配列をフィルターとして使用する PropertyDescriptorCollection を返します。
GetChildProperties(Object)	特定のオブジェクトの PropertyDescriptorCollection を返します。
GetChildProperties(Object, Attribute[])	指定した属性配列をフィルターとして使用して、特定のオブジェクトの PropertyDescriptorCollection を返します。
GetEditor(Type)	指定した型のエディターを取得します。
GetHashCode()	このオブジェクトのハッシュ コードを返します。
GetInvocationTarget(Type, Object)	このメソッドは、メンバーの呼び出し中に使用する必要があるオブジェクトを返します。
GetType()	現在のインスタンスの Type を取得します。 (継承元 Object)
GetTypeFromName(String)	名前を使用して型を返します。
GetValue(Object)	派生クラスでオーバーライドされると、コンポーネントのプロパティの現在の値を取得します。
GetValueChangedHandler(Object)	特定のコンポーネントの現在の ValueChanged イベント ハンドラーのセットを取得します。
MemberwiseClone()	現在の Objectの簡易コピーを作成します。 (継承元 Object)
OnValueChanged(Object, EventArgs)	実装した ValueChanged イベントを発生させます。
RemoveValueChanged(Object, EventHandler)	このプロパティが変更されたときに他のオブジェクトに通知できるようにします。
ResetValue(Object)	派生クラスでオーバーライドされると、コンポーネントのこのプロパティの値を既定値にリセットします。
SetValue(Object, Object)	派生クラスでオーバーライドされた場合は、コンポーネントの値を別の値に設定します。
ShouldSerializeValue(Object)	派生クラスでオーバーライドされた場合、このプロパティの値を永続化する必要があるかどうかを示す値を決定します。
ToString()	現在のオブジェクトを表す文字列を返します。 (継承元 Object)

こちらもご覧ください

• MemberDescriptor
• Attribute
• DefaultValueAttribute