PropertyDescriptor Sınıf

Tanım

Ad Alanı:

System.ComponentModel

Bütünleştirilmiş Kod:

System.ComponentModel.TypeConverter.dll

Kaynak:

PropertyDescriptor.cs

Bir sınıftaki bir özelliğin özetini sağlar.

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

Devralma

Object

MemberDescriptor

PropertyDescriptor

Türetilmiş

System.ComponentModel.DependencyPropertyDescriptor

System.ComponentModel.TypeConverter.SimplePropertyDescriptor

Örnekler

Aşağıdaki kod örneği, PropertyDescriptorCollection sınıfındaki örneğin üzerine kurulmuştur. Düğme metninin bilgilerini (kategori, açıklama, görünen ad) bir metin kutusuna yazdırır. button1 ve textbox1 bir formda örneklendiğini varsayar.

// 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

Aşağıdaki kod örneği, bir özelliğin çevresinde salt okunur sarmalayıcı sağlayan özel bir özellik tanımlayıcısının nasıl uygulandığını gösterir. SerializeReadOnlyPropertyDescriptor, denetimin Size özelliği için salt okunur özellik tanımlayıcısı sağlamak üzere özel bir tasarımcıda kullanılır.

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

Aşağıdaki kod örneklerinde özel tasarımcıda SerializeReadOnlyPropertyDescriptor nasıl kullanılacağı gösterilmektedir.

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

Açıklamalar

Bir özelliğin açıklaması bir ad, öznitelikleri, özelliğin ilişkili olduğu bileşen sınıfı ve özelliğin türünden oluşur.

PropertyDescriptor aşağıdaki özellikleri ve yöntemleri sağlar:

• Converter bu özelliğin TypeConverter içerir.

• IsLocalizable bu özelliğin yerelleştirilmesi gerekip gerekmediğini gösterir.

• GetEditor belirtilen türde bir düzenleyici döndürür.

PropertyDescriptor ayrıca aşağıdaki abstract özelliklerini ve yöntemlerini de sağlar:

• ComponentType bu özelliğin bağlı olduğu bileşen türünü içerir.

• IsReadOnly bu özelliğin salt okunur olup olmadığını gösterir.

• PropertyType özelliğin türünü alır.

• CanResetValue, bileşeni sıfırlamanın bileşenin değerini değiştirip değiştirmediğini gösterir.

• GetValue bir bileşendeki özelliğin geçerli değerini döndürür.

• ResetValue bileşenin bu özelliğinin değerini sıfırlar.

• SetValue bileşenin değerini farklı bir değere ayarlar.

• ShouldSerializeValue, bu özelliğin değerinin kalıcı olması gerekip gerekmediğini gösterir.

Genellikle, abstract üyeleri yansıma yoluyla uygulanır. Yansıma hakkında daha fazla bilgi için Yansımakonusuna bakın.

Oluşturucular

PropertyDescriptor(MemberDescriptor)	belirtilen MemberDescriptoriçinde adı ve öznitelikleriyle PropertyDescriptor sınıfının yeni bir örneğini başlatır.
PropertyDescriptor(MemberDescriptor, Attribute[])	Belirtilen MemberDescriptor adı ve hem MemberDescriptor hem de Attribute dizisindeki özniteliklerle PropertyDescriptor sınıfının yeni bir örneğini başlatır.
PropertyDescriptor(String, Attribute[])	Belirtilen ad ve özniteliklerle PropertyDescriptor sınıfının yeni bir örneğini başlatır.

Özellikler

AttributeArray	Öznitelik dizisini alır veya ayarlar. (Devralındığı yer: MemberDescriptor)
Attributes	Bu üye için öznitelik koleksiyonunu alır. (Devralındığı yer: MemberDescriptor)
Category	CategoryAttributebelirtildiği gibi, üyenin ait olduğu kategorinin adını alır. (Devralındığı yer: MemberDescriptor)
ComponentType	Türetilmiş bir sınıfta geçersiz kılındığında, bu özelliğin bağlı olduğu bileşenin türünü alır.
Converter	Bu özellik için tür dönüştürücüsünü alır.
Description	DescriptionAttributebelirtildiği gibi üyenin açıklamasını alır. (Devralındığı yer: MemberDescriptor)
DesignTimeOnly	Bu üyenin DesignOnlyAttributebelirtildiği gibi yalnızca tasarım zamanında ayarlanıp ayarlanmayacağını alır. (Devralındığı yer: MemberDescriptor)
DisplayName	Özellikler penceresi gibi bir pencerede görüntülenebilen adı alır. (Devralındığı yer: MemberDescriptor)
IsBrowsable	BrowsableAttributebelirtildiği gibi üyenin gözatılabilir olup olmadığını belirten bir değer alır. (Devralındığı yer: MemberDescriptor)
IsLocalizable	LocalizableAttributebelirtildiği gibi bu özelliğin yerelleştirilip yerelleştirilmeyeceğini belirten bir değer alır.
IsReadOnly	Türetilmiş bir sınıfta geçersiz kılındığında, bu özelliğin salt okunur olup olmadığını belirten bir değer alır.
Name	Üyenin adını alır. (Devralındığı yer: MemberDescriptor)
NameHashCode	GetHashCode()'de belirtildiği gibi üyenin adının karma kodunu alır. (Devralındığı yer: MemberDescriptor)
PropertyType	Türetilmiş bir sınıfta geçersiz kılındığında özelliğinin türünü alır.
SerializationVisibility	DesignerSerializationVisibilityAttributebelirtildiği gibi bu özelliğin seri hale getirilip getirilmeyeceğini belirten bir değer alır.
SupportsChangeEvents	Bu özellik için değer değişikliği bildirimlerinin özellik tanımlayıcısının dışından kaynaklanıp kaynaklanmayabileceğini belirten bir değer alır.

Yöntemler

AddValueChanged(Object, EventHandler)	Bu özellik değiştiğinde diğer nesnelerin bildirilmesini sağlar.
CanResetValue(Object)	Türetilmiş bir sınıfta geçersiz kılındığında, bir nesnenin sıfırlanması değerini değiştirip değiştirmediğini döndürür.
CreateAttributeCollection()	Oluşturucuya geçirilen öznitelik dizisini kullanarak bir öznitelik koleksiyonu oluşturur. (Devralındığı yer: MemberDescriptor)
CreateInstance(Type)	Belirtilen türün bir örneğini oluşturur.
Equals(Object)	Eşdeğer olup olmadığını görmek için bunu başka bir nesneyle karşılaştırır.
FillAttributes(IList)	PropertyDescriptor özniteliklerini üst sınıfta belirtilen öznitelik listesine ekler.
GetChildProperties()	varsayılan PropertyDescriptorCollectiondöndürür.
GetChildProperties(Attribute[])	Filtre olarak belirtilen öznitelik dizisini kullanarak bir PropertyDescriptorCollection döndürür.
GetChildProperties(Object)	Belirli bir nesne için bir PropertyDescriptorCollection döndürür.
GetChildProperties(Object, Attribute[])	Belirli bir öznitelik dizisini filtre olarak kullanarak belirli bir nesne için bir PropertyDescriptorCollection döndürür.
GetEditor(Type)	Belirtilen türde bir düzenleyici alır.
GetHashCode()	Bu nesnenin karma kodunu döndürür.
GetInvocationTarget(Type, Object)	Bu yöntem, üyelerin çağrılması sırasında kullanılması gereken nesneyi döndürür.
GetType()	Geçerli örneğin Type alır. (Devralındığı yer: Object)
GetTypeFromName(String)	Adını kullanarak bir tür döndürür.
GetValue(Object)	Türetilmiş bir sınıfta geçersiz kılındığında, bir bileşendeki özelliğin geçerli değerini alır.
GetValueChangedHandler(Object)	Belirli bir bileşen için geçerli ValueChanged olay işleyicileri kümesini alır.
MemberwiseClone()	Geçerli Objectbasit bir kopyasını oluşturur. (Devralındığı yer: Object)
OnValueChanged(Object, EventArgs)	Uyguladığınız ValueChanged olayını oluşturur.
RemoveValueChanged(Object, EventHandler)	Bu özellik değiştiğinde diğer nesnelerin bildirilmesini sağlar.
ResetValue(Object)	Türetilmiş bir sınıfta geçersiz kılındığında, bileşenin bu özelliğinin değerini varsayılan değere sıfırlar.
SetValue(Object, Object)	Türetilmiş bir sınıfta geçersiz kılındığında, bileşenin değerini farklı bir değere ayarlar.
ShouldSerializeValue(Object)	Türetilmiş bir sınıfta geçersiz kılındığında, bu özelliğin değerinin kalıcı olması gerekip gerekmediğini belirten bir değer belirler.
ToString()	Geçerli nesneyi temsil eden bir dize döndürür. (Devralındığı yer: Object)

Ayrıca bkz.

• MemberDescriptor
• Attribute
• DefaultValueAttribute