PropertyDescriptor Třída

Definice

Obor názvů:

System.ComponentModel

Sestavení:

System.ComponentModel.TypeConverter.dll

Zdroj:

PropertyDescriptor.cs

Poskytuje abstrakci vlastnosti třídy.

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

Dědičnost

Object

MemberDescriptor

PropertyDescriptor

Odvozené

System.ComponentModel.DependencyPropertyDescriptor

System.ComponentModel.TypeConverter.SimplePropertyDescriptor

Příklady

Následující příklad kódu je postaven na příkladu v PropertyDescriptorCollection třídy. Vytiskne informace (kategorie, popis, zobrazovaný název) textu tlačítka v textovém poli. Předpokládá se, že button1 a textbox1 byly ve formuláři vytvořena instance.

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

Následující příklad kódu ukazuje, jak implementovat vlastní popisovač vlastnosti, který poskytuje obálku jen pro čtení kolem vlastnosti. SerializeReadOnlyPropertyDescriptor se používá ve vlastním návrháři k poskytnutí popisovače vlastnosti jen pro čtení pro vlastnost Size ovládacího prvku.

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

Následující příklady kódu ukazují, jak používat SerializeReadOnlyPropertyDescriptor ve vlastním návrháři.

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

Poznámky

Popis vlastnosti se skládá z názvu, jeho atributů, třídy komponenty, ke které je vlastnost přidružena, a typu vlastnosti.

PropertyDescriptor poskytuje následující vlastnosti a metody:

• Converter obsahuje TypeConverter pro tuto vlastnost.

• IsLocalizable označuje, zda má být tato vlastnost lokalizována.

• GetEditor vrátí editor zadaného typu.

PropertyDescriptor také poskytuje následující vlastnosti a metody abstract:

• ComponentType obsahuje typ komponenty, ke které je tato vlastnost vázána.

• IsReadOnly označuje, zda je tato vlastnost určena jen pro čtení.

• PropertyType získá typ vlastnosti.

• CanResetValue označuje, jestli resetování komponenty změní hodnotu komponenty.

• GetValue vrátí aktuální hodnotu vlastnosti komponenty.

• ResetValue resetuje hodnotu této vlastnosti komponenty.

• SetValue nastaví hodnotu komponenty na jinou hodnotu.

• ShouldSerializeValue označuje, zda je potřeba zachovat hodnotu této vlastnosti.

Členy abstract se obvykle implementují prostřednictvím reflexe. Další informace o reflexi naleznete v tématech v Reflexe.

Konstruktory

PropertyDescriptor(MemberDescriptor)	Inicializuje novou instanci třídy PropertyDescriptor s názvem a atributy v zadané MemberDescriptor.
PropertyDescriptor(MemberDescriptor, Attribute[])	Inicializuje novou instanci třídy PropertyDescriptor s názvem v zadaném MemberDescriptor a atributy v MemberDescriptor i pole Attribute.
PropertyDescriptor(String, Attribute[])	Inicializuje novou instanci PropertyDescriptor třídy se zadaným názvem a atributy.

Vlastnosti

AttributeArray	Získá nebo nastaví pole atributů. (Zděděno od MemberDescriptor)
Attributes	Získá kolekci atributů pro tohoto člena. (Zděděno od MemberDescriptor)
Category	Získá název kategorie, do které člen patří, jak je uvedeno v CategoryAttribute. (Zděděno od MemberDescriptor)
ComponentType	Při přepsání v odvozené třídě získá typ komponenty, ke které je tato vlastnost vázána.
Converter	Získá převaděč typů pro tuto vlastnost.
Description	Získá popis členu, jak je uvedeno v DescriptionAttribute. (Zděděno od MemberDescriptor)
DesignTimeOnly	Získá zda tento člen by měl být nastaven pouze v době návrhu, jak je uvedeno v DesignOnlyAttribute. (Zděděno od MemberDescriptor)
DisplayName	Získá název, který lze zobrazit v okně, například okno Vlastnosti. (Zděděno od MemberDescriptor)
IsBrowsable	Získá hodnotu určující, zda člen je browsable, jak je uvedeno v BrowsableAttribute. (Zděděno od MemberDescriptor)
IsLocalizable	Získá hodnotu určující, zda má být tato vlastnost lokalizována, jak je uvedeno v LocalizableAttribute.
IsReadOnly	Při přepsání v odvozené třídě získá hodnotu určující, zda je tato vlastnost jen pro čtení.
Name	Získá jméno člena. (Zděděno od MemberDescriptor)
NameHashCode	Získá hash kód pro název člena, jak je uvedeno v GetHashCode(). (Zděděno od MemberDescriptor)
PropertyType	Při přepsání v odvozené třídě získá typ vlastnosti.
SerializationVisibility	Získá hodnotu určující, zda má být tato vlastnost serializována, jak je uvedeno v DesignerSerializationVisibilityAttribute.
SupportsChangeEvents	Získá hodnotu určující, zda změna hodnoty oznámení pro tuto vlastnost může pocházet z mimo popisovač vlastnosti.

Metody

AddValueChanged(Object, EventHandler)	Umožňuje upozorňování na další objekty při změně této vlastnosti.
CanResetValue(Object)	Při přepsání v odvozené třídě vrátí, zda resetování objektu změní jeho hodnotu.
CreateAttributeCollection()	Vytvoří kolekci atributů pomocí pole atributů předaných konstruktoru. (Zděděno od MemberDescriptor)
CreateInstance(Type)	Vytvoří instanci zadaného typu.
Equals(Object)	Porovná to s jiným objektem a zjistí, jestli jsou ekvivalentní.
FillAttributes(IList)	Přidá atributy PropertyDescriptor do zadaného seznamu atributů v nadřazené třídě.
GetChildProperties()	Vrátí výchozí PropertyDescriptorCollection.
GetChildProperties(Attribute[])	Vrátí PropertyDescriptorCollection pomocí zadaného pole atributů jako filtru.
GetChildProperties(Object)	Vrátí PropertyDescriptorCollection pro daný objekt.
GetChildProperties(Object, Attribute[])	Vrátí PropertyDescriptorCollection pro daný objekt pomocí zadaného pole atributů jako filtru.
GetEditor(Type)	Získá editor zadaného typu.
GetHashCode()	Vrátí kód hash pro tento objekt.
GetInvocationTarget(Type, Object)	Tato metoda vrátí objekt, který by se měl použít při vyvolání členů.
GetType()	Získá Type aktuální instance. (Zděděno od Object)
GetTypeFromName(String)	Vrátí typ s použitím názvu.
GetValue(Object)	Při přepsání v odvozené třídě získá aktuální hodnotu vlastnosti komponenty.
GetValueChangedHandler(Object)	Načte aktuální sadu obslužných rutin událostí ValueChanged pro konkrétní komponentu.
MemberwiseClone()	Vytvoří mělkou kopii aktuálního Object. (Zděděno od Object)
OnValueChanged(Object, EventArgs)	Vyvolá ValueChanged událost, kterou jste implementovali.
RemoveValueChanged(Object, EventHandler)	Umožňuje upozorňování na další objekty při změně této vlastnosti.
ResetValue(Object)	Při přepsání v odvozené třídě, resetuje hodnotu této vlastnosti komponenty na výchozí hodnotu.
SetValue(Object, Object)	Při přepsání v odvozené třídě nastaví hodnotu komponenty na jinou hodnotu.
ShouldSerializeValue(Object)	Při přepsání v odvozené třídě určuje hodnotu určující, zda hodnota této vlastnosti musí být zachována.
ToString()	Vrátí řetězec, který představuje aktuální objekt. (Zděděno od Object)

Viz také

• MemberDescriptor
• Attribute
• DefaultValueAttribute