Link および Param XML 要素のリファレンス
Link 要素を使用して、作業項目フォームのフィールドまたはスタンドアロン ラベルにハイパーリンクを追加できます。 次のインスタンスで Link 要素を次の目的で使用できます。
フィールド ラベルにハイパーリンクを追加する。
スタンドアロン ラベルまたは情報テキストの一部にハイパーリンクを追加する。
作業項目フォーム内に表示するコンテンツの URL を指定する。
要素をフォームに追加するには、作業項目の種類の定義を変更します。 「カスタム作業項目の種類 (WIT) の変更または追加」を参照してください。
Link 要素は、Control 要素の子要素か、WebpageControlTarget 要素または WebpageControlOptions 要素の子要素になります。 これらの要素の詳細については、「Control XML 要素のリファレンス」および「WebpageControlOptions XML 要素のリファレンス」を参照してください。
スキーマの階層
<Link URLRoot="URLRoot" URLPath ="URLPathWithParameters">
<Param Index="IndexValue " Value="ParamValue " Type ="Original | Current"/>
</Link>
属性および要素
以降のセクションでは、属性、子要素、および親要素について説明します。
子要素と属性
要素 |
属性 |
説明 |
|---|---|---|
Link |
|
Control の場合、type="FieldControl" 要素は省略可能です。 省略可能な LabelText 要素。 省略可能な Text 要素。 省略可能な WebpageControlOptions 要素。 ハイパーリンクまたは URL を定義するコンテナー要素。 要素型は、HyperLinkType 複合型です。 |
|
UrlRoot |
必須の Link 属性です。 ラベルがリンクされる URL のプロトコルおよびサーバー名を指定します。 サポートされるプロトコルは HTTP、HTTPS、および MAILTO です。 指定したサーバー名をハードコーディングするか、次のいずれかのマクロを使用することにより、必要に応じて付加的なアドレス情報をマクロに付加することができます。 注意 各マクロは、Link 要素が定義されている作業項目フォームのチーム プロジェクトに対して定義および有効化されている URL にリンクしています。いずれかのリソースがチーム プロジェクトに対してプロビジョニングまたは有効化されていない場合、「ページが見つかりません」エラーが表示されます。
最初の 2 つのマクロでハードコーディングされた値を調べるには、チーム プロジェクトのプロジェクト ポータル設定を開きます。 詳細については、「プロセス ガイダンスの構成またはリダイレクト」を参照してください。 属性型は、NonBlankString 単純型です。 |
|
UrlPath |
省略可能な Link 属性です。 ハイパーリンクの URL パスを指定します。 この属性を使用して、実行時に確認した可変パラメーターを指定します。 属性型は、NonBlankString 単純型です。 |
Param |
|
省略可能な Link 要素。 UrlPath を指定している場合は必須です。 UrlPath が指定されている場合にハイパーリンクの URL を確認するために使用する値を指定します。 要素型は、HyperLinkParamType 複合型です。 |
|
Index |
必須の Param 属性です。 値を URL 文字列の形式にする必要のあるパラメーターのインデックスを指定します。 インデックス値は順序どおりに並べる必要はありませんが、URLPath 文字列内のインデックスの番号と一致する必要があります。 属性型は PositiveInteger です。 最初のインデックス番号は 0 にする必要があります。 |
|
Value |
必須の Param 属性です。 ハイパーリンクの URL パスの値に関連付けられている番号を指定します。 URLPath 文字列の形式にする必要のある値を指定します。 値は、作業項目の種類の定義で使用されるフィールドの有効な参照名にする必要があります。 @Me 変数がサポートされます。 この変数は、作業項目フォームを表示している現在のチーム メンバーの名前に置き換えられます。 値のエントリの大文字と小文字は区別されません。 属性型は xs:string です。 |
|
Type |
省略可能な Param 属性です。 フィールドの元の値をパラメーターに使用する必要があることを指定します。 属性型は、HyperLinkParamValueKind 単純型です。 有効値は次のとおりです。
この属性を指定しない場合、フィールドの現在の値がパラメーターとして使用されます。 |
親要素
要素 |
説明 |
|---|---|
必須。 作業項目フォームに表示するフィールド、テキスト、ハイパーリンク、その他のコントロール要素を定義します。 |
|
省略可能な Control 要素。 作業項目フォームにラベルを表示するためのコンテナー要素。 |
|
省略可能な LabelText 要素。 作業項目フォームに情報またはラベルを表示するためのコンテナー要素。 |
|
省略可能な Control 要素。 Web ページ コントロールのオプションを指定するコンテナー要素。 詳細については、「作業項目フォーム内の Web コンテンツの表示」を参照してください。 |
解説
作業項目フォームまたは Web ページの中でハイパーリンクを開くというのが、Link 要素の既定の動作です。 ハイパーリンクが新しいウィンドウを開くように作成されている場合は (target="_blank")、外部のブラウザーが開きます。
Text 要素に複数の LabelText 要素を追加すると、プレーン テキストとハイパーリンク付きのテキストを組み合わせることができます。
LabelText 要素は、チーム エクスプローラー の最新バージョンを実行しているクライアントでのみ認識されます。 したがって、子 Label 要素を指定する場合は、Control 要素で Link 属性を指定する必要があります。 チーム エクスプローラー の最新バージョンを実行しているクライアントの場合は、LabelText 要素で指定されたテキストが作業項目フォームに表示されます。 チーム エクスプローラー の旧バージョンを実行しているクライアントの場合は、Control 要素の Label 属性で指定されたテキストが作業項目フォームに表示されます。
例: パラメーターを使用したハイパーリンクの指定
説明
次の例は、「Iteration」トピックのプロセス ガイダンスにリンクするハイパーリンクを定義する方法を示しています。
https://serverName/sites/collectionName/projectName/render.aspx?wit=bug&topic=Iteration
プロジェクトの名前は、System.Project フィールドに割り当てられた値から派生します。
コード
<Link UrlRoot="https://serverName" UrlPath="sites/{0}/render.aspx?wit=bug&topic=Iteration">
<Param Index="0" Value="System.Project" />
</Link>
例: スタンドアロン ラベルへのハイパーリンクの追加
説明
次の例は、作業項目フォームのテキスト "work item guidance" にハイパーリンクを割り当てる方法を示しています。
コード
<Control type="LabelControl">
<LabelText>
<Text>
<Link UrlRoot="https://www.msn.com" />
work item guidance
</Text>
</LabelText>
</Control>
例: フィールドへのハイパーリンクの追加
説明
次の例は、作業項目フォームのフィールドのラベルにハイパーリンクを追加する方法を示しています。
コード
<Control Type="FieldControl" FieldName="System.Title" LabelPosition="Left" Label="This text comes from the Label attribute:">
<LabelText>
<Text>
<Link UrlRoot="http://www.live.com/" />
This text comes from the inner Label Text
</Text>
</LabelText>
</Control>
スキーマ定義
HyperLinkType
NonBlankString
HyperLinkParamType
HyperLinkParamValueKind
複合型: HyperLinkType
<xs:complexType name="HyperLinkType" >
<xs:sequence>
<xs:element name="Param" type="HyperLinkParamType" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
<xs:attribute name="UrlRoot" type="NonBlankString" use="required" />
<xs:attribute name="UrlPath" type="NonBlankString" use="optional" />
</xs:complexType>
HyperLinkParamType
<xs:complexType name="HyperLinkParamType" >
<xs:attribute name="Index" type="PositiveInteger" use="required" />
<xs:attribute name="Value" type="xs:string" use="required" />
<xs:attribute name="Type" type="HyperLinkParamValueKind" use="optional" />
</xs:complexType>
NonBlankString
<xs:simpleType name="NonBlankString">
<xs:restriction base="xs:string">
<xs:pattern value=".*\S+.*"/>
</xs:restriction>
</xs:simpleType>
HyperLinkParamValueKind
<xs:simpleType name="HyperLinkParamValueKind">
<xs:restriction base="xs:string">
<xs:enumeration value="Original"/>
<xs:enumeration value="Current"/>
</xs:restriction>
</xs:simpleType>
要素情報
名前空間 |
https://schemas.microsoft.com/VisualStudio/2008/workitemtracking/typedef |
スキーマ名 |
作業項目の種類の定義 |
検証ファイル |
WorkItemTypeDefinition.xsd |
要素型 |
HyperLinkType, HyperLinkParamType |
空も使用できる |
利用不可 |