Benutzerhilfe für Komponenten
Aktualisiert: November 2007
Als Komponentenautor ist es Ihre Aufgabe, Benutzern bei allen Fragen, die im Zusammenhang mit Ihren Komponenten auftreten, behilflich zu sein und auch die entsprechende Dokumentation bereitzustellen. Sie können den Benutzern zur Entwurfszeit beschreibende Metadaten zur Verfügung stellen, und zur Laufzeit kann die HTML-Hilfe aufgerufen werden.
Mit Attributen stellen Sie beschreibende Informationen zu Ihrer Komponente bereit. Attribute sind spezialisierte Klassen, die mit anderen Klassen oder Klassenmembern verbunden sind und beim Kompilieren in Metadaten ausgegeben werden. Attribute liefern Informationen an den Benutzer oder direkt an die Entwicklungsumgebung. Wenn das System.ComponentModel.DescriptionAttribute-Attribut einer Eigenschaft oder einem Ereignis zugewiesen wird, wird im Eigenschaftenfenster beispielsweise eine kurze, beschreibende Zeichenfolge angezeigt. Andere Attribute wirken sich auf die Art und Weise aus, wie sich die Entwicklungsumgebung gegenüber den Komponenten verhält. Das System.ComponentModel.BrowsableAttribute-Attribut legt beispielsweise fest, ob eine Eigenschaft im Eigenschaftenfenster angezeigt wird.
Die Laufzeithilfe wird in der Regel nicht von einer Komponente bereitgestellt, in manchen Fällen kann dies jedoch sinnvoll sein. Eine sehr große und komplexe Komponente kann beispielsweise eine integrierte Hilfe besitzen, damit Entwickler keine ausführliche Dokumentation schreiben müssen. Die System.Windows.Forms.Help-Klasse von .NET Framework kapselt das HTML Help 1.x-Modul ein und kann verwendet werden, um Benutzern die Laufzeithilfe in Form von HTML- oder CHM-Dateien zur Verfügung zu stellen. Ausführliche Informationen finden Sie unter Gewusst wie: Festlegen einer Hilfedatei für Ihre Komponente.
In diesem Abschnitt
Gewusst wie: Festlegen einer Hilfedatei für Ihre Komponente
Enthält Erläuterungen zur Angabe und Anzeige einer Hilfedatei für Ihre Komponente während der Laufzeit.Gewusst wie: Bereitstellen von Metadatenbeschreibungen zur Komponente
Hier erfahren Sie, wie beschreibende Standard- und benutzerdefinierte Attribute erstellt und der Komponente hinzugefügt werden.Gewusst wie: Bereitstellen von Metadaten für Eigenschaften, Methoden und Ereignisse von Komponenten
Hier erfahren Sie, wie Sie Codemembern beschreibende Attribute anhängen.
Verwandte Abschnitte
Übersicht über Attribute
Dieser Abschnitt stellt eine Übersicht über Attribute und ihre Verwendung in .NET Framework bereit.Erweitern der Entwurfszeitunterstützung
Stellt Verknüpfungen zu Themen bereit, in denen die Integration von Komponenten und Steuerelementen in die Entwurfsumgebung behandelt wird.