作業項目フィールドの表示の制御
作業項目フォームでは、テキスト ボックスのラベル名、位置、およびサイズを制御できます。また、プレーンテキスト、整数、数値、日付、ツリー パスの各データ型の作業項目フィールドのその他の表示コントロールのラベル名、位置、およびサイズを制御できます。 これらのフィールドを表示するには、次の選択肢の中から適切な Control 要素を選択し、その Type 属性を指定する必要があります。
DateTimeControl: データ型が DateTime である書式設定された日付フィールドを表示する際に使用します。
FieldControl: プレーンテキスト フィールドおよび数値フィールドを表示する際に使用します。また、データ型が String、Identity、Integer、Double、または PlainText であるフィールドの値リストを表示する際にも使用します。
HtmlFieldControl: データ型が HTML である複数行のリッチ テキスト形式フィールドを表示する際に使用します。
WorkItemClassificationControl: データ型が TreePath である階層パス フィールドを表示する際に使用します。
その他の Type コントロールの詳細については、次のトピックを参照してください。
このトピックの内容
データ フィールドのサイズと表示を制御する
フィールドにラベルを付けてフォーム上の 2 か所にフィールドを追加する
フィールドを読み取り専用にする
プレーンテキスト フィールドおよび数値フィールドを追加する
書式設定されたテキスト フィールドを追加する
日付フィールドまたはカレンダー フィールドを追加する
区分パスおよびイテレーション パスに対するフィールドを追加する
データ フィールドのサイズと表示を制御する
各データ フィールドのスペーシングおよびサイズを制御するには、次の表に示すオプションの属性を使用します。
注意
各データ入力フィールドの全体的なサイズは、(a) そのフィールドに設定されている属性値、(b) コンテナーのサイズ、(c) フォーム上の他のフィールドに割り当てられている領域、の 3 要素によって決まります。最小サイズを指定しなかった場合、既定値に設定されます。ただし、フォーム上の他のフィールドに設定されている属性が、フィールド サイズに影響を及ぼすことがあります。列数、および、各列の最大サイズのフィールドに割り当てた横幅によって、フォームの横幅が決まります。また、縦グループで指定したフィールド数、および、各フィールドに割り当てた縦幅によって、フォームの上端および下端のサイズが決まります。
属性 |
説明 |
パターン値の例 |
|---|---|---|
MinimumSize |
コントロールの最小サイズ (幅、高さ) を指定します。 コントロールに対するコンテナーがこのサイズよりも小さい場合、水平スクロール バーまたは垂直スクロール バー、あるいはその両方が表示されます。 |
(100,100) |
Margin |
コントロール周囲の空白の大きさ、およびコントロールと隣接コントロールの間の空白の大きさ (top、bottom、left、right) をピクセル単位で指定します。 |
(2,0,2,0) |
Padding |
コントロールの外枠の周囲の空白の大きさ (top、bottom、left、right) をピクセル単位で指定します。 |
(2,0,2,0) |
フィールドにラベルを付けてフォーム上の 2 か所にフィールドを追加する
フォーム上の各コントロールに対して、オプションのラベルとその位置を設定できます。設定するには、Label 属性および LabelPosition 属性を使用します。 FIELD 要素で設定されている表示名と異なる名前を設定することもできます。 ラベルを指定しなかった場合、表示名が使用されます。 チーム メンバーがクエリを実行して作業項目を検索するときは、必ず表示名が使用される点に注意してください。 ラベルの最大サイズは 80 文字です。
注意
同じグループ内で定義されている各コントロールに対しては、同じラベル位置を定義する必要があります。
フォーム上の複数の領域 (例: フォーム上端およびプロパティ ページ上) に同じフィールドを追加するには、Name 属性を使用します。 Name 属性は単に、そのコントロールがフォーム上の他のコントロールと異なることを示します。
フィールドを読み取り専用にする
フィールドを読み取り専用にする方法は 2 とおりあります。 1 つ目の方法では、READONLY 要素を、種類を定義する FIELD セクションの FIELDS 要素の子要素として追加します。 READONLY 要素を使用することにより、特定のユーザーがそのフィールド値を修正できるかどうかを指定できます。 次の例では、プログラム マネージャーのみが Sub-Title フィールドを修正できます。
<FIELD name="Sub-Title" refname="ACME.ACE.SubTitle" type="String" >
<READONLY for="[Global]\Team Foundation Valid Users" not="Program Managers"/>
</FIELD>
2 つ目の方法では、ReadOnly 要素に対して CONTROL 属性を指定します。 この方法では、すべてのユーザーがフィールドを編集できなくなります。
Control FieldName=" ACME.ACE.SubTitle" Type="FieldControl" Label="Sub-Title" LabelPosition="Left" ReadOnly="True" />
テキスト フィールドおよび数値フィールドを追加する
プレーンテキスト フィールドおよび数値フィールドをフォームに追加するには、FieldControl 型を使用します。 この属性は、選択リスト、人名表示用フィールド (例: Assigned To フィールド、Owner フィールド)、整数表示用フィールド、および実数表示用フィールドを追加する際にも使用されます。 フィールド コントロールでは、参照名でフィールドを参照する必要があります。 フィールド ラベルには、プレーンテキスト、またはハイパーリンクのスタイルを指定できます。 詳細については、「作業項目フォームでのヘルプ テキスト、ハイパーリンク、または Web コンテンツの提供」を参照してください。
テキスト フィールド、整数フィールド、および選択リスト フィールド
.png "複数フィールドのグループ")
数値フィールドの形式、および、テキスト フィールドまたは数値フィールドに入力できる最大文字数を制御するには、次の表に示すオプションの属性を使用します。
属性 |
説明 |
|---|---|
NumberFormat |
フィールド コントロールに入力できる文字を指定します。 有効な値は、WholeNumbers、SignedWholeNumbers、DecimalNumbers、SignedDecimalNumbers です。 |
MaxLength |
フィールド コントロールに使用できる最大文字数を指定します。 |
次のコードは、前の図に表示されるフィールドのグループを作成します。
<TABGROUP>
<TAB Label="Planning">
<Group Label="Status" Padding="(0,0,0,3)">
<Column PercentWidth="100">
<Control FieldName="Microsoft.DevDiv.Importance" Type="FieldControl" Label="Importance" LabelPosition="Left" />
<Control FieldName="Microsoft.DevDiv.Commitment" Type="FieldControl" Label="Commitment / Confidence" LabelPosition="Left" />
<Control FieldName="Microsoft.DevDiv.VisionDoc" Type="FieldControl" Label="Vision Doc" LabelPosition="Left" />
<Control FieldName="Microsoft.DeveloperDivision.Features.EstimatedCost" Type="FieldControl" Label="Estimated Cost" LabelPosition="Left" />
<Control FieldName="Microsoft.DevDiv.BusinessUnit" Type="FieldControl" Label="BU (Use Area Path)" LabelPosition="Left" />
<Control FieldName="Microsoft.DevDiv.Website" Type="FieldControl" Label="Website" LabelPosition="Left" />
</Column>
</Group>
. . .
</TAB>
</TABGROUP>
書式設定されたテキスト フィールドを追加する
HTMLFieldControl 型を使用することにより、データ型が HTML であるフィールドを追加できます。 このコントロールは、複数行の書式付きテキストの表示をサポートします。
HTML フィールド
.png "作業項目フォームに表示される HTML フィールド")
<Control Type="HtmlFieldControl" FieldName="Microsoft.VSTS.ReproSteps" Label="Repro Steps"
LabelPosition="Top" MinimumSize="(100,500)" />
ヒント
フィールドが縦方向に並んでいるフォーム上に HTMLFieldControl 要素を複数個追加する場合、各フィールド コントロールに対して MinimumSize 属性を設定します。この方法では、すべてのテキスト ボックスを同じサイズにすることができます。この方法を使用しなかった場合、末尾の HTML コントロール要素のサイズがフォームに合わせて調整され、その上部にある各要素はさらに小さいテキスト ボックスと共に表示されます。
日付フィールドまたはカレンダー フィールドを追加する
DateTimeControl 型を使用することにより、カレンダー選択ツールを表示できます。ユーザーはこのカレンダー選択ツールで、DateTime フィールドに入力する日付を選択できます。 このコントロールによって、フィールドの日付と時刻をすばやく選択できます。
カレンダー フィールド (Format="Short" と指定した場合)
.png "カレンダー フィールド")
たとえば、将来の開始希望日または確認希望日を次のように指定できます。
<Control Type="DateTimeControl" FieldName="MyCompany.EnvironmentCR.PreferredStart"
Label="Preferred Start Date:" LabelPosition="Left" Format="Short" />
<Control Type="DateTimeControl" FieldName="MyCompany.EnvironmentCR.PreferredStartTime"
Label="Preferred Start Time:" LabelPosition="Left" Format="Time" />
DateTime フィールドの形式を制御するには、次の表に示すオプションの属性を使用します。
属性 |
説明 |
|---|---|
Format |
日時フィールドの形式を指定します。この形式は、DateTimePickerFormat 列挙型の値の 1 つに対応します。 有効な値は、Custom、Long、Short、Time です。 Custom に指定するときは、CustomFormat 属性も設定する必要があります。 |
CustomFormat |
DateTimePicker.CustomFormat プロパティに定義されている構文に対応する日時フィールドのカスタム形式を指定します。 次に例を示します。 Format="Custom" CustomFormat = "MMM dd, 'of the year' yyyy" 詳細については、Microsoft Web サイトの「DateTimePicker.CustomFormat プロパティ」を参照してください。 |
区分パスおよびイテレーション パスに対するフィールドを追加する
WorkItemClassificationControl 型を使用することにより、データ型が TreePath であるフィールドを追加できます。 このコントロールを使用した場合、区分パス フィールドおよびイテレーション パス フィールドを階層型ツリー形式で表示できます。 ツリーで表示される階層ノードは、展開および縮小できます。
<Control Type="WorkItemClassificationControl" FieldName="System.AreaPath" Label="Area"LabelPosition="Left" />
注意
WorkItemClassificationControl を使用することにより、System.AreaPath フィールドおよび System.IterationPath フィールドを表示できます。このコントロールを使用して、他のデータ型のフィールドまたはカスタム フィールドを表示することはできません。
詳細については、「区分およびイテレーション パスの追加および変更」を参照してください。
参照
概念
レポート作成をサポートするための作業項目フィールドの追加および変更