作業項目フォーム上の Web ページへのヘルプ テキスト、プロセス ガイダンス、Web コンテンツ、およびリンクの追加

更新 : 2011 年 5 月

作業項目フォームをカスタマイズするときは、チームがフォーム内のフィールドを定義するのに役立てるため、コンテンツに情報またはリンクを設定できます。 情報をフォーム内に配置するか、利用しやすくすると、チーム メンバーは役立つデータを簡単に追跡できるようになります。

このトピックで説明しているフォーム コントロールを使用して、フィールドごとのツールヒント テキスト、スタンドアロン テキスト、Web ページへのハイパーリンク、埋め込みの HTML コンテンツ、Web コンテンツをフォームに追加できます。

このトピックの内容

• ヘルプ テキストまたはツール ヒント テキストの提供

• スタンドアロン テキストおよびハイパーリンク フィールドのラベルの追加

• Web コンテンツの表示

• プロセス ガイダンスの埋め込み

ヘルプ テキストまたはツール ヒント テキストの提供

ヘルプ テキストは、2 つの方法のいずれかで提供できます。 1 つ目の方法では、HELPTEXT 要素を、種類を定義する FIELDS セクションの FIELD 要素の子要素として追加します。 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>

スタンドアロン テキストおよびハイパーリンク フィールドのラベルの追加

Control 要素の Type 属性の LabelControl オプションを使用して、作業項目フィールドに関連付けられていない作業項目フォームにテキストを追加できます。 テキストは、プレーンテキストでもハイパーリンクでもかまいません。 また、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>

例: テキストの一部にハイパーリンクを含むフィールド ラベル

フィールド ラベルの一部にハイパーリンクを追加する方法を次の例に示します。 この例では、URL が、特定の作業項目に基づいて Param 要素に割り当てられてた値で決定されます。

<Control Type="FieldControl" FieldName="System.IterationPath">
   <LabelText LabelPosition="Left">
      <Text>
         <Link UrlPath="http://{0}/sites/{1}/render.aspx?wit=bug&amp;topic=Iteration">
            <Param value="@Server"/>
            <Param value="System.Project"/>
         </Link>
            Iteration Path
      </Text>
      <Text> (must be 3 levels deep)</Text>
   </LabelText>
</Control>

例: ハイパーリンクのテキスト ラベル

ハイパーリンクのテキスト ラベル

次の例では、作業項目フォームに表示されるテキストにハイパーリンクを追加する方法を示します。

<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>

例: 単一ラベル内でのテキストとハイパーリンクの結合

単一ラベル内でのテキストとハイパーリンクの結合

次の例では、作業項目フォームのラベルの一部に 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="&amp;State:" LabelPosition="Left">
   <Link OpenInNewWindow="true" URLRoot="http://{0}/sites/{1}/render.aspx?wit=bug&amp;state={2}">
      <Param value="@Server"/>
      <Param value="System.Project"/>
      <Param value="System.State" type ="original"/>
   </Link>
</Control>

Web コンテンツの表示

Type 属性の WebpageControl オプションを使用して、Web コンテンツを独立した Web ページへのリンクではなく、コントロールとして作業項目フォームに表示できます。 このコントロールは、チーム メンバーがレポート、ダッシュボード、またはその他の HTML ベースのコンテンツを表示するためのメトリクスを提供する場合に便利です。 コンテンツにリンクすることも、CDATA タグ内に生の HTML コンテンツを埋め込むこともできます。

例: URI で提供されたコンテンツの表示

次の例では、WebpageControlOptions 要素と LINK 要素を使用して、URL をそのページに指定することで、Web ページのコンテンツを埋め込む方法を示しています。

<Tab Label="Web">
   <Group>
      <Column PercentWidth="100">
         <Control Type="WebpageControl" Name="WssPortalPage" Label="WssPortalPage" LabelPosition="Top" Dock="Fill">
            < WebpageControlOptions AllowScript="false">
               <Link UrlRoot="http://www.msdn.com" />
            </WebpageControlOptions >
         </Control>
      </Column>
   </Group>
</Tab>

例: CDATA タグで提供されたコンテンツの表示

次の例では、HTML コンテンツを CDATA タグに格納された作業項目フォームに追加する方法を示しています。

<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>

参照

参照

Control XML 要素のリファレンス

FIELD (ワークフロー) 要素

概念

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

作業項目フォームのレイアウトのデザイン

プロジェクトの追跡データ、フォーム、ワークフロー、その他のオブジェクトのカスタマイズ

その他の技術情報

作業項目フィールドの表示の制御

履歴の変更