PropertyDescriptor Klasse
Definition
Wichtig
Einige Informationen beziehen sich auf Vorabversionen, die vor dem Release ggf. grundlegend überarbeitet werden. Microsoft übernimmt hinsichtlich der hier bereitgestellten Informationen keine Gewährleistungen, seien sie ausdrücklich oder konkludent.
Stellt eine Abstraktion einer Eigenschaft für eine Klasse bereit.
public ref class PropertyDescriptor abstract : System::ComponentModel::MemberDescriptor
public abstract class PropertyDescriptor : System.ComponentModel.MemberDescriptor
[System.Runtime.InteropServices.ComVisible(true)]
public abstract class PropertyDescriptor : System.ComponentModel.MemberDescriptor
type PropertyDescriptor = class
inherit MemberDescriptor
[<System.Runtime.InteropServices.ComVisible(true)>]
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. Sie druckt die Informationen (Kategorie, Beschreibung, Anzeigename) des Texts einer Schaltfläche in einem Textfeld. Es wird davon ausgegangen, dass button1
und textbox1
auf einem Formular instanziiert wurden.
// 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
Das folgende Codebeispiel zeigt, wie Sie einen benutzerdefinierten Eigenschaftsdeskriptor implementieren, der einen schreibgeschützten Wrapper um eine Eigenschaft bereitstellt. Die SerializeReadOnlyPropertyDescriptor
wird in einem benutzerdefinierten Designer verwendet, um einen schreibgeschützten Eigenschaftendeskriptor für die Size-Eigenschaft des Steuerelements bereitzustellen.
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
Die folgenden Codebeispiele zeigen, wie Sie die SerializeReadOnlyPropertyDescriptor
in einem benutzerdefinierten Designer verwenden.
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
Hinweise
Eine Beschreibung einer Eigenschaft besteht aus einem Namen, seinen Attributen, der Komponentenklasse, der die Eigenschaft zugeordnet ist, und dem Typ der Eigenschaft.
PropertyDescriptor stellt die folgenden Eigenschaften und Methoden bereit:
Converter enthält die TypeConverter für diese Eigenschaft.
IsLocalizable gibt an, ob diese Eigenschaft lokalisiert werden soll.
GetEditor gibt einen Editor des angegebenen Typs zurück.
PropertyDescriptor stellt außerdem die folgenden abstract
Eigenschaften und Methoden bereit:
ComponentType enthält den Typ der Komponente, an die diese Eigenschaft gebunden ist.
IsReadOnly gibt an, ob diese Eigenschaft schreibgeschützt ist.
PropertyType ruft den Typ der Eigenschaft ab.
CanResetValue gibt an, ob das Zurücksetzen der Komponente den Wert der Komponente ändert.
GetValue gibt den aktuellen Wert der Eigenschaft für eine Komponente zurück.
ResetValue setzt den Wert für diese Eigenschaft der Komponente zurück.
SetValue legt den Wert der Komponente auf einen anderen Wert fest.
ShouldSerializeValue gibt an, ob der Wert dieser Eigenschaft beibehalten werden muss.
In der Regel werden die abstract
Mitglieder durch Reflexion implementiert. Weitere Informationen zur Reflexion finden Sie in den Themen in Reflection.
Konstruktoren
PropertyDescriptor(MemberDescriptor) |
Initialisiert eine neue Instanz der PropertyDescriptor Klasse mit dem Namen und den Attributen in der angegebenen MemberDescriptor. |
PropertyDescriptor(MemberDescriptor, Attribute[]) |
Initialisiert eine neue Instanz der PropertyDescriptor Klasse mit dem Namen in der angegebenen MemberDescriptor und den Attributen sowohl im MemberDescriptor als auch im Attribute Array. |
PropertyDescriptor(String, Attribute[]) |
Initialisiert eine neue Instanz der PropertyDescriptor Klasse mit dem angegebenen Namen und den angegebenen Attributen. |
Eigenschaften
AttributeArray |
Dient zum Abrufen oder Festlegen eines Arrays von Attributen. (Geerbt von MemberDescriptor) |
Attributes |
Ruft die Auflistung der Attribute für dieses Element ab. (Geerbt von MemberDescriptor) |
Category |
Ruft den Namen der Kategorie ab, zu der das Element gehört, wie in der CategoryAttributeangegeben. (Geerbt von MemberDescriptor) |
ComponentType |
Wenn sie in einer abgeleiteten Klasse überschrieben wird, ruft der Typ der Komponente ab, an die diese Eigenschaft gebunden ist. |
Converter |
Ruft den Typkonverter für diese Eigenschaft ab. |
ConverterFromRegisteredType |
Ruft den Typkonverter für diese Eigenschaft ab. |
Description |
Ruft die Beschreibung des Elements ab, wie in der DescriptionAttributeangegeben. (Geerbt von MemberDescriptor) |
DesignTimeOnly |
Ruft ab, ob dieses Element nur zur Entwurfszeit festgelegt werden soll, wie in der DesignOnlyAttributeangegeben. (Geerbt von MemberDescriptor) |
DisplayName |
Ruft den Namen ab, der in einem Fenster angezeigt werden kann, z. B. ein Eigenschaftenfenster. (Geerbt von MemberDescriptor) |
IsBrowsable |
Ruft einen Wert ab, der angibt, ob das Element durchbrochen werden kann, wie in der BrowsableAttributeangegeben. (Geerbt von MemberDescriptor) |
IsLocalizable |
Ruft einen Wert ab, der angibt, ob diese Eigenschaft lokalisiert werden soll, wie in der LocalizableAttributeangegeben. |
IsReadOnly |
Wenn sie in einer abgeleiteten Klasse überschrieben wird, wird ein Wert abgerufen, der angibt, ob diese Eigenschaft schreibgeschützt ist. |
Name |
Ruft den Namen des Elements ab. (Geerbt von MemberDescriptor) |
NameHashCode |
Ruft den Hashcode für den Namen des Elements ab, wie in GetHashCode()angegeben. (Geerbt von MemberDescriptor) |
PropertyType |
Wenn sie in einer abgeleiteten Klasse überschrieben wird, ruft sie den Typ der Eigenschaft ab. |
SerializationVisibility |
Ruft einen Wert ab, der angibt, ob diese Eigenschaft serialisiert werden soll, wie in der DesignerSerializationVisibilityAttributeangegeben. |
SupportsChangeEvents |
Ruft einen Wert ab, der angibt, ob Wertänderungsbenachrichtigungen für diese Eigenschaft von außerhalb des Eigenschaftendeskriptors stammen können. |
Methoden
AddValueChanged(Object, EventHandler) |
Ermöglicht es anderen Objekten, benachrichtigt zu werden, wenn sich diese Eigenschaft ändert. |
CanResetValue(Object) |
Wenn eine abgeleitete Klasse außer Kraft gesetzt wird, wird zurückgegeben, ob das Zurücksetzen eines Objekts seinen Wert ändert. |
CreateAttributeCollection() |
Erstellt eine Auflistung von Attributen mithilfe des Arrays von Attributen, die an den Konstruktor übergeben werden. (Geerbt von MemberDescriptor) |
CreateInstance(Type) |
Erstellt eine Instanz des angegebenen Typs. |
Equals(Object) |
Vergleicht dies mit einem anderen Objekt, um festzustellen, ob sie gleichwertig sind. |
FillAttributes(IList) |
Fügt die Attribute des PropertyDescriptor der angegebenen Liste der Attribute in der übergeordneten Klasse hinzu. |
FillAttributes(IList) |
Wenn sie in einer abgeleiteten Klasse überschrieben wird, werden der angegebenen Liste der Attribute in der übergeordneten Klasse die Attribute der geerbten Klasse hinzugefügt. (Geerbt von MemberDescriptor) |
GetChildProperties() |
Gibt den Standard-PropertyDescriptorCollectionzurück. |
GetChildProperties(Attribute[]) |
Gibt einen PropertyDescriptorCollection zurück, der ein angegebenes Array von Attributen als Filter verwendet. |
GetChildProperties(Object) |
Gibt einen PropertyDescriptorCollection für ein bestimmtes Objekt zurück. |
GetChildProperties(Object, Attribute[]) |
Gibt eine PropertyDescriptorCollection für ein bestimmtes Objekt zurück, wobei ein angegebenes Array von Attributen als Filter verwendet wird. |
GetEditor(Type) |
Ruft einen Editor des angegebenen Typs ab. |
GetHashCode() |
Gibt den Hashcode für dieses Objekt zurück. |
GetInvocationTarget(Type, Object) |
Diese Methode gibt das Objekt zurück, das beim Aufrufen von Elementen verwendet werden soll. |
GetInvocationTarget(Type, Object) |
Ruft das Objekt ab, das während des Aufrufs von Elementen verwendet werden soll. (Geerbt von MemberDescriptor) |
GetType() |
Ruft die Type der aktuellen Instanz ab. (Geerbt von Object) |
GetTypeFromName(String) |
Gibt einen Typ zurück, der seinen Namen verwendet. |
GetValue(Object) |
Wenn sie in einer abgeleiteten Klasse überschrieben wird, wird der aktuelle Wert der Eigenschaft für eine Komponente abgerufen. |
GetValueChangedHandler(Object) |
Ruft den aktuellen Satz von |
MemberwiseClone() |
Erstellt eine flache Kopie der aktuellen Object. (Geerbt von Object) |
OnValueChanged(Object, EventArgs) |
Löst das |
RemoveValueChanged(Object, EventHandler) |
Ermöglicht es anderen Objekten, benachrichtigt zu werden, wenn sich diese Eigenschaft ändert. |
ResetValue(Object) |
Wenn sie in einer abgeleiteten Klasse außer Kraft gesetzt wird, wird der Wert für diese Eigenschaft der Komponente auf den Standardwert zurückgesetzt. |
SetValue(Object, Object) |
Wenn sie in einer abgeleiteten Klasse außer Kraft gesetzt wird, wird der Wert der Komponente auf einen anderen Wert festgelegt. |
ShouldSerializeValue(Object) |
Wenn sie in einer abgeleiteten Klasse überschrieben wird, wird ein Wert bestimmt, der angibt, ob der Wert dieser Eigenschaft beibehalten werden muss. |
ToString() |
Gibt eine Zeichenfolge zurück, die das aktuelle Objekt darstellt. (Geerbt von Object) |
Gilt für:
Weitere Informationen
Feedback
https://aka.ms/ContentUserFeedback.
Bald verfügbar: Im Laufe des Jahres 2024 werden wir GitHub-Issues stufenweise als Feedbackmechanismus für Inhalte abbauen und durch ein neues Feedbacksystem ersetzen. Weitere Informationen finden Sie unterFeedback senden und anzeigen für