Como: Fornecer descrições de metadados sobre o componente

Você pode fornecer metadados descritivos sobre seu componente por meio de attributes. Os atributos são classes especializadas que são aplicadas a elementos de código.No momento da compilar, os atributos são emitidos em metadados que estão disponível para o Common linguagem tempo de execução ou ferramentas personalizadas e aplicativos por meio de System.Reflection espaço para nome.

Atributos são conectados a um componente precedendo o componente com uma referência para o atributo e fornecendo quaisquer parâmetros relevantes ou sinalizadores.Esta telefonar para o construtor é colocada dentro de colchetes angulares <>no Visual Basic e regular colchetes [] em translation from VPE for Csharp.

Por convenção, todas as classes de atributo terminam em "Atributo". Por exemplo, existem DescriptionAttribute, ObsoleteAttribute, e BrowsableAttribute classes. No entanto, vários idiomas que destino common linguagem tempo de execução, incluindo Visual Basic e translation from VPE for Csharp, não exigem o nome completo do atributo.Por exemplo, a ObsoleteAttribute pode ser chamado no código de exemplo Obsolete.

Para anexar um atributo existente ao seu componente

1. Determine quais atributos são necessários para seu componente.

2. Anexe os atributos para seu componente.Observe que você deve usar o nome totalmente qualificado do atributo ou adicionar a apropriado Imports (using) demonstrativo. O exemplo a seguir mostra como anexar o DescriptionAttribute atributo:

   Imports System.ComponentModel
   <Description("This is a description string")> Public Class TheClass
   End Class
   

   using System.ComponentModel;
   [Description("This is a description string")]
   public class TheClass
   {
   }
   

Atributos personalizados

Você também pode criar seus próprios atributos para uso com suas próprias ferramentas personalizadas ou aplicativos herdam Attribute. Você pode adicionar a essa classe base quaisquer propriedades personalizadas ou métodos necessários para seu aplicativo.

Para criar e aplicar um atributo personalizado

1. Criar uma classe que herda de Attribute.

   Public Class WidgetAttribute
      Inherits System.Attribute
   End Class
   

   public class WidgetAttribute: System.Attribute
   {
   }
   

2. Determinar quais propriedades e métodos seu atributo precisa e escrever o código para eles.O exemplo a seguir mostra como criar um WidgetType propriedade que é conjunto no construtor das WidgetAttribute classe. TheAttributeUsageAttribute attribute sets what code members the attribute can target.

   <AttributeUsage(System.AttributeTargets.Class)> Public Class _
      WidgetAttribute
      Inherits System.Attribute
      Private mWidgetType as WidgetTypeEnum
      ' Creates a readonly property for the WidgetAttribute class.
      Public ReadOnly Property WidgetType as WidgetTypeEnum
         Get
            Return mWidgetType
         End Get
      End Property
      ' Creates a constructor that accepts a parameter and assigns the 
      ' value of that parameter to the WidgetType property.
      Public Sub New(type as WidgetTypeEnum)
         MyBase.New()
         mWidgetType = type
      End Sub
   End Class
   

   [AttributeUsage(System.AttributeTargets.Class)]
   public class WidgetAttribute: System.Attribute
   {
      private WidgetTypeEnum widgetType;
   
      // Creates a readonly property for the WidgetAttribute class.
      public WidgetTypeEnum WidgetType
         {
            get {return widgetType;}
         }
   
      public WidgetAttribute(WidgetTypeEnum type): base()
         {
            widgetType = type;
         }
   }
   

3. Aplica esse atributo sistema autônomo faria com qualquer Outros atributo, que estão sendo determinados aplicar sistema autônomo parâmetros necessários.

   <WidgetAttribute(WidgetTypeEnum.VerticalWidget)> _
      Public Class WidgetFortyFive
   End Class
   

   [WidgetAttribute(WidgetTypeEnum.VerticalWidget)]
   public class WidgetFortyFive
   {
   }
   

Consulte também

Tarefas

Como: Fornecer metadados para propriedades do componente, métodos e eventos

Conceitos

Ao acessar atributos Personalizars

Recuperando Informações Armazenadas em Atributos

Referência

Attribute

Outros recursos

Assistência do usuário para os componentes