Assistência ao usuário para componentes
Como o autor de um componente, você deve fornecer assistência e documentação para os usuários sobre os componentes. Você pode fornecer assistência em tempo de design por meio de metadados descritivos e em tempo de execução pela chamada Ajuda em HTML.
Você pode fornecer informações descritivas sobre o componente através do uso de attributes. Os atributos são classes especializadas que são conectados a outras classes ou membros de classe e são emitidas em metadados em tempo de compilação. Atributos podem fornecer informações para o usuário ou diretamente ao ambiente de desenvolvimento. Por exemplo, o System.ComponentModel.DescriptionAttribute de atributo, quando conectado a uma propriedade ou evento, exibe uma breve seqüência de caracteres descritiva na janela Propriedades. Outros atributos que afetam o comportamento do ambiente de desenvolvimento com o componente. Por exemplo, o System.ComponentModel.BrowsableAttribute atributo determina se uma propriedade aparece na janela Propriedades.
Assistência em tempo de execução não é geralmente fornecida por um componente, mas existem alguns casos onde talvez faça sentido. Por exemplo, um componente muito grande e complexo pode ter ajuda interna para que os desenvolvedores não precise escrever documentação extensiva. A.NET Framework System.Windows.Forms.Help classe encapsula o HTML Help 1.x engine e pode ser usado para fornecer ajuda aos usuários em tempo de execução com arquivos HTML ou. chm. Para obter detalhes, consulte:Como: Especificar um arquivo de ajuda para seu componente..
Nesta seção
Como: Especificar um arquivo de ajuda para seu componente.
Explica como especificar e exibir um arquivo de ajuda para o componente em tempo de execução.Como: Forneça descrições de metadados sobre o seu componente.
Demonstra como criar e anexar atributos descritivos de padrão e personalizados para seu componente.Como: Fornecer metadados de eventos, métodos e propriedades do componente
Descreve como anexar atributos descritivos aos membros do código.
Seções relacionadas
- Estendendo suporte em tempo de design
Fornece links para tópicos sobre como integrar os componentes e controles para o ambiente de design.