作業項目フォーム上のコントロールの指定
このトピックで説明している情報は、Control 要素、その子要素、および属性に関するクイック リファレンスとして使用できます。 作業項目フォームに表示するフィールドまたはフォーム コントロールごとに Control 要素を追加します。
作業項目をカスタマイズして、チームがフォームを正しく使用できるように情報を表示することができます。 作業項目フィールドとコントロールを追加して、追跡するデータを入力および表示できるようにします。
Control 要素には、フィールドの追加、またはプレーンテキスト、ハイパーリンク テキスト、フィールドの表示に使用できる Type 属性の値が 9 つあります。 さらに、特別なコントロールを定義して添付ファイルへのリンク追加や Web ベースのコンテンツの表示、独自のコントロールを作成して作業項目フォームに追加することなどが可能です。
作業項目フィールドの追加
作業項目フォームをカスタマイズする際に、通常は、作業項目フィールドのサブセットを追加します。これらのフィールドは、フォームに表示する作業項目の種類に対して定義されたものです。 フィールド定義は、表示するデータやフォームに入力できるデータのさまざまな特性を制御します。 詳細については、「クエリ、レポート、ワークフローをサポートするフィールドの変更または変更」を参照してください。
それぞれの作業項目フィールドは、データ型と関連付けられます。 次の表の情報を使用して、Type 要素の Control 属性によってサポートされるフィールドの種類を判断できます。 コントロールの横に表示されるテキストを指定するには、Label 属性を使用します。 コントロールとの相対的なラベル位置を指定するには、これに関連する LabelPosition 属性を使用します。 詳細については、「作業項目フィールドの表示の制御」を参照してください。
注意
システム フィールドの値を変更することはできません。これらの値は自動的に更新されます。たとえば、[作成日] フィールドおよび [作成者] フィールドは、作業項目が最初に保存されたときに定義されます。ただし、これらのフィールドは検索条件で使用できます。各システム フィールドの詳細については、「Visual Studio ALM の作業項目フィールド参照」を参照してください。
フィールドの種類 |
Control 要素の Type 属性 |
使用方法 |
|---|---|---|
DateTime |
FieldControl DateTimeControl |
FieldControl を使用して、DateTime データ型フィールドを入力または表示するためのテキスト フィールドを提供します。 次の図に示すように、DateTimeControl を使用して、フィールドの日付を選択するためのカレンダー選択機能を設定します。 .png "カレンダー フィールド")
|
Double |
FieldControl |
FieldControl を使用して、Double フィールドを入力または表示するためのテキスト フィールドを提供します。 |
History |
WorkItemLogControl |
次の図に示すように、WorkItemLogControl を使用して、ディスカッション スレッドや他の履歴情報を追跡する、History フィールドのコントロール フィールドを設定します。 .png "作業項目フォームの履歴タブとフィールド")
このコントロールは、作業項目の History フィールドである System.History 作業項目フィールドの表示をサポートする場合にのみ使用できます。 このコントロールを使用すると、作業項目の履歴情報を展開および縮小できます。 History フィールドに追加するテキストの書式を設定することもできます。 |
HTML |
HTMLControl |
次の図に示すように、HTMLControl を使用して、リッチ テキストの書式設定を取り込む HTML フィールドを有効にするため、コントロール フィールドを設定します。 .png "作業項目フォームに表示される HTML フィールド")
|
Integer |
FieldControl |
FieldControl を使用して、Integer フィールドのコントロール フィールドを提供します。 |
PlainText |
FieldControl |
FieldControl を使用して、255 文字を超える説明を格納するテキスト ボックスなど、PlainText フィールドのコントロール フィールドを設定します。 |
String |
FieldControl |
FieldControl を使用して、String フィールドのコントロール フィールドを提供します。 String フィールドの長さは 255 文字までに制限されています。 |
TreePath |
WorkItemClassificationControl |
WorkItemClassificationControl を使用して、TreePath フィールドのコントロール フィールドを提供します。 |
すべての種類のコントロールに対するオプションのコントロール要素のフィールド属性
次のオプションの属性は、一覧に示されているコントロールの種類に対してのみ指定できます。
属性 |
説明 |
|---|---|
Field |
作業項目フィールドに関連付けるコントロールを指定します。 |
Label |
コントロールを識別する、フォーム上に表示されるテキストを指定します。 80 文字以下の文字列を指定します。 注意 FieldControl を使用して、作業項目フォームに追加されたフィールドのラベルへのハイパーリンクを添付できます。このコントロールは、フィールドの使用方法に関する情報へのリンクを提供する場合に便利です。詳細については、「作業項目フォームでのヘルプ テキスト、ハイパーリンク、または Web コンテンツの提供」を参照してください。 |
LabelPosition |
コントロールのデータに対するラベルの相対位置を指定します。 Top、Bottom、Left、Right のいずれかの文字列を指定します。 |
Dock |
コンテナー内の指定した辺のラベルのアラインメントを指定します。または、コンテナーの全面にフィールドを拡張します。 Fill、Top、Bottom、Left、Right のいずれかの文字列を指定します。 |
Padding |
コントロールの境界線の内側の空白の大きさをピクセル単位で指定します。 4 つの値は、top、bottom、left、および right に対応しています。 例: (2,0,2,0) |
Margin |
コントロールの境界線の外側の空白の大きさをピクセル単位で指定します。 4 つの値は、top、bottom、left、および right に対応しています。 例: (2,0,2,0) |
ReadOnly |
フィールドを読み取り専用に指定します。 True または False を指定します。 |
MinimumSize |
コントロールがフォーム上で占める大きさの最小サイズ (ピクセル単位) を指定します。 2 つの値は、幅と高さに対応しています。 例: (100,100) |
Name |
コントロールを一意に識別します。 フォーム上の複数のコントロールが同じ作業項目フィールドに関連付けられる場合、Name 属性が必要です。 注意 Name 属性を使用して、フォーム上の複数の領域に同じフィールドを表示できます。それぞれのコントロール エントリの Name 属性に一意の値を指定すると、システムはそれぞれのコントロールを一意に識別できるようになります。これは、タブのコンテキストに基づいて同じコントロールをさまざまな場所に表示する場合に役立ちます。 |
特定の種類のコントロールに対するオプションのコントロール要素のフィールド属性
次のオプションの属性は、一覧に示されているコントロールの種類に対してのみ指定できます。
属性 |
コントロールの種類 |
説明 |
|---|---|---|
NumberFormat |
FieldControl |
フィールド コントロールに入力できる文字を指定します。 有効な値は、WholeNumbers、SignedWholeNumbers、DecimalNumbers、および SignedDecimalNumbers です。 |
MaxLength |
FieldControl |
フィールド コントロールに使用できる最大文字数を指定します。 |
Format |
DateTimeControl |
日時フィールドの形式を指定します。この形式は、DateTimePickerFormat 列挙型の値の 1 つに対応します。 有効な値は、Custom、Long、Short、および Time です。 |
CustomFormat |
DateTimeControl |
DateTimePicker.CustomFormat プロパティに定義されている構文に対応する日時フィールドのカスタム形式を指定します。 |
特殊なコントロールの追加
次の表に、添付ファイルの管理、リンクの作成、Web ベースのコンテンツの表示、および作業項目フィールドと関連付けられていないデータの表示をサポートする、Control 要素の Type 属性を示します。
Control 要素の Type 属性 |
使用方法 |
|---|---|
AttachmentsControl |
作業項目フォームにファイルを添付するために使用します。 次の図に示すように、このコントロールは、通常それ自体のタブ グループに含まれています。 添付ファイル コントロール .png "ファイルを作業項目に添付する")
詳細については、「添付ファイル コントロールの追加」を参照してください。 |
LabelControl |
次の図に示すように、フィールドに関連付けられていないプレーンテキストまたはハイパーリンクのテキストを使用します。 .png "テキストに適用した 2 つのハイパーリンクの例")
LabelText および Link の子要素とコンテナー要素を使用して、テキスト、ハイパーリンク、およびテキストの一部がハイパーリンクに関連付けられているフィールドまたはラベルの位置を指定します。 詳しくは、「作業項目フォームでのヘルプ テキスト、ハイパーリンク、または Web コンテンツの提供」、「LabelText および Text XML 要素のリファレンス」、「Link および Param XML 要素のリファレンス」をご覧ください。 |
LinksControl |
作業項目間のリンクを作成および管理するために使用します。 次の図に示すように、このコントロールは、通常それ自体のタブ グループに含まれています。 .png "作業項目フォームに追加したリンク コントロールの例")
LinksControlOptions を使用して、リンクの一覧表示に使用されるリンク フィルターおよび列フィールドのレイアウトを定義します。 詳細については、次のトピックを参照してください。リンク コントロールの定義とリンク関係の制限 およびLinksControlOptions 要素. |
WebpageControl |
作業項目フォームに Web コンテンツを表示するために使用します。 このコントロールは、通常それ自体のタブ グループに含まれています。 WebpageControlOptions 子要素および Link 子要素を使用して、作業項目フォームの Web ページのターゲットを読み込むために必要なコントロールを指定します。 詳しくは、「作業項目フォームに Web コンテンツを追加するための WIT 定義の編集」、「WebpageControlOptions XML 要素のリファレンス」、「Link および Param XML 要素のリファレンス」をご覧ください。 |
カスタム コントロールの追加
組み込みコントロールのほかにも、独自のカスタム コントロールを作業項目フォームに追加できます。
たとえば、クリップボードのスクリーンショットをキャプチャするカスタム コントロールを追加できます。 または、リストやメニューに表示される値のチェック ボックスを追加して、複数の値をキャプチャするコントロールを提供できます。
カスタム コントロールを実装するには、Type 属性にコントロールの名前を指定する必要があります。
参照
処理手順
作業項目フォームに Web コンテンツを追加するための WIT 定義の編集