TypeDescriptionProviderAttribute Class (System.ComponentModel)

Switch View :
Classic
Lightweight
ScriptFree
.NET Framework Class Library
TypeDescriptionProviderAttribute Class

[This documentation is for preview only, and is subject to change in later releases. Blank topics are included as placeholders.]

Specifies the custom type description provider for a class. This class cannot be inherited.

Inheritance Hierarchy
System.Object
  System.Attribute
    System.ComponentModel.TypeDescriptionProviderAttribute

Namespace:  System.ComponentModel
Assembly:  System (in System.dll)
Syntax
Visual Basic
<AttributeUsageAttribute(AttributeTargets.Class, Inherited := True)> _
Public NotInheritable Class TypeDescriptionProviderAttribute _
	Inherits Attribute
C#
[AttributeUsageAttribute(AttributeTargets.Class, Inherited = true)]
public sealed class TypeDescriptionProviderAttribute : Attribute
Visual C++
[AttributeUsageAttribute(AttributeTargets::Class, Inherited = true)]
public ref class TypeDescriptionProviderAttribute sealed : public Attribute
F#
[<Sealed>]
[<AttributeUsageAttribute(AttributeTargets.Class, Inherited = true)>]
type TypeDescriptionProviderAttribute =  
    class
        inherit Attribute
    end

The TypeDescriptionProviderAttribute type exposes the following members.

Constructors
  Name Description
Public method TypeDescriptionProviderAttribute(String) Initializes a new instance of the TypeDescriptionProviderAttribute class using the specified type name.
Public method TypeDescriptionProviderAttribute(Type) Initializes a new instance of the TypeDescriptionProviderAttribute class using the specified type.
Top
Properties
  Name Description
Public property TypeId When implemented in a derived class, gets a unique identifier for this Attribute. (Inherited from Attribute.)
Public property TypeName Gets the type name for the type description provider.
Top
Methods
  Name Description
Public method Equals Infrastructure. Returns a value that indicates whether this instance is equal to a specified object. (Inherited from Attribute.)
Protected method Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public method GetHashCode Returns the hash code for this instance. (Inherited from Attribute.)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Public method IsDefaultAttribute When overridden in a derived class, indicates whether the value of this instance is the default value for the derived class. (Inherited from Attribute.)
Public method Match When overridden in a derived class, returns a value that indicates whether this instance equals a specified object. (Inherited from Attribute.)
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Public method ToString Returns a string that represents the current object. (Inherited from Object.)
Top
Explicit Interface Implementations
  Name Description
Explicit interface implemetation Private method _Attribute.GetIDsOfNames Maps a set of names to a corresponding set of dispatch identifiers. (Inherited from Attribute.)
Explicit interface implemetation Private method _Attribute.GetTypeInfo Retrieves the type information for an object, which can be used to get the type information for an interface. (Inherited from Attribute.)
Explicit interface implemetation Private method _Attribute.GetTypeInfoCount Retrieves the number of type information interfaces that an object provides (either 0 or 1). (Inherited from Attribute.)
Explicit interface implemetation Private method _Attribute.Invoke Provides access to properties and methods exposed by an object. (Inherited from Attribute.)
Top
Remarks

This attribute supplies a way for developers to provide custom metadata for their authored classes. This capability extends the static type information functionality in the TypeDescriptor class, which by default only obtains type information directly from metadata of the compiled classes.

Note Note

For a more dynamic way to provide custom metadata for your authored classes, see the AddProvider method.

Tagging a class with a TypeDescriptionProviderAttribute will associate a TypeDescriptionProvider with that class. A TypeDescriptionProvider provides supplemental metadata information about the tagged class. For example, the GetTypeDescriptor method returns an ICustomTypeDescriptor that defines additional type information, such as attributes, events, and properties. Subsequently, if a TypeDescriptionProvider member is used to investigate the tagged class, it will discover both the default and custom type information.

This attribute can only be applied to classes and is inherited by derived classes.

This attribute cannot be derived from.

For more information about using attributes, see Extending Metadata Using Attributes.

Version Information

.NET Framework

Supported in: 4.5, 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1
Platforms

Windows 8 Consumer Preview, Windows Server 8 Beta, Windows 7, Windows Server 2008 SP2, Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Thread Safety
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
See Also

Reference

System.ComponentModel Namespace
TypeDescriptionProvider
AddProvider
ICustomTypeDescriptor