.NET Framework Class Library
EditorAttribute Class

Specifies the editor to use to change a property. This class cannot be inherited.

Inheritance Hierarchy
SystemObject
   SystemAttribute
    System.ComponentModelEditorAttribute

Namespace:   System.ComponentModel
Assembly:  System (in System.dll)
Syntax
<[%$TOPIC/326b18eb_en-us_VS_110_2_0_0_0_0%]([%$TOPIC/326b18eb_en-us_VS_110_2_0_0_0_1%].All, AllowMultiple := True, Inherited := True)> _
Public NotInheritable Class EditorAttribute _
	Inherits [%$TOPIC/326b18eb_en-us_VS_110_2_0_0_0_2%]
[[%$TOPIC/326b18eb_en-us_VS_110_2_0_1_0_0%]([%$TOPIC/326b18eb_en-us_VS_110_2_0_1_0_1%].All, AllowMultiple = true, Inherited = true)]
public sealed class EditorAttribute : [%$TOPIC/326b18eb_en-us_VS_110_2_0_1_0_2%]
[[%$TOPIC/326b18eb_en-us_VS_110_2_0_2_0_0%]([%$TOPIC/326b18eb_en-us_VS_110_2_0_2_0_1%]::All, AllowMultiple = true, Inherited = true)]
public ref class EditorAttribute sealed : public [%$TOPIC/326b18eb_en-us_VS_110_2_0_2_0_2%]
[<[%$TOPIC/326b18eb_en-us_VS_110_2_0_3_0_0%]>]
[<[%$TOPIC/326b18eb_en-us_VS_110_2_0_3_0_1%]([%$TOPIC/326b18eb_en-us_VS_110_2_0_3_0_2%].All, AllowMultiple = true, Inherited = true)>]
type EditorAttribute =  
    class 
        inherit [%$TOPIC/326b18eb_en-us_VS_110_2_0_3_0_3%] 
    end

The EditorAttribute type exposes the following members.

Constructors
  NameDescription
Public method EditorAttributeInitializes a new instance of the EditorAttribute class with the default editor, which is no editor.
Public method EditorAttribute(String, String)Initializes a new instance of the EditorAttribute class with the type name and base type name of the editor.
Public method EditorAttribute(String, Type)Initializes a new instance of the EditorAttribute class with the type name and the base type.
Public method EditorAttribute(Type, Type)Initializes a new instance of the EditorAttribute class with the type and the base type.
Top
Properties
  NameDescription
Public property EditorBaseTypeNameGets the name of the base class or interface serving as a lookup key for this editor.
Public property EditorTypeNameGets the name of the editor class in the TypeAssemblyQualifiedName format.
Public property TypeIdGets a unique ID for this attribute type. (Overrides AttributeTypeId.)
Top
Methods
  NameDescription
Public method EqualsReturns whether the value of the given object is equal to the current EditorAttribute. (Overrides AttributeEquals(Object).)
Public method GetHashCodeReturns the hash code for this instance. (Overrides AttributeGetHashCode.)
Public method GetTypeGets the Type of the current instance. (Inherited from Object.)
Public method IsDefaultAttributeWhen 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 MatchWhen overridden in a derived class, returns a value that indicates whether this instance equals a specified object. (Inherited from Attribute.)
Public method ToStringReturns a string that represents the current object. (Inherited from Object.)
Top
Explicit Interface Implementations
  NameDescription
Explicit interface implemetation Private method _AttributeGetIDsOfNamesMaps a set of names to a corresponding set of dispatch identifiers. (Inherited from Attribute.)
Explicit interface implemetation Private method _AttributeGetTypeInfoRetrieves 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 _AttributeGetTypeInfoCountRetrieves the number of type information interfaces that an object provides (either 0 or 1). (Inherited from Attribute.)
Explicit interface implemetation Private method _AttributeInvokeProvides access to properties and methods exposed by an object. (Inherited from Attribute.)
Top
Remarks

When editing the property, a visual designer should create a new instance of the specified editor through a dialog box or drop-down window.

Use the EditorBaseTypeName property to find this editor's base type. The only available base type is UITypeEditor.

Use the EditorTypeName property to get the name of the type of editor associated with this attribute.

For general information on using attributes. see Extending Metadata Using Attributes. For more information on design-time attributes, see Attributes and Design-Time Support.

Examples

The following code example creates the MyImage class. The class is marked with an EditorAttribute that specifies the ImageEditor as its editor.

<Editor("System.Windows.Forms.ImageEditorIndex, System.Design", _
    GetType(UITypeEditor))> _
Public Class MyImage
    ' Insert code here. 
End Class 'MyImage
[Editor("System.Windows.Forms.ImageEditorIndex, System.Design", 
    typeof(UITypeEditor))]

public class MyImage
{
    // Insert code here.
 }
[Editor("System.Windows.Forms.ImageEditorIndex, System.Design",
UITypeEditor::typeid)]
public ref class MyImage{
   // Insert code here.
};

The following code example creates an instance of the MyImage class, gets the attributes for the class, and then prints the name of the editor used by myNewImage.

Public Shared Sub Main()
    ' Creates a new component. 
    Dim myNewImage As New MyImage()

    ' Gets the attributes for the component. 
    Dim attributes As AttributeCollection = TypeDescriptor.GetAttributes(myNewImage)

    ' Prints the name of the editor by retrieving the EditorAttribute 
    ' from the AttributeCollection.  

    Dim myAttribute As EditorAttribute = CType(attributes(GetType(EditorAttribute)), EditorAttribute)
    Console.WriteLine(("The editor for this class is: " & myAttribute.EditorTypeName))

End Sub 'Main
public static int Main() {
    // Creates a new component.
    MyImage myNewImage = new MyImage();

    // Gets the attributes for the component.
    AttributeCollection attributes = TypeDescriptor.GetAttributes(myNewImage);

    /* Prints the name of the editor by retrieving the EditorAttribute 
     * from the AttributeCollection. */

    EditorAttribute myAttribute = (EditorAttribute)attributes[typeof(EditorAttribute)];
    Console.WriteLine("The editor for this class is: " + myAttribute.EditorTypeName);

    return 0;
 }
int main()
{
   // Creates a new component.
   MyImage^ myNewImage = gcnew MyImage;

   // Gets the attributes for the component.
   AttributeCollection^ attributes = TypeDescriptor::GetAttributes( myNewImage );

   /* Prints the name of the editor by retrieving the EditorAttribute 
       * from the AttributeCollection. */
   EditorAttribute^ myAttribute = dynamic_cast<EditorAttribute^>(attributes[ EditorAttribute::typeid ]);
   Console::WriteLine( "The editor for this class is: {0}", myAttribute->EditorTypeName );
   return 0;
}
Version Information

.NET Framework

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

.NET Framework Client Profile

Supported in: 4, 3.5 SP1
Platforms

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), 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.