コンポーネントのユーザー支援
コンポーネントの作成者は、コンポーネントについて支援とドキュメントをユーザーのために用意する必要があります。 支援は、デザイン時には説明用のメタデータとして、実行時には HTML ヘルプを呼び出すことによって提供できます。
コンポーネントに関する説明情報は、"属性" を使用して提供できます。 属性は、他のクラスやクラス メンバーに追加される特別なクラスであり、コンパイル時にメタデータに出力されます。 属性により、ユーザーに対して、または直接開発環境に対して情報を提供できます。 たとえば、プロパティまたはイベントに DescriptionAttribute 属性を追加すると、[プロパティ] ウィンドウに説明文字列が表示されます。 コンポーネントに対する開発環境の動作に影響を与える属性もあります。 たとえば、BrowsableAttribute 属性は、プロパティが [プロパティ] ウィンドウに表示されるかどうかを決定します。
通常、実行時の支援はコンポーネントでは提供していませんが、必要になる場合もあります。 たとえば、サイズが大きく複雑なコンポーネントには、開発者が広範なドキュメントを記述しなくて済むように組み込みヘルプが含まれている場合があります。 .NET Framework の Help クラスは、HTML Help 1.x エンジンをカプセル化し、実行時にユーザーに対して HTML ファイル形式または .chm ファイル形式のヘルプを提供するために使用できます。 詳細については、「方法 : コンポーネントに対するヘルプ ファイルを指定する」を参照してください。
このセクションの内容
方法 : コンポーネントに対するヘルプ ファイルを指定する
実行時にコンポーネントに関するヘルプ ファイルを指定して表示する方法について説明します。方法 : コンポーネントに関する説明用メタデータを提供する
標準およびカスタムの説明属性を作成してコンポーネントに追加する方法を示します。方法 : コンポーネントのプロパティ、メソッド、およびイベントに対するメタデータを提供する
コード メンバーに説明属性を追加する方法について説明します。
関連項目
- デザイン時サポートの拡張
コンポーネントおよびコントロールのデザイン環境への統合に関連するトピックへのリンクを示します。