This documentation is archived and is not being maintained.

TypeDescriptor.GetComponentName Method (Object, Boolean)

Returns the name of the specified component using a custom type descriptor.

Namespace:  System.ComponentModel
Assembly:  System (in System.dll)

public static string GetComponentName(
	Object component,
	bool noCustomTypeDesc
)

Parameters

component
Type: System.Object
The Object for which you want the class name.
noCustomTypeDesc
Type: System.Boolean
true to consider custom type description information; otherwise, false.

Return Value

Type: System.String
The name of the class for the specified component, or null if there is no component name.

ExceptionCondition
ArgumentNullException

component is null.

NotSupportedException

component is a cross-process remoted object.

This method is used at design time to retrieve the name of an instance of a component. Typically, this method returns the name for the site of the component, if one exists. For example, the class name for a button is "System.Windows.Forms.Button". If the component implements the ICustomTypeDescriptor interface, it can return an alternate name.

.NET Framework

Supported in: 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

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.
Show: