Este artículo se tradujo automáticamente. Para ver el artículo en inglés, active la casilla Inglés. Además, puede mostrar el texto en inglés en una ventana emergente si mueve el puntero del mouse sobre el texto.
Traducción
Inglés

Clase PropertyDescriptor

 

Publicado: octubre de 2016

Proporciona una abstracción de una propiedad en una clase.

Espacio de nombres:   System.ComponentModel
Ensamblado:  System (en System.dll)


<ComVisibleAttribute(True)>
<HostProtectionAttribute(SecurityAction.LinkDemand, SharedState := True)>
Public MustInherit Class PropertyDescriptor
	Inherits MemberDescriptor

NombreDescripción
System_CAPS_protmethodPropertyDescriptor(MemberDescriptor)

Inicializa una nueva instancia de la PropertyDescriptor clase con el nombre y los atributos de la manera especificada MemberDescriptor.

System_CAPS_protmethodPropertyDescriptor(MemberDescriptor, Attribute())

Inicializa una nueva instancia de la PropertyDescriptor clase con el nombre especificado MemberDescriptor y los atributos de la MemberDescriptor y la Attribute matriz.

System_CAPS_protmethodPropertyDescriptor(String, Attribute())

Inicializa una nueva instancia de la PropertyDescriptor clase con el nombre especificado y atributos.

NombreDescripción
System_CAPS_protpropertyAttributeArray

Obtiene o establece una matriz de atributos.(Heredado de MemberDescriptor).

System_CAPS_pubpropertyAttributes

Obtiene la colección de atributos para este miembro.(Heredado de MemberDescriptor).

System_CAPS_pubpropertyCategory

Obtiene el nombre de la categoría a la que pertenece el miembro, como se especifica en el CategoryAttribute.(Heredado de MemberDescriptor).

System_CAPS_pubpropertyComponentType

Cuando se invalida en una clase derivada, obtiene el tipo del componente que está enlazada esta propiedad.

System_CAPS_pubpropertyConverter

Obtiene el convertidor de tipos para esta propiedad.

System_CAPS_pubpropertyDescription

Obtiene la descripción del miembro, como se especifica en el DescriptionAttribute.(Heredado de MemberDescriptor).

System_CAPS_pubpropertyDesignTimeOnly

Obtiene si este miembro debe establecerse solo en tiempo de diseño, como se especifica en el DesignOnlyAttribute.(Heredado de MemberDescriptor).

System_CAPS_pubpropertyDisplayName

Obtiene el nombre que se puede mostrar en una ventana, como la ventana Propiedades.(Heredado de MemberDescriptor).

System_CAPS_pubpropertyIsBrowsable

Obtiene un valor que indica si el miembro se puede examinar, como se especifica en el BrowsableAttribute.(Heredado de MemberDescriptor).

System_CAPS_pubpropertyIsLocalizable

Obtiene un valor que indica si esta propiedad se debe traducir, según lo especificado en el LocalizableAttribute.

System_CAPS_pubpropertyIsReadOnly

Cuando se invalida en una clase derivada, obtiene un valor que indica si esta propiedad es de sólo lectura.

System_CAPS_pubpropertyName

Obtiene el nombre del miembro.(Heredado de MemberDescriptor).

System_CAPS_protpropertyNameHashCode

Obtiene el código hash para el nombre del miembro, como se especifica en GetHashCode.(Heredado de MemberDescriptor).

System_CAPS_pubpropertyPropertyType

Cuando se invalida en una clase derivada, obtiene el tipo de la propiedad.

System_CAPS_pubpropertySerializationVisibility

Obtiene un valor que indica si esta propiedad se debe serializar, según se especifica en el DesignerSerializationVisibilityAttribute.

System_CAPS_pubpropertySupportsChangeEvents

Obtiene un valor que indica si las notificaciones de cambio de valor de esta propiedad pueden originarse fuera del descriptor de propiedad.

NombreDescripción
System_CAPS_pubmethodAddValueChanged(Object, EventHandler)

Permite a otros objetos que se le notifique cuando cambia esta propiedad.

System_CAPS_pubmethodCanResetValue(Object)

Cuando se invalida en una clase derivada, devuelve si al restablecer un objeto cambia su valor.

System_CAPS_protmethodCreateAttributeCollection()

Crea una colección de atributos mediante la matriz de atributos que se pasó al constructor.(Heredado de MemberDescriptor).

System_CAPS_protmethodCreateInstance(Type)

Crea una instancia del tipo especificado.

System_CAPS_pubmethodEquals(Object)

La compara con otro objeto para ver si son equivalentes.(Invalida MemberDescriptor.Equals(Object)).

System_CAPS_protmethodFillAttributes(IList)

Agrega los atributos de la PropertyDescriptor a la lista de atributos de la clase principal especificada.(Invalida MemberDescriptor.FillAttributes(IList)).

System_CAPS_protmethodFinalize()

Permite que un objeto intente liberar recursos y realizar otras operaciones de limpieza antes de ser reclamado por el recolector de basura. (Heredado de Object).

System_CAPS_pubmethodGetChildProperties()

Devuelve el valor predeterminado PropertyDescriptorCollection.

System_CAPS_pubmethodGetChildProperties(Attribute())

Devuelve una PropertyDescriptorCollection con una matriz de atributos especificada como filtro.

System_CAPS_pubmethodGetChildProperties(Object)

Devuelve un PropertyDescriptorCollection para un objeto determinado.

System_CAPS_pubmethodGetChildProperties(Object, Attribute())

Devuelve un PropertyDescriptorCollection para un objeto determinado mediante una matriz de atributos especificada como filtro.

System_CAPS_pubmethodGetEditor(Type)

Obtiene un editor del tipo especificado.

System_CAPS_pubmethodGetHashCode()

Devuelve el código hash de este objeto.(Invalida MemberDescriptor.GetHashCode()).

System_CAPS_protmethodGetInvocationTarget(Type, Object)

Este método devuelve el objeto que se debe utilizar durante la invocación de miembros.(Invalida MemberDescriptor.GetInvocationTarget(Type, Object)).

System_CAPS_pubmethodGetType()

Obtiene el Type de la instancia actual.(Heredado de Object).

System_CAPS_protmethodGetTypeFromName(String)

Devuelve un tipo mediante su nombre.

System_CAPS_pubmethodGetValue(Object)

Cuando se invalida en una clase derivada, obtiene el valor actual de la propiedad en un componente.

System_CAPS_protmethodGetValueChangedHandler(Object)

Recupera el conjunto actual de ValueChanged controladores de eventos para un componente específico

System_CAPS_protmethodMemberwiseClone()

Crea una copia superficial del Object actual.(Heredado de Object).

System_CAPS_protmethodOnValueChanged(Object, EventArgs)

Genera el ValueChanged eventos que se ha implementado.

System_CAPS_pubmethodRemoveValueChanged(Object, EventHandler)

Permite a otros objetos que se le notifique cuando cambia esta propiedad.

System_CAPS_pubmethodResetValue(Object)

Cuando se invalida en una clase derivada, restablece el valor de esta propiedad del componente en el valor predeterminado.

System_CAPS_pubmethodSetValue(Object, Object)

Cuando se invalida en una clase derivada, Establece el valor del componente en un valor diferente.

System_CAPS_pubmethodShouldSerializeValue(Object)

Cuando se invalida en una clase derivada, determina un valor que indica si el valor de esta propiedad debe conservarse.

System_CAPS_pubmethodToString()

Devuelve una cadena que representa al objeto actual. (Heredado de Object).

A description of a property consists of a name, its attributes, the component class that the property is associated with, and the type of the property.

PropertyDescriptor provides the following properties and methods:

PropertyDescriptor also provides the following abstract properties and methods:

  • ComponentType contains the type of component this property is bound to.

  • IsReadOnly indicates whether this property is read-only.

  • PropertyType gets the type of the property.

  • CanResetValue indicates whether resetting the component changes the value of the component.

  • GetValue returns the current value of the property on a component.

  • ResetValue resets the value for this property of the component.

  • SetValue sets the value of the component to a different value.

  • ShouldSerializeValue indicates whether the value of this property needs to be persisted.

Typically, the abstract members are implemented through reflection. For more information about reflection, see the topics in Reflection.

The following code example is built upon the example in the T:System.ComponentModel.PropertyDescriptorCollection class. It prints the information (category, description, display name) of the text of a button in a text box. It assumes that button1 and textbox1 have been instantiated on a form.

' 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

The following code example shows how to implement a custom property descriptor that provides a read-only wrapper around a property. The SerializeReadOnlyPropertyDescriptor is used in a custom designer to provide a read-only property descriptor for the control's P:System.Windows.Forms.Control.Size property.

Imports System
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
                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

The following code examples show how to use the The SerializeReadOnlyPropertyDescriptor in a custom designer.

Imports System
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
Imports System
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

.NET Framework
Disponible desde 1.1
Silverlight
Disponible desde 2.0
Windows Phone Silverlight
Disponible desde 7.0

Cualquier miembro ( Compartido en Visual Basic) estático público de este tipo es seguro para subprocesos. No se garantiza que los miembros de instancia sean seguros para subprocesos.

Volver al principio
Mostrar: