PropertyDescriptor Klasa

Definicja

Przestrzeń nazw:

System.ComponentModel

Zestaw:

System.ComponentModel.TypeConverter.dll

Źródło:

PropertyDescriptor.cs

Zapewnia abstrakcję właściwości w klasie.

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

Dziedziczenie

Object

MemberDescriptor

PropertyDescriptor

Pochodne

System.ComponentModel.DependencyPropertyDescriptor

System.ComponentModel.TypeConverter.SimplePropertyDescriptor

Przykłady

Poniższy przykład kodu jest oparty na przykładzie w klasie PropertyDescriptorCollection. Wyświetla informacje (kategoria, opis, nazwa wyświetlana) tekstu przycisku w polu tekstowym. Przyjęto założenie, że button1 i textbox1 zostały utworzone na formularzu.

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

W poniższym przykładzie kodu pokazano, jak zaimplementować deskryptor właściwości niestandardowej, który zapewnia otokę tylko do odczytu wokół właściwości. SerializeReadOnlyPropertyDescriptor jest używany w projektancie niestandardowym do udostępniania deskryptora właściwości tylko do odczytu dla właściwości Size kontrolki.

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

W poniższych przykładach kodu pokazano, jak używać SerializeReadOnlyPropertyDescriptor w projektancie niestandardowym.

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

Uwagi

Opis właściwości składa się z nazwy, jej atrybutów, klasy składnika, z którą jest skojarzona właściwość, oraz typu właściwości.

PropertyDescriptor udostępnia następujące właściwości i metody:

• Converter zawiera TypeConverter dla tej właściwości.

• IsLocalizable wskazuje, czy ta właściwość powinna być zlokalizowana.

• GetEditor zwraca edytor określonego typu.

PropertyDescriptor również udostępnia następujące właściwości i metody abstract:

• ComponentType zawiera typ składnika, z którym jest powiązana ta właściwość.

• IsReadOnly wskazuje, czy ta właściwość jest tylko do odczytu.

• PropertyType pobiera typ właściwości.

• CanResetValue wskazuje, czy zresetowanie składnika zmienia wartość składnika.

• GetValue zwraca bieżącą wartość właściwości w składniku.

• ResetValue resetuje wartość dla tej właściwości składnika.

• SetValue ustawia wartość składnika na inną wartość.

• ShouldSerializeValue wskazuje, czy wartość tej właściwości musi być utrwalone.

Zazwyczaj elementy członkowskie abstract są implementowane poprzez odbicie. Aby uzyskać więcej informacji na temat odbicia, zobacz tematy w odbicie.

Konstruktory

PropertyDescriptor(MemberDescriptor)	Inicjuje nowe wystąpienie klasy PropertyDescriptor o nazwie i atrybutach w określonym MemberDescriptor.
PropertyDescriptor(MemberDescriptor, Attribute[])	Inicjuje nowe wystąpienie klasy PropertyDescriptor o nazwie w określonej MemberDescriptor oraz atrybuty zarówno w MemberDescriptor, jak i tablicy Attribute.
PropertyDescriptor(String, Attribute[])	Inicjuje nowe wystąpienie klasy PropertyDescriptor o określonej nazwie i atrybutach.

Właściwości

AttributeArray	Pobiera lub ustawia tablicę atrybutów. (Odziedziczone po MemberDescriptor)
Attributes	Pobiera kolekcję atrybutów dla tego elementu członkowskiego. (Odziedziczone po MemberDescriptor)
Category	Pobiera nazwę kategorii, do której należy element członkowski, jak określono w CategoryAttribute. (Odziedziczone po MemberDescriptor)
ComponentType	Po zastąpieniu w klasie pochodnej pobiera typ składnika, z którego jest powiązana ta właściwość.
Converter	Pobiera konwerter typów dla tej właściwości.
Description	Pobiera opis elementu członkowskiego, jak określono w DescriptionAttribute. (Odziedziczone po MemberDescriptor)
DesignTimeOnly	Pobiera, czy ten element członkowski powinien być ustawiany tylko w czasie projektowania, jak określono w DesignOnlyAttribute. (Odziedziczone po MemberDescriptor)
DisplayName	Pobiera nazwę, która może być wyświetlana w oknie, takim jak okno Właściwości. (Odziedziczone po MemberDescriptor)
IsBrowsable	Pobiera wartość wskazującą, czy element członkowski można przeglądać, jak określono w BrowsableAttribute. (Odziedziczone po MemberDescriptor)
IsLocalizable	Pobiera wartość wskazującą, czy ta właściwość powinna być zlokalizowana, jak określono w LocalizableAttribute.
IsReadOnly	Po zastąpieniu w klasie pochodnej pobiera wartość wskazującą, czy ta właściwość jest tylko do odczytu.
Name	Pobiera nazwę elementu członkowskiego. (Odziedziczone po MemberDescriptor)
NameHashCode	Pobiera kod skrótu dla nazwy elementu członkowskiego, jak określono w GetHashCode(). (Odziedziczone po MemberDescriptor)
PropertyType	Po przesłonięciu w klasie pochodnej pobiera typ właściwości.
SerializationVisibility	Pobiera wartość wskazującą, czy ta właściwość powinna być serializowana, jak określono w DesignerSerializationVisibilityAttribute.
SupportsChangeEvents	Pobiera wartość wskazującą, czy powiadomienia o zmianie wartości dla tej właściwości mogą pochodzić spoza deskryptora właściwości.

Metody

AddValueChanged(Object, EventHandler)	Umożliwia powiadamianie innych obiektów o zmianie tej właściwości.
CanResetValue(Object)	Po zastąpieniu w klasie pochodnej zwraca, czy zresetowanie obiektu zmienia jego wartość.
CreateAttributeCollection()	Tworzy kolekcję atrybutów przy użyciu tablicy atrybutów przekazanych do konstruktora. (Odziedziczone po MemberDescriptor)
CreateInstance(Type)	Tworzy wystąpienie określonego typu.
Equals(Object)	Porównuje to z innym obiektem, aby sprawdzić, czy są równoważne.
FillAttributes(IList)	Dodaje atrybuty PropertyDescriptor do określonej listy atrybutów w klasie nadrzędnej.
GetChildProperties()	Zwraca wartość domyślną PropertyDescriptorCollection.
GetChildProperties(Attribute[])	Zwraca PropertyDescriptorCollection przy użyciu określonej tablicy atrybutów jako filtru.
GetChildProperties(Object)	Zwraca PropertyDescriptorCollection dla danego obiektu.
GetChildProperties(Object, Attribute[])	Zwraca PropertyDescriptorCollection dla danego obiektu przy użyciu określonej tablicy atrybutów jako filtru.
GetEditor(Type)	Pobiera edytor określonego typu.
GetHashCode()	Zwraca kod skrótu dla tego obiektu.
GetInvocationTarget(Type, Object)	Ta metoda zwraca obiekt, który powinien być używany podczas wywołania elementów członkowskich.
GetType()	Pobiera Type bieżącego wystąpienia. (Odziedziczone po Object)
GetTypeFromName(String)	Zwraca typ używający jego nazwy.
GetValue(Object)	Po zastąpieniu w klasie pochodnej pobiera bieżącą wartość właściwości w składniku.
GetValueChangedHandler(Object)	Pobiera bieżący zestaw programów obsługi zdarzeń ValueChanged dla określonego składnika.
MemberwiseClone()	Tworzy płytkią kopię bieżącego Object. (Odziedziczone po Object)
OnValueChanged(Object, EventArgs)	Zgłasza zaimplementowane zdarzenie ValueChanged.
RemoveValueChanged(Object, EventHandler)	Umożliwia powiadamianie innych obiektów o zmianie tej właściwości.
ResetValue(Object)	Po zastąpieniu w klasie pochodnej resetuje wartość tej właściwości składnika do wartości domyślnej.
SetValue(Object, Object)	Po zastąpieniu w klasie pochodnej ustawia wartość składnika na inną wartość.
ShouldSerializeValue(Object)	Po zastąpieniu w klasie pochodnej określa wartość wskazującą, czy wartość tej właściwości musi być utrwalone.
ToString()	Zwraca ciąg reprezentujący bieżący obiekt. (Odziedziczone po Object)

Zobacz też

• MemberDescriptor
• Attribute
• DefaultValueAttribute