Asistencia al usuario sobre componentes
Como creador de componentes, debe proporcionar a los usuarios asistencia y documentación acerca de los componentes. Durante el diseño, puede proporcionar asistencia por medio de metadatos descriptivos, mientras que en tiempo de ejecución puede ofrecer ayuda HTML.
Puede proporcionar información descriptiva acerca del componente mediante el uso de attributes. Los atributos son clases especializadas que se asocian a otras clases o miembros de clase y se emiten como metadatos en tiempo de compilación. Los atributos pueden proporcionar información al usuario o directamente al entorno de programación. Por ejemplo, el atributo DescriptionAttribute, cuando se asocia a una propiedad o un evento, muestra una breve cadena explicativa en la ventana Propiedades. Otros atributos afectan al modo en que el entorno de programación se comporta con el componente. Por ejemplo, el atributo BrowsableAttribute determina si una propiedad aparece en la ventana Propiedades.
No es habitual que un componente proporcione asistencia en tiempo de ejecución, aunque hay algunos casos en los que puede resultar útil. Por ejemplo, un componente muy grande y complejo puede tener ayuda integrada para que los programadores no tengan que escribir una documentación detallada. La clase Help de .NET Framework encapsula el motor de HTML Help 1.x y puede utilizarse para proporcionar ayuda a los usuarios en tiempo de ejecución por medio de archivos HTML o .chm. Para obtener información detallada, vea Cómo: Especificar un archivo de Ayuda para un componente.
En esta sección
Cómo: Especificar un archivo de Ayuda para un componente
Explica cómo se especifica y se muestra un archivo de ayuda para el componente en tiempo de ejecución.Cómo: Proporcionar descripciones de metadatos sobre los componentes
Muestra cómo se crean y asocian al componente atributos descriptivos estándar y personalizados.Cómo: Proporcionar metadatos para propiedades, métodos y eventos de componentes
Describe cómo se asocian atributos descriptivos a los miembros de código.
Secciones relacionadas
- Ampliar compatibilidad en tiempo de diseño
Proporciona vínculos a temas sobre cómo se integran componentes y controles en el entorno de diseño.