PropertyDescriptor Klasse
Definition
Stellt eine Abstraktion einer Eigenschaft für eine Klasse bereit.Provides an abstraction of a property on a class.
public ref class PropertyDescriptor abstract : System::ComponentModel::MemberDescriptor
[System.Runtime.InteropServices.ComVisible(true)]
public abstract class PropertyDescriptor : System.ComponentModel.MemberDescriptor
type PropertyDescriptor = class
inherit MemberDescriptor
Public MustInherit Class PropertyDescriptor
Inherits MemberDescriptor
- Vererbung
- Abgeleitet
- Attribute
Beispiele
Das folgende Codebeispiel basiert auf dem Beispiel in der PropertyDescriptorCollection-Klasse.The following code example is built upon the example in the PropertyDescriptorCollection class. Sie druckt die Informationen (Kategorie, Beschreibung, Anzeige Name) des Texts einer Schaltfläche in einem Textfeld.It prints the information (category, description, display name) of the text of a button in a text box. Dabei wird davon ausgegangen, dass button1
und textbox1
in einem Formular instanziiert wurden.It assumes that button1
and textbox1
have been instantiated on a form.
// 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
Im folgenden Codebeispiel wird gezeigt, wie Sie einen benutzerdefinierten Eigenschaften Deskriptor implementieren, der einen schreibgeschützten Wrapper um eine Eigenschaft bereitstellt.The following code example shows how to implement a custom property descriptor that provides a read-only wrapper around a property. Der SerializeReadOnlyPropertyDescriptor
wird in einem benutzerdefinierten Designer verwendet, um einen schreibgeschützten Eigenschaften Deskriptor für die Size-Eigenschaft des Steuer Elements bereitzustellen.The SerializeReadOnlyPropertyDescriptor
is used in a custom designer to provide a read-only property descriptor for the control's Size property.
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
In den folgenden Codebeispielen wird gezeigt, wie die SerializeReadOnlyPropertyDescriptor
in einem benutzerdefinierten Designer verwendet wird.The following code examples show how to use the SerializeReadOnlyPropertyDescriptor
in a custom designer.
using System;
using System.Collections;
using System.ComponentModel;
using System.Text;
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;
using System.ComponentModel;
using System.ComponentModel.Design;
using System.Text;
using System.Windows.Forms;
using System.Windows.Forms.Design;
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
Hinweise
Eine Beschreibung einer Eigenschaft besteht aus einem Namen, den Attributen, der Komponenten Klasse, der die Eigenschaft zugeordnet ist, und dem Typ der Eigenschaft.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 stellt die folgenden Eigenschaften und Methoden bereit:PropertyDescriptor provides the following properties and methods:
Converter enthält den TypeConverter für diese Eigenschaft.Converter contains the TypeConverter for this property.
IsLocalizable gibt an, ob diese Eigenschaft lokalisiert werden soll.IsLocalizable indicates whether this property should be localized.
GetEditor gibt einen Editor des angegebenen Typs zurück.GetEditor returns an editor of the specified type.
PropertyDescriptor bietet auch die folgenden abstract
-Eigenschaften und-Methoden:PropertyDescriptor also provides the following abstract
properties and methods:
ComponentType enthält den Typ der Komponente, an die diese Eigenschaft gebunden ist.ComponentType contains the type of component this property is bound to.
IsReadOnly gibt an, ob diese Eigenschaft schreibgeschützt ist.IsReadOnly indicates whether this property is read-only.
PropertyType Ruft den Typ der Eigenschaft ab.PropertyType gets the type of the property.
CanResetValue gibt an, ob der Wert der Komponente durch Zurücksetzen der Komponente geändert wird.CanResetValue indicates whether resetting the component changes the value of the component.
GetValue gibt den aktuellen Wert der-Eigenschaft für eine Komponente zurück.GetValue returns the current value of the property on a component.
ResetValue setzt den Wert für diese Eigenschaft der Komponente zurück.ResetValue resets the value for this property of the component.
SetValue legt den Wert der Komponente auf einen anderen Wert fest.SetValue sets the value of the component to a different value.
ShouldSerializeValue gibt an, ob der Wert dieser Eigenschaft beibehalten werden muss.ShouldSerializeValue indicates whether the value of this property needs to be persisted.
In der Regel werden die abstract
-Member durch Reflektion implementiert.Typically, the abstract
members are implemented through reflection. Weitere Informationen zur Reflektion finden Sie in den Themen unter Reflektion.For more information about reflection, see the topics in Reflection.
Konstruktoren
PropertyDescriptor(MemberDescriptor) |
Initialisiert eine neue Instanz der PropertyDescriptor-Klasse mit dem Namen und den Attributen im angegebenen MemberDescriptor.Initializes a new instance of the PropertyDescriptor class with the name and attributes in the specified MemberDescriptor. |
PropertyDescriptor(MemberDescriptor, Attribute[]) |
Initialisiert eine neue Instanz der PropertyDescriptor-Klasse mit dem Namen im angegebenen MemberDescriptor und den Attributen im MemberDescriptor sowie dem Attribute-Array.Initializes a new instance of the PropertyDescriptor class with the name in the specified MemberDescriptor and the attributes in both the MemberDescriptor and the Attribute array. |
PropertyDescriptor(String, Attribute[]) |
Initialisiert eine neue Instanz der PropertyDescriptor-Klasse mit dem angegebenen Namen und den angegebenen Attributen.Initializes a new instance of the PropertyDescriptor class with the specified name and attributes. |
Eigenschaften
AttributeArray |
Ruft ein Array von Attributen ab oder legt dieses fest.Gets or sets an array of attributes. (Geerbt von MemberDescriptor) |
Attributes |
Ruft die Auflistung von Attributen für diesen Member ab.Gets the collection of attributes for this member. (Geerbt von MemberDescriptor) |
Category |
Ruft den Namen der Kategorie ab, zu der der Member gehört. Dieser ist in der CategoryAttribute-Klasse angegeben.Gets the name of the category to which the member belongs, as specified in the CategoryAttribute. (Geerbt von MemberDescriptor) |
ComponentType |
Ruft beim Überschreiben in einer abgeleiteten Klasse den Typ der Komponente ab, an die diese Eigenschaft gebunden ist.When overridden in a derived class, gets the type of the component this property is bound to. |
Converter |
Ruft den Typkonverter für diese Eigenschaft ab.Gets the type converter for this property. |
Description |
Ruft die Beschreibung des Members ab, die in der DescriptionAttribute-Klasse angegeben ist.Gets the description of the member, as specified in the DescriptionAttribute. (Geerbt von MemberDescriptor) |
DesignTimeOnly |
Ruft ab, ob dieser Member nur zur Entwurfszeit festgelegt werden darf. Dies ist in der DesignOnlyAttribute-Klasse angegeben.Gets whether this member should be set only at design time, as specified in the DesignOnlyAttribute. (Geerbt von MemberDescriptor) |
DisplayName |
Ruft den Namen ab, der in einem Fenster, z. B. im Eigenschaftenfenster, angezeigt werden kann.Gets the name that can be displayed in a window, such as a Properties window. (Geerbt von MemberDescriptor) |
IsBrowsable |
Ruft einen Wert ab, der angibt, ob der Member durchsucht werden kann. Dies ist in der BrowsableAttribute-Klasse angegeben.Gets a value indicating whether the member is browsable, as specified in the BrowsableAttribute. (Geerbt von MemberDescriptor) |
IsLocalizable |
Ruft einen Wert ab, der angibt, ob diese Eigenschaft gemäß den Angaben in LocalizableAttribute lokalisiert werden soll.Gets a value indicating whether this property should be localized, as specified in the LocalizableAttribute. |
IsReadOnly |
Ruft beim Überschreiben in einer abgeleiteten Klasse einen Wert ab, der angibt, ob diese Eigenschaft schreibgeschützt ist.When overridden in a derived class, gets a value indicating whether this property is read-only. |
Name |
Ruft den Namen des Members ab.Gets the name of the member. (Geerbt von MemberDescriptor) |
NameHashCode |
Ruft den Hashcode für den Namen des Members ab, der in GetHashCode() angegeben ist.Gets the hash code for the name of the member, as specified in GetHashCode(). (Geerbt von MemberDescriptor) |
PropertyType |
Ruft beim Überschreiben in einer abgeleiteten Klasse den Typ der Eigenschaft ab.When overridden in a derived class, gets the type of the property. |
SerializationVisibility |
Ruft einen Wert ab, der angibt, ob diese Eigenschaft gemäß den Angaben in DesignerSerializationVisibilityAttribute serialisiert werden soll.Gets a value indicating whether this property should be serialized, as specified in the DesignerSerializationVisibilityAttribute. |
SupportsChangeEvents |
Ruft einen Wert ab, der angibt, ob Wertänderungsbenachrichtigungen für diese Eigenschaft von außerhalb des Eigenschaftendeskriptors stammen dürfen.Gets a value indicating whether value change notifications for this property may originate from outside the property descriptor. |
Methoden
AddValueChanged(Object, EventHandler) |
Ermöglicht es, andere Objekte zu benachrichtigen, wenn sich diese Eigenschaft ändert.Enables other objects to be notified when this property changes. |
CanResetValue(Object) |
Gibt beim Überschreiben in einer abgeleiteten Klasse zurück, ob beim Zurücksetzen eines Objekts dessen Wert geändert wird.When overridden in a derived class, returns whether resetting an object changes its value. |
CreateAttributeCollection() |
Erstellt eine Auflistung von Attributen, wobei das Array von Attributen verwendet wird, das an den Konstruktor übergeben wurde.Creates a collection of attributes using the array of attributes passed to the constructor. (Geerbt von MemberDescriptor) |
CreateInstance(Type) |
Erstellt eine Instanz des angegebenen Typs.Creates an instance of the specified type. |
Equals(Object) |
Vergleicht dieses Objekt mit einem anderen auf Äquivalenz.Compares this to another object to see if they are equivalent. |
FillAttributes(IList) |
Fügt der angegebenen Liste der Attribute in der übergeordneten Klasse die Attribute der PropertyDescriptor-Klasse hinzu.Adds the attributes of the PropertyDescriptor to the specified list of attributes in the parent class. |
GetChildProperties() |
Gibt die als Standard festgelegte PropertyDescriptorCollection-Klasse zurück.Returns the default PropertyDescriptorCollection. |
GetChildProperties(Attribute[]) |
Gibt eine PropertyDescriptorCollection-Klasse unter Verwendung eines angegebenen Arrays von Attributen als Filter zurück.Returns a PropertyDescriptorCollection using a specified array of attributes as a filter. |
GetChildProperties(Object) |
Gibt eine PropertyDescriptorCollection-Klasse für ein angegebenes Objekt zurück.Returns a PropertyDescriptorCollection for a given object. |
GetChildProperties(Object, Attribute[]) |
Gibt eine PropertyDescriptorCollection-Klasse für ein angegebenes Objekt zurück, wobei ein angegebenes Array von Attributen als Filter verwendet wird.Returns a PropertyDescriptorCollection for a given object using a specified array of attributes as a filter. |
GetEditor(Type) |
Ruft einen Editor des angegebenen Typs ab.Gets an editor of the specified type. |
GetHashCode() |
Gibt den Hashcode für dieses Objekt zurück.Returns the hash code for this object. |
GetInvocationTarget(Type, Object) |
Diese Methode gibt das Objekt zurück, das beim Aufrufen der Member verwendet werden sollte.This method returns the object that should be used during invocation of members. |
GetType() |
Ruft den Type der aktuellen Instanz ab.Gets the Type of the current instance. (Geerbt von Object) |
GetTypeFromName(String) |
Gibt einen Typ unter Verwendung seines Namens zurück.Returns a type using its name. |
GetValue(Object) |
Ruft beim Überschreiben in einer abgeleiteten Klasse den aktuellen Wert der Eigenschaft einer Komponente ab.When overridden in a derived class, gets the current value of the property on a component. |
GetValueChangedHandler(Object) |
Ruft die aktuellen |
MemberwiseClone() |
Erstellt eine flache Kopie des aktuellen Object.Creates a shallow copy of the current Object. (Geerbt von Object) |
OnValueChanged(Object, EventArgs) |
Löst das |
RemoveValueChanged(Object, EventHandler) |
Ermöglicht es, andere Objekte zu benachrichtigen, wenn sich diese Eigenschaft ändert.Enables other objects to be notified when this property changes. |
ResetValue(Object) |
Setzt beim Überschreiben in einer abgeleiteten Klasse den Wert dieser Komponenteneigenschaft auf den Standardwert zurück.When overridden in a derived class, resets the value for this property of the component to the default value. |
SetValue(Object, Object) |
Legt beim Überschreiben in einer abgeleiteten Klasse den Wert der Komponente auf einen anderen Wert fest.When overridden in a derived class, sets the value of the component to a different value. |
ShouldSerializeValue(Object) |
Bestimmt beim Überschreiben in einer abgeleiteten Klasse einen Wert, der angibt, ob der Wert dieser Eigenschaft beibehalten werden muss.When overridden in a derived class, determines a value indicating whether the value of this property needs to be persisted. |
ToString() |
Gibt eine Zeichenfolge zurück, die das aktuelle Objekt darstellt.Returns a string that represents the current object. (Geerbt von Object) |