作業項目フォームでのヘルプ テキスト、ハイパーリンク、または Web コンテンツの提供
作業項目フォームをカスタマイズするときに、チームがフォームのフィールドを定義するのに役立つコンテンツへの情報やリンクを提供することができます。 フォームに情報を埋め込むか簡単に使用できるようにするなら、チームのメンバーは有用なデータを簡単に追跡できるようになります。
このトピックで説明されているフォーム コントロールを使用するなら、個々のフィールドのためのツールヒント テキスト、スタンドアロンのテキスト、またはハイパーリンクを Web ページに追加したり、HTML コンテンツまたは Web コンテンツをフォームに埋め込んだりできます。
作業項目フォームを変更するには、作業項目の種類の定義を変更します。 witadmin コマンド ライン ツールを使用することができます。「作業項目の種類のインポート、エクスポート、および管理 [witadmin]」またはプロセス エディターを参照してください。
プロセス エディターは Visual Studio のパワー ツールのアドインであり、ダウンロードしてインストールできます。 プロセス エディターは [ツール] メニューにあり、Team Foundation Server の作業項目の追跡に使用されるオブジェクトをカスタマイズするために使うグラフィカル ユーザー インターフェイスを提供します。 このツールを使用して、作業項目の種類をインポートおよびエクスポートしたり、定義を変更したりすることができます。 詳細については、Microsoft Web サイトのページ「Team Foundation Server Power Tools (Team Foundation Server パワー ツール)」を参照してください。
ヘルプ テキストまたはツールヒントのテキストの提供
次の 2 つの方法でヘルプ テキストを提供できます。 1 つ目の方法では、HELPTEXT 要素を、種類を定義する FIELD セクションの FIELDS 要素の子要素として追加します。 HELPTEXT を使用してフィールドのツールヒントを作成します。 この方法には 255 文字の制限があります。
<FIELD name="Sub-Title" refname="ACME.ACE.ImpactStatement" type="HTML" >
<HELPTEXT>Provide information about the impact to the ACE organization. </HELPTEXT>
</FIELD>
2 つ目の方法では、LabelText および Text 子要素を使用してスタンドアロン テキストを指定します。 この方法では、必要な量の情報を追加でき、テキストは常にフォームに表示されます。 ユーザー操作は必要ありません。 次の例に示すとおり、Link 要素を使用して他の情報を提供するオプションのリンクを追加することもできます。
<Control FieldName=" ACME.ACE.ImpactStatement" Type="HTMLControl" Label="Impact" LabelPosition="Left">
<LabelText>
<Text>Provide information about the impact to the ACE organization. Specifically address the following: customer segment, target strategic opportunity, resources required, and time dependencies. For more detailed information, see the Impact Statement specification at:
<Link OpenInNewWindow="true" UrlRoot=http://ACE.ImpactStatement.aspx />
</Text>
</LabelText>
</Control>
スタンドアロンのテキストおよびハイパーリンクのフィールド ラベルの追加
作業項目フィールドに関連付けられていないテキストを作業項目フォームに追加するには、Type 要素の LabelControl属性の Control オプションを使用します。 テキストは、プレーンテキストでもハイパーリンクでもかまいません。 また、FieldControl オプションを使用して、追加されたフィールド ラベルにハイパーリンクをアタッチすることもできます。
例: プレーン テキスト ラベル
次の例では、プレーン テキストで "Fill in the details of the bug here. Fields that are not required are recommended to be filled in." という文面を作業項目フィールドに追加します。
<Control Type="LabelControl" Label="Fill in the details of the bug here. Fields that are not required are recommended to be filled in." />
例: ハイパーリンク フィールド ラベル
次の例では、フィールド ラベルにハイパーリンクを追加する方法を示します。
<Control Type="FieldControl" FieldName="System.Title" LabelPosition="Left" Label="Title 1"
<LabelText>
<Text>
<Link UrlRoot="http://www.live.com/" />
Title 2
</Text>
</LabelText>
</Control>
注意
最新のバージョンにアップグレードしていない Team Foundation クライアントの場合、Label 属性のテキストが表示されます。Visual Studio 2012 クライアントの場合、テキスト タグは URL が Link タグによって定義されるハイパーリンクとして表示されます。
例: 一部のテキストがハイパーリンクのフィールド ラベル
次の例では、フィールド ラベルの一部にハイパーリンクを追加する方法を示します。 この例では、URL は特定の作業項目に基づいて Param 要素に割り当てられた値によって決まります。
<Control Type="FieldControl" FieldName="System.IterationPath">
<LabelText LabelPosition="Left">
<Text>
<Link UrlRoot="@ProcessGuidance" UrlPath="{0}.html">
<Param Index="0" vValue"System.WorkItemType"/> </Link>
Iteration Path
</Text>
<Text> (must be 3 levels deep)</Text>
</LabelText>
</Control>
例: ハイパーリンク テキスト ラベル
ハイパーリンク テキスト ラベル
.png "スタンドアロン ラベルに適用したハイパーリンクの例")
次の例では、作業項目フォームに表示されているテキストにハイパーリンクを追加する方法を示します。
<Group>
<Column PercentWidth="100">
<!-- Standalone label control 2 -->
<Control Type="LabelControl" Label="How do I use this work item?">
<Link UrlRoot="http://www.live.com"></Link>
</Control>
</Column>
</Group>
例: 単一のラベルでのテキストとハイパーリンクの結合
単一のラベルでのテキストとハイパーリンクの結合
.png "テキストに適用した 2 つのハイパーリンクの例")
次の例では、2 つのハイパーリンクを作業項目フォームのラベルの各部分に追加する方法を示します。
<Group>
<Column PercentWidth="100">
<!-- Standalone label control 3 -->
<Control Type="LabelControl" Name="Microsoft.VSTS.Common.GuidanceLabel3">
<LabelText>
<Text>Click here for </Text>
<Text>
<Link UrlRoot="https://www.msn.com"></Link>
work item guidance</Text>
<Text> or here for </Text>
<Text>
<Link UrlRoot="http://www.msdn.com"></Link>
process guidance
</Text>
</LabelText>
</Control>
</Column>
</Group>
例: パラメーターで生成されたハイパーリンク フィールド ラベル
次の例では、開いている作業項目について評価されるパラメーター値から生成されたハイパーリンクをフィールド ラベルに追加する方法を示します。
<Control Type="FieldControl" FieldName="System.State" Label="&State:" LabelPosition="Left">
<Link OpenInNewWindow="true" UrlRoot="http://" UrlPath="myserver.com:8080/tfs/myproject/{0}/_workItems#_a=edit&id="> <Param Index="0" Value="System.State" Type ="Original"/>
</Link>
</Control>
Web コンテンツの表示
Type 属性の WebpageControl オプションを使用して、別の Web ページにリンクせずに、コントロールとして作業項目フォームに Web コンテンツを表示します。 この表示は、レポート、ダッシュボード、または他の HTML ベースのコンテンツの内容を見るチーム メンバーをサポートするためにメトリックを示すのに便利です。 コンテンツへのリンクを提供したり、生の HTML コンテンツを CDATA タグに埋め込んだりできます。
例: URI によって提供されるコンテンツの表示
次の例では、WebpageControlOptions および Link 要素を使用して Web ページへの URL を提供することにより、そのページのコンテンツを埋め込む方法を示しています。
<Tab Label="Web">
<Group>
<Column PercentWidth="100">
<Control Type="WebpageControl" Name="WssPortalPage" Label="WssPortalPage" LabelPosition="Top" >
< WebpageControlOptions AllowScript="true">
<Link UrlRoot="http://www.msdn.com" />
</WebpageControlOptions >
</Control>
</Column>
</Group>
</Tab>
例: CDATA タグに指定されたコンテンツの表示
次の例では、CDATA タグに含まれている HTML コンテンツを作業項目フォームに追加する方法を示しています。
<Control Type="WebpageControl">
<WebpageControlOptions>
<Content>
<![CDATA[Place HTML Formatted Content Here ]]
</Content>
</WebpageControlOptions >
</Control>
プロセス ガイダンスの埋め込み
作業項目フォームでプロセス ガイダンスを使用できるようにするには、ワークフローおよび作業項目の種類の使用に関する情報を含むタブを追加できます。 これは、Type 属性の WebpageControl オプションを使用して行えます。 このオプションでは、WebpageControlOptions および Content 子要素を使用して、豊富な書式設定のテキストやイメージをフォームに埋め込むためのサポートを提供します。
<FORM>
. . .
<TabGroup>
. . .
<Tab Label="Process Guidance">
<Group>
<Column PercentWidth="100">
<Control Type="WebpageControl">
<WebpageControlOptions >
<Content>
<![CDATA[Place HTML Formatted Process Guidance Content Here ]]>
</Content>
</WebpageControlOptions>
</Control>
</Column>
</Group>
</Tab>
. . .
</TabGroup>
. . .
</FORM>