Ajuda do usuário para componentes
Como um autor componente, você deve fornecer a ajuda e documentação para os usuários sobre seus componentes.Você pode prover assistência em tempo de design com os metadados descritivos e em tempo de execução chamando a ajuda HTML.
Você pode fornecer a informação descritiva sobre seu componente com o uso de attributes.Os atributos são classes especializadas que estão anexados a classes ou outros membros da classe e emitido em metadados em tempo de compilação.Atributos podem fornecer informações para o usuário ou diretamente para o ambiente de desenvolvimento.Por exemplo, o atributo de System.ComponentModel.DescriptionAttribute , quando anexado a uma propriedade ou um evento, exibe uma breve cadeia de caracteres descritiva na janela propriedades.Outros atributos afetam a maneira que o ambiente de desenvolvimento se comporta com o componente.Por exemplo, o atributo de System.ComponentModel.BrowsableAttribute determina se uma propriedade aparece na janela propriedades.
Assistência de tempo de execução geralmente não é fornecida por um componente, mas há alguns casos onde pode fazer sentido.Por exemplo, um componente muito grande e complexo pode ter a ajuda interno para que os desenvolvedores não tem que escrever a documentação abrangente.A classe do.NET Framework System.Windows.Forms.Help encapsula ajuda HTML 1. mecanismos dex , e pode ser usada para fornecer em tempo de execução ajuda para os usuários com HTML ou arquivos .chm.Para obter detalhes, consulte:Como: Especificar uma ajuda Arquivo para o componente.
Nesta seção
Como: Especificar uma ajuda Arquivo para o componente
Explica como especificar em tempo de execução e exibir um arquivo de ajuda para o componente.Como: Fornecer descrições dos metadados sobre o componente
Demonstra como criar e anexar o padrão e descritivos atributos personalizados ao seu componente.Como: Fornecer metadados para componentes, propriedades, métodos e eventos
Descreve como anexar atributos descritivos para codificar membros.
Seções relacionadas
- Estendendo suporte em tempo de Design
Fornece links para tópicos sobre componentes e controles de integração no ambiente de design.