TypeDescriptor::GetComponentName Method (Object^, Boolean)

.NET Framework (current version)

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

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

Syntax

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.

Exceptions

Exception	Condition
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.

Version Information

.NET Framework
Available since 1.1