LabelText および Text XML 要素のリファレンス
LabelText 要素を使用して、作業項目フォームにスタンドアロン ラベルまたは情報テキストを追加できます。 ラベルは、どの作業項目フィールドにも関連付けられません。 必要に応じて、一部または全部のテキストにハイパーリンクを追加できます。
フォームに要素を追加するには、作業項目の種類を変更します。 「カスタム作業項目の種類 (WIT) の変更または追加」を参照してください。
LabelText 要素は、Control 要素の子要素です。
スキーマの階層
<LabelText> <Text> <Link OpenInNewWindow="true | false" UrlPath="URLLinkWithParameters"> <Param index="IndexValue " value="ParamValue " type ="Original | Current"/> </Link> LabelText </Text> </LabelText>
属性および要素
以降のセクションでは、属性、子要素、および親要素について説明します。
子要素と属性
要素 |
説明 |
|---|---|
LabelText |
type="LabelControl" の場合は Control 要素が必要です。 スタンドアロン ラベルまたは情報テキストのコンテナー要素。 要素型は LabelElementType 複合型です。 この要素は、Control 要素によって指定された Label 属性で指定した値を上書きします。 |
Text |
必須の LabelText 要素です。 作業項目フォームに情報またはラベルを表示するためのコンテナー要素。 Link 要素がラベル内で指定されている場合、要素内のテキストの部分にハイパーリンクが設定されます。 Link 要素が指定されていない場合、テキストはハイパーリンクなしで表示されます。 ラベルのテキストの異なる部分に、URL が異なる ハイパーリンクを設定できます。 複数のテキスト要素の値を続けて指定できます。 要素型は TextElementType 複合型です。 Text 要素が指定されていない場合、 Control 要素の Label 属性のテキストが作業項目フォームに表示されます。 |
Link |
省略可能な Text 要素。 作業項目フォームに表示される、フィールドまたはスタンドアロン ラベルに適用されるハイパーリンクのコンテナー要素。 要素型は HyperLinkType です。 注意 Link 子要素を指定する場合、Control 要素の Label 属性を指定する必要があります。 詳細については、「Link および Param XML 要素のリファレンス」を参照してください。 |
親要素
要素 |
説明 |
|---|---|
必ず指定します。 作業項目フォームに表示するフィールド、テキスト、ハイパーリンク、その他のコントロール要素を定義します。 |
解説
LabelText 要素に複数の Text 要素を追加すると、プレーン テキストとハイパーリンク付きのテキストを組み合わせることができます。
LabelText 要素は、チーム エクスプローラー の最新バージョンを実行しているクライアントでのみ認識されます。 したがって、Control 要素に Label 属性を指定する必要があります。 最新バージョンの チーム エクスプローラー を実行するクライアントでは、LabelText 要素によって指定されたテキストが作業項目フォームに表示されます。 以前のバージョンの チーム エクスプローラー を実行するクライアントでは、Control 要素の Label 属性によって指定されたテキストが作業項目フォームに表示されます。
例: スタンドアロン ラベル
説明
次の例では、作業項目フォームに「以下の空白にバグの再現方法の詳細を入力してください」というプレーン テキストが追加されます。
コード
<Control Type="LabelControl" Label=" Enter details about how to reproduce the bug in the space below:">
<LabelText>
<Text>Enter details about how to reproduce the bug in the space below:
</Text>
</LabelText>
</Control>
例: ハイパーリンク付きのスタンドアロン ラベル
説明
次の例では、作業項目フォームに「この作業項目の使用方法」というラベルが付いたハイパーリンクが追加されています。
コード
<Control Type="LabelControl" Label="How do I use this work item?">
<LabelText>
<Text>
<Link UrlRoot="http://www.live.com"></Link>
How do I use this work item?
</Text>
</LabelText>
</Control>
例: テキストの一部に適用されたハイパーリンク
説明
次の例では、作業項目フォームに 2 つの部分から成るラベルが追加されています。 最初の部分「イテレーション パス」はハイパーリンクと関連付けられています。 2 番目の部分「(3 段階にする必要あり)」は、プレーン テキストとして作業項目フォームに表示されます。
コード
<Control Type="FieldControl" FieldName="System.IterationPath" LabelPosition="Left">
<LabelText>
<Text>
<Link UrlRoot="@WssSiteUrl/render.aspx?wit=bug&topic=Iteration">
</Link>
Iteration Path
</Text>
<Text> (must be 3 levels deep)</Text>
</LabelText>
</Control>
スキーマ定義
要素: LabelText
<xs:element name="LabelText" type="LabelElementType" minOccurs="0" maxOccurs="1" />
<xs:element name="Text" type="TextElementType" minOccurs="1" maxOccurs="unbounded" />
複合型: LabelElementType
<xs:complexType name="LabelElementType">
<xs:sequence>
<xs:element name="Text" type="TextElementType" minOccurs="1" maxOccurs="unbounded" />
</xs:sequence>
</xs:complexType>
複合型: TextElementType
<xs:complexType name="TextElementType" mixed="true">
<xs:sequence>
<xs:element name="Link" type="HyperLinkType" minOccurs="0" maxOccurs="1" />
</xs:sequence>
</xs:complexType>