作業項目フォーム上のコントロールの指定

TFS 2015 |TFS 2013

重要

このトピックは、オンプレミスの XML プロセス モデルのプロジェクトのカスタマイズに適用されます。 ホステッド XML プロセス モデルについては、「 WebLayout 要素と Control 要素」を参照してください。 継承プロセス モデルについては、「プロセスのカスタマイズ 」を参照してください。

プロセス モデルの概要については、作業追跡エクスペリエンスの カスタマイズに関するページを参照してください。

作業項目フォームに表示するフィールドまたはフォーム コントロールごとに、 要素を追加 Control します。 作業項目をカスタマイズして、チームがフォームを正しく使用できるように情報を表示することができます。 作業項目フィールドとコントロールを追加して、追跡するデータを入力および表示できるようにします。

要素 Control には、フィールドを追加したり Type 、プレーンまたはハイパーリンクされたテキストまたはフィールドを表示したりするために使用できる 属性のデータ型の値がいくつか含まれています。 さらに、特別なコントロールを定義して添付ファイルへのリンク追加や Web ベースのコンテンツの表示、独自のコントロールを作成して作業項目フォームに追加することなどが可能です。

作業項目フォームでは、テキスト ボックスのラベル名、位置、およびサイズを制御できます。また、プレーンテキスト、整数、数値、日付、ツリー パスの各データ型の作業項目フィールドのその他の表示コントロールのラベル名、位置、およびサイズを制御できます。 これらのフィールドを表示するには、次のオプションから Control 正しい要素 Type 属性を指定する必要があります。

• FieldControl: フィールドの種類が BooleanStringIntegerIdentity、および であるフィールドのプレーン テキスト フィールドまたは数値フィールドと値のリストを表示するためにDouble使用されます。PlainText

• HtmlFieldControl: フィールド データ型が であるフィールドの複数行のリッチテキスト形式を表示するために使用されます HTML。

• DateTimeControl: フィールドの種類が である書式設定された日付フィールドを表示するために使用されます DateTime。

• WorkItemClassificationControl フィールドの種類が である階層パス フィールドを表示するために使用されます TreePath。

作業項目フィールドの追加

作業項目フォームをカスタマイズする際に、通常は、作業項目フィールドのサブセットを追加します。これらのフィールドは、フォームに表示する作業項目の種類に対して定義されたものです。 フィールド定義は、表示するデータやフォームに入力できるデータのさまざまな特性を制御します。 詳細については、「フィールドの変更 またはカスタム フィールドの追加」を参照してください。

それぞれの作業項目フィールドは、データ型と関連付けられます。 属性を Label 使用して、コントロールの横に表示されるテキストを指定します。 関連属性を使用 LabelPosition して、コントロールに対して相対的にラベルが表示される場所を指定します。

Note

自動的に更新されるシステム フィールドの値を変更できない。 たとえば、[作成日] フィールドおよび [作成者] フィールドは、作業項目が最初に保存されたときに定義されます。 ただし、これらのフィールドは検索条件で使用できます。 各システム フィールドの説明については、「作業項目フィールドの インデックス」を参照してください。

数値フィールドを追加する

整数 FieldControl フィールドのコントロール フィールドを指定するには、 を使用します。

<Control FieldName="System.Id" Type="FieldControl" Label="Id" LabelPosition="Left" />

Double FieldControl フィールドの入力または表示のテキスト フィールドを指定するには、 を使用します。

<Control FieldName="ABC_Company.Statistics.Analysis" Type="FieldControl" Label="Analysis %" LabelPosition="Left" />

プレーンテキストフィールドまたは文字列フィールドを追加する

選択リスト String や短いテキストで使用される文字列フィールドなど、255 文字に制限される文字列フィールドを追加する場合は、 コントロールを指定します。

<Control FieldName="Microsoft.VSTS.DocName" Type="FieldControl" Label="Vision Doc Location" LabelPosition="Left" />

PlainText 255 文字を超える可能性がある説明を含むテキストをキャプチャする場合は、 コントロールを指定します。

<Control FieldName="System.Title" Type="FieldControl" Label="Title" LabelPosition="Left" />

チェックボックスまたはブール値フィールドを追加する

Note

機能の可用性:ブール型のデータ型は、ホスト型 XML (Azure DevOps Services) とオンプレミス XML で、TFS 2017.2 以降のバージョンでサポートされています。

WIT 定義の FIELDS セクション内にブール型フィールドを 追加 するには、次の構文を使用します。

<FIELD name="Triage" refname="Fabrikam.Triage" type="Boolean" >
  <DEFAULT from="value" value="False" />
  <HELPTEXT>Triage work item</HELPTEXT>
</FIELD>

次に、FORM セクション内に 次の構文 を追加して、フォームにフィールドを表示します。

<Control Label="Triage" Type="FieldControl" FieldName="Fabrikam.Triage" /> 

フィールドは、フォームにチェック ボックスとして表示されます。

日付フィールドまたはカレンダー フィールドを追加する

型を使用して DateTimeControl 、フィールドの日付を選択するカレンダー ピッカーをユーザーに提供 DateTime します。 このコントロールによって、フィールドの日付と時刻をすばやく選択できます。

カレンダー フィールド (Format="Short" と指定した場合)

たとえば、将来の開始希望日またはレビュー希望日を次のように指定できます。

<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 つに対応します。 有効な値は、CustomLong、Short、 ですTime。 を指定する場合 Customは、 属性も設定する必要 CustomFormat があります。
CustomFormat	DateTimePicker.CustomFormat プロパティに定義されている構文に対応する日時フィールドのカスタム形式を指定します。 次に例を示します。 Format="Custom" CustomFormat = "MMM dd, 'of the year' yyyy" 詳細については、Microsoft Web サイト「 DateTimePicker.CustomFormat プロパティ」を参照してください。

リッチテキスト (HTML) フィールドを追加する

次の図 HTMLControl に示すように HTML 、 を指定してリッチテキストの書式設定をキャプチャするフィールドを追加します。

<Control Type="HtmlFieldControl" FieldName="Microsoft.VSTS.Notes" Label="Notes" Dock="Fill" />

ヒント

垂直方向に積み HTMLFieldControl 上げ MinimumSize される複数の要素をフォームに追加する場合は、各フィールド コントロールに属性を指定する必要があります。 この方法では、すべてのテキスト ボックスを同じサイズにすることができます。 この方法を使用しなかった場合、末尾の HTML コントロール要素のサイズがフォームに合わせて調整され、その上部にある各要素はさらに小さいテキスト ボックスと共に表示されます。

プレーンまたはハイパーリンク付きテキスト コントロールを追加する

次の図 LabelControl に示すように、 を使用して、フィールドに関連付けされていないプレーンテキストまたはハイパーリンクテキストを表示します。

と 子要素 LabelText とコンテナー Link 要素を使用して、テキストがハイパーリンクに部分的に関連付けられているフィールドまたはラベルのテキスト、ハイパーリンク、位置を指定します。 詳細については、「ヘルプ テキスト、ハイパーリンク、または Web コンテンツを提供する」、 LabelText と Text、 Link と Param に関するページを参照してください。

Web ページ コントロールを追加する

作業 WebpageControl項目フォームに Web コンテンツを表示するには、 を使用します。 このコントロールは、通常それ自体のタブ グループに含まれています。 と 子要素 WebpageControlOptions を Link 使用して、作業項目フォームで Web ページ ターゲットを読み込むのに必要なコントロールを指定します。

詳細については、「 WIT 定義を編集して作業項目フォームに Web コンテンツを追加する」、 Web ページのControlOptions、およびリンクとパラメーターに関する ページを参照してください。

リンク コントロールを追加する

作業項目間 LinksControl のリンクを作成および管理するには、 を使用します。 次の図に示すように、このコントロールは、通常それ自体のタブ グループに含まれています。

を使用して、 LinksControlOptions リンクの一覧を表示するために使用される列フィールドのリンク フィルターとレイアウトを定義することもできます。 詳細については、「リンク 関係を制限するリンク コントロールを定義する」および「LinksControlOptions」を参照してください。

ストーリーボード コントロールを追加する

を使用StoryboardsControlして作業項目PowerPointストーリーボードを開き、ネットワーク共有に保存されたストーリーボード ファイルにリンクします。 次の図に示すように、このコントロールは、通常それ自体のタブ グループに含まれています。

を セクションに追加 StoryboardsControl するには FORM 、次のコード スニペットを追加します。

<Tab Label="Storyboards">
     <Control Name="StoryboardsControl" Type="LinksControl">
        <LinksControlOptions>
           <WorkItemLinkFilters FilterType="excludeAll" />
           <ExternalLinkFilters FilterType="include">
              <Filter LinkType="Storyboard" />
           </ExternalLinkFilters>
           <LinkColumns>
              <LinkColumn RefName="System.Title" />
              <LinkColumn LinkAttribute="System.Links.Comment" />
           </LinkColumns>
        </LinksControlOptions>
     </Control>
  </Tab>

領域パスとイテレーション パスを追加する (TreePath コントロール)

型を使用して WorkItemClassificationControl 、データ型が であるフィールドを追加します TreePath。 このコントロールを使用した場合、区分パス フィールドおよびイテレーション パス フィールドを階層型ツリー形式で表示できます。 ツリーで表示される階層ノードは、展開および縮小できます。

<Control Type="WorkItemClassificationControl" FieldName="System.AreaPath" Label="Area"LabelPosition="Left" />  

Note

を使用して、 WorkItemClassificationControl フィールドと フィールドを System.AreaPath 表示 System.IterationPath できます。 このコントロールを使用して、他のデータ型のフィールドまたはカスタム フィールドを表示することはできません。

履歴コントロールを追加する

次の図に WorkItemLogControl 示すように、 を使用して、ディスカッション スレッドや他の履歴情報を追跡する [履歴] フィールドのコントロール フィールドを指定します。

このコントロールは、作業項目の History フィールドである System.History 作業項目フィールドの表示をサポートする場合にのみ使用できます。 このコントロールを使用すると、作業項目の履歴情報を展開および縮小できます。 History フィールドに追加するテキストの書式を設定することもできます。

<Control Type="WorkItemLogControl" FieldName="System.History" Label="Detailed Description and History" LabelPosition="Top" Dock="Fill" />

添付ファイル コントロールを追加する

を使用 AttachmentsControl して、作業項目フォームにファイルを添付します。 次の図に示すように、このコントロールは、通常それ自体のタブ グループに含まれています。

詳細については、「添付ファイル コントロール の追加」を参照してください。

関連記事

提供されている組み込みコントロールに加えて、Marketplace から使用できる追加の。 または、独自のコントロールを作成できます。 「 作業項目フォームを拡張する」を参照してください。

• Control XML 要素のリファレンス
• WebLayout 要素と Control 要素
• 作業項目フォームのレイアウトの修正
• 作業項目フォームに Web コンテンツを追加するための WIT 定義の編集
• ヘルプ テキスト、ハイパーリンク、または Web コンテンツの提供
• リンク 関係を制限するリンク コントロールを定義する
• 添付ファイル コントロールの追加

フィールドにラベルを付けてフォーム上の 2 か所にフィールドを追加する

フォーム コントロールごとに、 属性と 属性を使用して、省略可能なラベルとラベルの位置を Label 指定 LabelPosition できます。 ラベルには、 要素によって割り当てられた表示名とは異なる名前を指定 FIELD できます。 ラベルを指定しなかった場合、表示名が使用されます。 チーム メンバーがクエリを実行して作業項目を検索するときは、必ず表示名が使用される点に注意してください。 ラベルの最大サイズは 80 文字です。

Note

同じグループ内で定義されている各コントロールに対しては、同じラベル位置を定義する必要があります。

フォームの上部 Name やタブなど、フォームの複数の領域にフィールドを追加する場合は、 属性を使用します。 属性 Name は、フォームに追加される他のコントロールとは異なるコントロールとしてコントロールを識別します。

フィールドを読み取り専用にする

フィールドを読み取り専用にする方法は 2 とおりあります。 最初のメソッドでは、型定義 READONLYFIELDFIELDS の セクションの 要素に子として 要素を追加します。 要素を使用 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" />  

すべての種類のコントロールに対するオプションのコントロール要素のフィールド属性

次のオプションの属性は、一覧に示されているコントロールの種類に対してのみ指定できます。

Note

各データ入力フィールドの全体的なサイズは、(a) そのフィールドに設定されている属性値、(b) コンテナーのサイズ、(c) フォーム上の他のフィールドに割り当てられている領域、の 3 要素によって決まります。 最小サイズを指定しなかった場合、既定値に設定されます。 ただし、フォーム上の他のフィールドに設定されている属性が、フィールド サイズに影響を及ぼすことがあります。 列数、および、各列の最大サイズのフィールドに割り当てた横幅によって、フォームの横幅が決まります。 また、縦グループで指定したフィールド数、および、各フィールドに割り当てた縦幅によって、フォームの上端および下端のサイズが決まります。

属性	説明
Field	作業項目フィールドに関連付けるコントロールを指定します。
Label	コントロールを識別する、フォーム上に表示されるテキストを指定します。 80 文字以下の文字列を指定します。 メモ： を使用して、作業項目フォームに追加されるフィールドのラベルにハイパーリンクをアタッチできます 。 このコントロールは、フィールドの使用方法に関する情報へのリンクを提供する場合に便利です。 詳細については、「ヘルプ テキスト、 ハイパーリンク、または Web コンテンツを提供する」を参照してください。
LabelPosition	コントロールのデータに対するラベルの相対位置を指定します。 、、、および のいずれかの値 Topから文字列 Bottomを Left指定します Right。
Dock	コンテナー内の指定した辺のラベルのアラインメントを指定します。または、コンテナーの全面にフィールドを拡張します。 、、、、および のいずれかのFillTop値から文字列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 に識別するには、両方のコントロール エントリに対して 属性に一意の値を指定します。 これは、タブのコンテキストに基づいて同じコントロールをさまざまな場所に表示する場合に役立ちます。

特定の種類のコントロールに対するオプションのコントロール要素のフィールド属性

次のオプションの属性は、一覧に示されているコントロールの種類に対してのみ指定できます。

属性	コントロールの種類	説明
NumberFormat	FieldControl	フィールド コントロールに入力できる文字を指定します。 有効な値は、WholeNumbersSignedWholeNumbers、DecimalNumbersおよび ですSignedDecimalNumbers。
MaxLength	FieldControl	フィールド コントロールに使用できる最大文字数を指定します。
Format	DateTimeControl	日時フィールドの形式を指定します。この形式は、DateTimePickerFormat 列挙型の値の 1 つに対応します。 有効な値は、CustomLong、 ShortですTime。
CustomFormat	DateTimeControl	DateTimePicker.CustomFormat プロパティに定義されている構文に対応する日時フィールドのカスタム形式を指定します。