WebpageControlOptions XML 要素のリファレンス
WebpageControlOptions 要素を使用すると、Web ページまたは作業項目フォームの CDATA タグ内に定義されるコンテンツを表示できます。 内容がフォームに表示されるようにするには、子要素 Link または Content のいずれかを含めて URL または HTML を指定します。
フォームに要素を追加するには、作業項目の種類を変更します。 「カスタム作業項目の種類 (WIT) の変更または追加」を参照してください。
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>
属性および要素
以降のセクションでは、属性、子要素、および親要素について説明します。
子要素と属性
要素 |
属性 |
説明 |
|---|---|---|
WebpageControlOptions |
|
Control の場合、type="WebpageControl" 要素は省略可能です。 内容を作業項目フォームに表示する URL を定義するコンテナー要素。 省略可能な Link 要素。 UrlPath を指定している場合は必須です。 UrlPath が指定されている場合にハイパーリンクの URL を確認するために使用する値を指定します。 要素型は WebpageControlOptionsType 複合型です。 |
|
AllowScript |
省略可能な WebpageControlOptions 属性です。 Web ページ内での JavaScript の実行を許可する (true) か許可しない (false) かを指定します。 属性型は xs:boolean です。 ActiveX などの他のすべての設定は、クライアントで定義されている Internet Explorer の設定に基づきます。 |
|
ReloadOnParamChange |
省略可能な WebpageControlOptions 属性です。 作業項目フォーム内のパラメーターが変更されたとき (true)、または変更されていないとき (true) に、Web ページのコンテンツを再読み込み (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 です。 注意 HTML コンテンツは、作業項目フォームに表示する前に検証されません。 |
親要素
要素 |
説明 |
|---|---|
必須の親要素です。 作業項目フォームに表示するフィールド、テキスト、ハイパーリンク、その他のコントロール要素を定義します。 |
|
省略可能な LabelText 要素。 作業項目フォームに情報またはラベルを表示するためのコンテナー要素。 詳細については、「LabelText および Text XML 要素のリファレンス」を参照してください。 |
解説
Link 要素と Content 要素は同時に指定できません。
AllowScript 要素を使用する場合、属性 ReloadOnParamChange および Content は許可されません。
生 HTML を表示するために Web ページ コントロールを構成する場合、すべてのスクリプトは無効になります。 作業項目フォームが Visual Studio または Internet Explorer で表示される場合、クリックされるコンテンツ内のハイパーリンクはすべて Visual Studio Web ブラウザーで開きます。
複数のツールバー ボタンが、WebpageControl を含むタブの作業項目フォームに追加されます。 これらのオプションには、次の機能があります。
ナビゲーション
コンテンツの読み込みの停止とコンテンツの更新
コンテンツのホーム ページに戻る
新しいウィンドウまたは外部のブラウザーでコンテンツを開く
さらに、読み込む Web ページに信頼されていないコンテンツが含まれる場合、アイコンがブロックされ、ブロックされたアイコンが表示されます。
WebpageControlOptions 要素は、最新バージョンの チーム エクスプローラー を実行するクライアントによってのみ認識されます。 以前のバージョンでは、赤い領域が表示され、コントロールが見つからなかったことを示すメッセージが表示されます。 詳細については、「作業項目フォームでのヘルプ テキスト、ハイパーリンク、または 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 |
空も使用できる |
利用不可 |