Lire en anglais

Partager via


PropertyDescriptor Classe

Définition

Fournit une abstraction d’une propriété sur une classe.

public abstract class PropertyDescriptor : System.ComponentModel.MemberDescriptor
[System.Runtime.InteropServices.ComVisible(true)]
public abstract class PropertyDescriptor : System.ComponentModel.MemberDescriptor
Héritage
PropertyDescriptor
Dérivé
Attributs

Exemples

L’exemple de code suivant est basé sur l’exemple dans la classe PropertyDescriptorCollection. Il imprime les informations (catégorie, description, nom complet) du texte d’un bouton dans une zone de texte. Il suppose que button1 et textbox1 ont été instanciés sur un formulaire.

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

L’exemple de code suivant montre comment implémenter un descripteur de propriété personnalisé qui fournit un wrapper en lecture seule autour d’une propriété. Le SerializeReadOnlyPropertyDescriptor est utilisé dans un concepteur personnalisé pour fournir un descripteur de propriété en lecture seule pour la propriété Size du contrôle.

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;
        }
    }
}

Les exemples de code suivants montrent comment utiliser la SerializeReadOnlyPropertyDescriptor dans un concepteur personnalisé.

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);
        }
    }
}
using System.ComponentModel;
using System.Windows.Forms;

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

Remarques

Une description d’une propriété se compose d’un nom, de ses attributs, de la classe de composant à laquelle la propriété est associée et du type de la propriété.

PropertyDescriptor fournit les propriétés et méthodes suivantes :

PropertyDescriptor fournit également les propriétés et méthodes de abstract suivantes :

  • ComponentType contient le type de composant auquel cette propriété est liée.

  • IsReadOnly indique si cette propriété est en lecture seule.

  • PropertyType obtient le type de la propriété.

  • CanResetValue indique si la réinitialisation du composant modifie la valeur du composant.

  • GetValue retourne la valeur actuelle de la propriété sur un composant.

  • ResetValue réinitialise la valeur de cette propriété du composant.

  • SetValue définit la valeur du composant sur une valeur différente.

  • ShouldSerializeValue indique si la valeur de cette propriété doit être conservée.

En règle générale, les membres abstract sont implémentés par réflexion. Pour plus d’informations sur la réflexion, consultez les rubriques de réflexion.

Constructeurs

PropertyDescriptor(MemberDescriptor)

Initialise une nouvelle instance de la classe PropertyDescriptor avec le nom et les attributs dans le MemberDescriptorspécifié.

PropertyDescriptor(MemberDescriptor, Attribute[])

Initialise une nouvelle instance de la classe PropertyDescriptor avec le nom dans le MemberDescriptor spécifié et les attributs dans les MemberDescriptor et le tableau Attribute.

PropertyDescriptor(String, Attribute[])

Initialise une nouvelle instance de la classe PropertyDescriptor avec le nom et les attributs spécifiés.

Propriétés

AttributeArray

Obtient ou définit un tableau d’attributs.

(Hérité de MemberDescriptor)
Attributes

Obtient la collection d’attributs pour ce membre.

(Hérité de MemberDescriptor)
Category

Obtient le nom de la catégorie à laquelle appartient le membre, comme spécifié dans la CategoryAttribute.

(Hérité de MemberDescriptor)
ComponentType

En cas de substitution dans une classe dérivée, obtient le type du composant auquel cette propriété est liée.

Converter

Obtient le convertisseur de type pour cette propriété.

ConverterFromRegisteredType

Obtient le convertisseur de type pour cette propriété.

Description

Obtient la description du membre, comme spécifié dans la DescriptionAttribute.

(Hérité de MemberDescriptor)
DesignTimeOnly

Obtient si ce membre doit être défini uniquement au moment du design, comme spécifié dans la DesignOnlyAttribute.

(Hérité de MemberDescriptor)
DisplayName

Obtient le nom qui peut être affiché dans une fenêtre, telle qu’une fenêtre Propriétés.

(Hérité de MemberDescriptor)
IsBrowsable

Obtient une valeur indiquant si le membre est extensible, comme spécifié dans la BrowsableAttribute.

(Hérité de MemberDescriptor)
IsLocalizable

Obtient une valeur indiquant si cette propriété doit être localisée, comme spécifié dans le LocalizableAttribute.

IsReadOnly

En cas de substitution dans une classe dérivée, obtient une valeur indiquant si cette propriété est en lecture seule.

Name

Obtient le nom du membre.

(Hérité de MemberDescriptor)
NameHashCode

Obtient le code de hachage pour le nom du membre, comme spécifié dans GetHashCode().

(Hérité de MemberDescriptor)
PropertyType

En cas de substitution dans une classe dérivée, obtient le type de la propriété.

SerializationVisibility

Obtient une valeur indiquant si cette propriété doit être sérialisée, comme spécifié dans la DesignerSerializationVisibilityAttribute.

SupportsChangeEvents

Obtient une valeur indiquant si les notifications de modification de valeur pour cette propriété peuvent provenir de l’extérieur du descripteur de propriété.

Méthodes

AddValueChanged(Object, EventHandler)

Permet à d’autres objets d’être avertis lorsque cette propriété change.

CanResetValue(Object)

En cas de substitution dans une classe dérivée, retourne si la réinitialisation d’un objet change sa valeur.

CreateAttributeCollection()

Crée une collection d’attributs à l’aide du tableau d’attributs transmis au constructeur.

(Hérité de MemberDescriptor)
CreateInstance(Type)

Crée une instance du type spécifié.

Equals(Object)

Compare cela à un autre objet pour voir s’ils sont équivalents.

FillAttributes(IList)

Ajoute les attributs de l'PropertyDescriptor à la liste spécifiée d’attributs dans la classe parente.

FillAttributes(IList)

En cas de substitution dans une classe dérivée, ajoute les attributs de la classe héritée à la liste spécifiée d’attributs dans la classe parente.

(Hérité de MemberDescriptor)
GetChildProperties()

Retourne la PropertyDescriptorCollectionpar défaut .

GetChildProperties(Attribute[])

Retourne un PropertyDescriptorCollection à l’aide d’un tableau d’attributs spécifié en tant que filtre.

GetChildProperties(Object)

Retourne une PropertyDescriptorCollection pour un objet donné.

GetChildProperties(Object, Attribute[])

Retourne un PropertyDescriptorCollection pour un objet donné à l’aide d’un tableau d’attributs spécifié en tant que filtre.

GetEditor(Type)

Obtient un éditeur du type spécifié.

GetHashCode()

Retourne le code de hachage de cet objet.

GetInvocationTarget(Type, Object)

Cette méthode retourne l’objet qui doit être utilisé pendant l’appel des membres.

GetInvocationTarget(Type, Object)

Récupère l’objet qui doit être utilisé pendant l’appel des membres.

(Hérité de MemberDescriptor)
GetType()

Obtient la Type de l’instance actuelle.

(Hérité de Object)
GetTypeFromName(String)

Retourne un type à l’aide de son nom.

GetValue(Object)

En cas de substitution dans une classe dérivée, obtient la valeur actuelle de la propriété sur un composant.

GetValueChangedHandler(Object)

Récupère l’ensemble actuel de gestionnaires d’événements ValueChanged pour un composant spécifique.

MemberwiseClone()

Crée une copie superficielle du Objectactuel.

(Hérité de Object)
OnValueChanged(Object, EventArgs)

Déclenche l’événement ValueChanged que vous avez implémenté.

RemoveValueChanged(Object, EventHandler)

Permet à d’autres objets d’être avertis lorsque cette propriété change.

ResetValue(Object)

En cas de substitution dans une classe dérivée, réinitialise la valeur de cette propriété du composant à la valeur par défaut.

SetValue(Object, Object)

En cas de substitution dans une classe dérivée, définit la valeur du composant sur une valeur différente.

ShouldSerializeValue(Object)

En cas de substitution dans une classe dérivée, détermine une valeur indiquant si la valeur de cette propriété doit être conservée.

ToString()

Retourne une chaîne qui représente l’objet actuel.

(Hérité de Object)

S’applique à

Produit Versions
.NET Core 1.0, Core 1.1, Core 2.0, Core 2.1, Core 2.2, Core 3.0, Core 3.1, 5, 6, 7, 8, 9
.NET Framework 1.1, 2.0, 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1
.NET Standard 2.0, 2.1

Voir aussi