Atributos de tempo de design para componentes

Se você não estiver familiarizado com a aplicação de atributos fornecem metadados para o common language runtime, consulte Estendendo metadados usando atributos. Porque os componentes podem ser exibidos em um designer, como Visual Studio, eles exigem atributos que fornecem metadados para ferramentas de tempo de design. Esta seção descreve e fornece uma lista de atributos de tempo de design mais usados.

Atributos e suporte de Designer

Atributos de tempo de design são essenciais para exibir o seu controle e seus membros corretamente em tempo de design, enquanto eles fornecem informações valiosas para uma ferramenta de design visual.

No fragmento de código a seguir, o CategoryAttribute atributo permite que o Pesquisador de propriedade exibir a TextAlignment a propriedade na categoria de alinhamento. O DescriptionAttribute atributo permite que o Pesquisador de propriedade fornecer uma breve descrição da propriedade quando um usuário clica nele.

[
Category("Alignment"),
Description("Specifies the alignment of text.")
]
public ContentAlignment TextAlignment { //... }

<Category("Alignment"), _
Description("Specifies the alignment of text.")> _
Public Property _
TextAlignment As ContentAlignment
   ' ...
End Property

Observação
Em Visual C# e Visual Basic, uma classe de atributo nomeado AttributeNameatributo pode ser referenciado simplesmente como AttributeName na sintaxe de atributo.

Alguns atributos de tempo de design são aplicados no nível de classe. A DesignerAttribute é aplicado no nível de classe de atributo e informa qual classe designer para usar para exibir o controle de designer de formulários. Componentes estão associados um designer padrão (System.ComponentModel.Design.ComponentDesigner) e o Windows Forms e ASP.NET controles de servidor estão associados a seus próprios designers padrão. Aplicar DesignerAttribute somente se você definir um designer personalizado para seu componente ou controle.

// Associates the designer class SimpleControl.Design.SimpleDesigner
// with Simple.
[ Designer(typeof(SimpleControl.Design.SimpleDesigner))]
    public class Simple : WebControl { //... }

' Associates the designer class SimpleControl.Design.SimpleDesigner
' with Simple.
<Designer(GetType(SimpleControl.Design.SimpleDesigner))> _
Public Class Simple
    Inherits WebControl
    ' ...
End Class

Atributos comuns para propriedades e eventos

A tabela a seguir lista os atributos que normalmente são aplicados às propriedades e eventos.

Atributo	Aplicado A	Descrição
BrowsableAttribute	Propriedades e eventos	Especifica se uma propriedade ou um evento deve ser exibido no navegador de propriedades.
CategoryAttribute	Propriedades e eventos	Especifica o nome da categoria na qual agrupar uma propriedade ou evento. Quando as categorias são usadas, eventos e propriedades do componente podem ser exibidos em agrupamentos lógicos no Pesquisador de propriedade.
DescriptionAttribute	Propriedades e eventos	Define um pequeno bloco de texto a ser exibido na parte inferior do navegador de propriedade quando o usuário seleciona uma propriedade ou evento.
BindableAttribute	Propriedades	Especifica se uma propriedade é interessante para vincular a.
DefaultPropertyAttribute	Propriedades (Inserir esse atributo antes da declaração de classe).	Especifica a propriedade padrão para o componente. Esta propriedade é selecionada no navegador de propriedades quando um usuário clica no controle.
DefaultValueAttribute	Propriedades	Define um valor padrão simples para uma propriedade.
EditorAttribute	Propriedades	Especifica o editor para edição (alterar) uma propriedade em um designer visual.
LocalizableAttribute	Propriedades	Especifica que uma propriedade pode ser localizada. Quaisquer propriedades que têm este atributo são mantidas automaticamente para o arquivo de recursos, quando um usuário optar por localizar um formulário.
DesignerSerializationVisibilityAttribute	Propriedades	Especifica se (e como) uma propriedade exibida no navegador de propriedade deve ser mantida no código.
TypeConverterAttribute	Propriedades	Especifica o conversor de tipo a ser usado para converter o tipo da propriedade para outro tipo de dados.
DefaultEventAttribute	Eventos (Inserir esse atributo antes da declaração de classe).	Especifica o evento padrão para o componente. Este é o evento que está selecionado no navegador de propriedades quando um usuário clica no componente.

Salvo indicação em contrário, os atributos, propriedades e eventos são colocados no código imediatamente antes da declaração de propriedade ou evento, conforme mostrado no exemplo a seguir.

// To apply CategoryAttribute to the BorderColor 
// property, place it immediately before the declaration
// of the BorderColor property.
[Category("Appearance")] 
public Color BorderColor;

// To apply DescriptionAttribute to the Click event, 
// place it immediately before the declaration
// of the Click event.
[Description("The Click event of the button")]
public event EventHandler Click;

' To apply CategoryAttribute  to the BorderColor 
' property, place it before the property declaration.
<Category("Appearance")> Public BorderColor As Color

' To apply DescriptionAttribute to the Click event, 
' place it before the event declaration.
<Description("The Click event of the button")> Public Event Click

Para obter informações sobre os atributos de tempo de design para associar os designers a componentes e controles, consulte Estendendo suporte em tempo de design.

Para além de usar as classes de atributo definidas na .NET Framework biblioteca de classe, você pode definir suas próprias classes de atributo. Para obter detalhes, consulte a documentação para sua linguagem de programação ou consulte Codificando Atributos Personalizados.

Consulte também

Tarefas

Como: Aplicar atributos de controles do Windows Forms

Conceitos

Atributos e suporte em tempo de Design

Atributos de controles do Windows Forms

Outros recursos

Estendendo suporte em tempo de design