Atributos de time de design para componentes

Se você não estiver familiarizado com a aplicação de atributos para fornecer metadados para o common linguagem tempo de execução, consulte Estendendo metadados usando atributos.sistema autônomo componentes podem ser exibidas em um designer, sistema autônomo Visual Studio, eles exigem atributos fornecem metadados para ferramentas em time de design. Esta seção descreve e fornece uma lista de atributos de time de design usados com freqüência.

Atributos e suporte de Designer

Atributos de time de design são essenciais para a exibição de seu controle e seus membros corretamente em time de design, sistema autônomo eles fornecem informações valiosas para uma ferramenta design visual.

No fragmento de código a seguir, a CategoryAttribute atributo permite que o navegador de propriedade para exibir o TextAlignment propriedade na categoria de alinhamento. The DescriptionAttribute atributo permite que o navegador propriedade forneça 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 atributos nomeada AttributeNameAtributo pode ser referenciado simplesmente sistema autônomo AttributeName na sintaxe do atributo.

Alguns atributos de time de design são aplicados no nível de classe.A DesignerAttribute atributo é aplicado no nível de classe e informa o designer de formulários classe designer que usar para exibir o controle.Componentes estão associados a um designer de padrão (sistema.ComponentModel.Design.ComponentDesigner) e Windows Forms e ASP.NET controles de servidor estão associados com 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 de propriedades e eventos

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

Atributo	Aplicada para	Descrição
BrowsableAttribute	Propriedades e eventos	Especifica se uma propriedade ou um evento deve ser exibido no navegador da propriedade.
CategoryAttribute	Propriedades e eventos	Especifica o nome da categoria na qual deseja agrupar uma propriedade ou evento.Quando as categorias são usadas, eventos e propriedades do componente podem ser exibidos em agrupamentos lógicos no navegador da propriedade.
DescriptionAttribute	Propriedades e eventos	Define um pequeno bloco de texto a ser exibido na parte inferior do Pesquisador de propriedades quando o usuário seleciona uma propriedade ou evento.
BindableAttribute	Propriedades	Especifica se é interessante BIND a uma propriedade.
DefaultPropertyAttribute	Propriedades (Insira esse atributo antes da declaração de classe.)	Especifica a propriedade padrão do componente.Esta propriedade for selecionada no navegador de propriedade quando um usuário clica no controle.
DefaultValueAttribute	Propriedades	Define um valor padrão simples para uma propriedade.
EditorAttribute	Propriedades	Especifica o editor a ser usado 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 em outro tipo de dados.
DefaultEventAttribute	Eventos (Insira esse atributo antes da declaração de classe.)	Especifica o evento padrão do componente.Isso é o evento selecionado no Pesquisador de propriedades quando um usuário clica no componente.

Salvo indicação em contrário, 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 atributos de time de design que associar designers componentes e controles, consulte Estendendo suporte em tempo de design.

Além usando as classes de atributo definidos no .NET Framework biblioteca de classes, 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 in Windows Forms Controls

Conceitos

Atributos e suporte do tempo de design

Atributos no Windows Forms Controls

Outros recursos

Estendendo suporte em tempo de design