WebpageControlOptions XML 要素のリファレンス
WebpageControlOptions 要素を使用して、作業項目フォームに、Web ページまたは CDATA タグ内で定義されているコンテンツを表示できます。フォームに表示されるコンテンツの URL または HTML のどちらかを指定するために、Link 子要素または Content 子要素のどちらかを含めることができます。
WebpageControlOptions 要素は、CONTROL 要素の子要素です。
スキーマの階層
<WebpageControlOptions AllowScript="true | false" ReloadOnParamChange="true | false" >
<Link UrlRoot="UrlRoot" UrlPath="UrlPathWithParameters">
<Param Index="IndexValue " Value="Param Value " Type="Original | Current" />
</Link>
<Content>
<![CDATA[Contents of HTML]]>
</Content>
</WebpageControlOptions>
属性および要素
以降のセクションでは、属性、子要素、および親要素について説明します。
.gif "Dd936135.collapse_all(ja-jp,VS.110).gif")
子要素と属性
要素 |
属性 |
説明 |
|---|---|---|
WebpageControlOptions |
type="WebpageControl" の場合、Control 要素は省略可能です。 コンテンツが作業項目フォームにレンダリングされる URL を定義するためのコンテナー要素です。 省略可能な Link 要素。UrlPath を指定している場合は必須です。 UrlPath が指定されている場合にハイパーリンクの URL を確認するために使用する値を指定します。 要素型は WebpageControlOptionsType 複合型です。 |
|
AllowScript |
省略可能な WebpageControlOptions 属性です。 Web ページ内の JavaScript の実行を許可する場合は true を指定し、許可しない場合は false を指定します。属性型は xs:boolean です。 ActiveX などの他のすべての設定は、クライアントに定義されている Internet Explorer 設定に基づきます。 |
|
ReloadOnParamChange |
省略可能な WebpageControlOptions 属性です。 作業項目フォームのパラメーターが変更されたときに Web ページのコンテンツを再ロード (true) する場合は true を指定し、再ロードしない場合は false を指定します。属性型は xs:boolean です。 既定値は true です。 |
|
Link |
省略可能な WebpageControlOptions 要素。この要素は、Content 要素と同時には指定できません。 作業項目フォームにレンダリングされる Web ページの URL を指定します。 詳細については、「Link および Param XML 要素のリファレンス」を参照してください。 |
|
Content |
省略可能な WebpageControlOptions 要素。 この要素は、Link 要素と同時には指定できません。 Web ページ コントロールでレンダリングされる HTML コンテンツを指定します。コンテンツは CDATA タグ内で指定されます。次に例を示します。 <![CDATA[Click here for detailed <b><a href="http://www.microsoft.com">Process Guidance</a></b>]]> 要素の型は xs:string です。 .gif "メモ") メモ
HTML コンテンツは、作業項目フォームにレンダリングされる前に検証されません。
|
親要素
要素 |
説明 |
|---|---|
必須の親要素。作業項目フォームに表示するフィールド、テキスト、ハイパーリンク、その他のコントロール要素を定義します。 |
|
省略可能な LabelText 要素。 作業項目フォームに情報またはラベルを表示するためのコンテナー要素。 詳細については、「LabelText および Text XML 要素のリファレンス」を参照してください。 |
解説
Link 要素と Content 要素は同時には指定できません。
Content 要素を使用している場合、AllowScript 属性および ReloadOnParamChange 属性は使用できません。
Web ページが生の HTML を表示するように構成されている場合、すべてのスクリプトが無効になります。作業項目フォームが Visual Studio または Internet Explorer に表示されている場合、クリックされたコンテンツのハイパーリンクは、Visual Studio の Web ブラウザーに表示されます。
WebpageControl を含むタブでは、作業項目フォームにいくつかのツール バーのボタンが追加されます。これらのオプションには、次が含まれます。
戻る、および次に進むためのナビゲーション
コンテンツの読み込みの停止とコンテンツの再表示
コンテンツのホーム ページに戻る
新しいウィンドウまたは外部のブラウザー コンテンツを開く
また、読み込まれた Web ページに信頼されていないコンテンツが含まれている場合、アイコンがブロックされ、ブロックされたアイコンが表示されます。
WebpageControlOptions 要素は、チーム エクスプローラーの最新バージョンを実行しているクライアントでのみ認識されます。以前のバージョンの場合、赤い領域が表示され、コントロールが見つからないことを示すメッセージが表示されます。詳細については、「作業項目フォーム上の Web ページへのヘルプ テキスト、プロセス ガイダンス、Web コンテンツ、およびリンクの追加」を参照してください。
使用例
CDATA タグで定義された HTML を含む作業項目フォームを読み込む方法を次の例に示します。
<Control Type="WebpageControl">
<WebpageControlOptions>
<Content>
<![CDATA[Click here for detailed <b><a href="https://www.microsoft.com">Process Guidance</a></b>]]>
</Content>
</WebpageControlOptions>
</Control>
スキーマ定義
WebpageControlOptionsType
<xs:complexType name="WebpageControlOptionsType">
<xs:choice minOccurs="1" maxOccurs="1">
<xs:element name="Link" type="HyperLinkType"/>
<xs:element name="Content" type="xs:string"/>
</xs:choice>
<xs:attribute name="AllowScript" type="xs:boolean" use="optional" />
<xs:attribute name="ReloadOnParamChange" type="xs:boolean" use="optional" />
</xs:complexType>
NonBlankString
<xs:simpleType name="NonBlankString">
<xs:restriction base="xs:string">
<xs:pattern value=".*\S+.*"/>
</xs:restriction>
</xs:simpleType>
要素情報
名前空間 |
https://schemas.microsoft.com/VisualStudio/2008/workitemtracking/typedef |
スキーマ名 |
作業項目の種類の定義 |
検証ファイル |
WorkItemTypeDefinition.xsd |
要素の型 |
WebpageControlOptionsType |
空も使用できる |
該当なし |