Returns the collection of properties for a specified component.
Assembly: System (in System.dll)
Public Shared Function GetProperties ( _
component As Object _
) As PropertyDescriptorCollectionpublic static PropertyDescriptorCollection GetProperties(
Object component
)public:
static PropertyDescriptorCollection^ GetProperties(
Object^ component
)static member GetProperties :
component:Object -> PropertyDescriptorCollection
Parameters
- component
- Type: System
. . :: . Object
A component to get the properties for.
Return Value
Type: System.ComponentModelA PropertyDescriptorCollection with the properties for the specified component.
| Exception | Condition |
|---|---|
| NotSupportedException | component is a cross-process remoted object. |
The properties for a component can differ from the properties of a class, because the site can add or remove properties if the component is sited.
If the component parameter is
The order of the returned collection is not guaranteed to be identical between calls, so always order it before use.
The following code example demonstrates the use of the GetProperties method to access the properties of a control. This code example is part of a larger example provided for the ComponentDesigner class.
' This is the shadowed property on the designer.
' This value will be serialized instead of the
' value of the control's property.
Public Property BackColor() As Color
Get
Return CType(ShadowProperties("BackColor"), Color)
End Get
Set(ByVal value As Color)
If (Me.changeService IsNot Nothing) Then
Dim backColorDesc As PropertyDescriptor = TypeDescriptor.GetProperties(Me.Control)("BackColor")
Me.changeService.OnComponentChanging(Me.Control, backColorDesc)
Me.ShadowProperties("BackColor") = value
Me.changeService.OnComponentChanged(Me.Control, backColorDesc, Nothing, Nothing)
End If
End Set
End Property
// This is the shadowed property on the designer.
// This value will be serialized instead of the
// value of the control's property.
public Color BackColor
{
get
{
return (Color)ShadowProperties["BackColor"];
}
set
{
if (this.changeService != null)
{
PropertyDescriptor backColorDesc =
TypeDescriptor.GetProperties(this.Control)["BackColor"];
this.changeService.OnComponentChanging(
this.Control,
backColorDesc);
this.ShadowProperties["BackColor"] = value;
this.changeService.OnComponentChanged(
this.Control,
backColorDesc,
null,
null);
}
}
}
Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2
The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.