WebpageControlOptions XML 元素引用
可以使用 WebpageControlOptions 元素显示为网页定义的内容或工作项窗体上 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 特性。 指定是 (true) 否 (false) 允许网页中的 JavaScript 运行。 特性类型为 xs:boolean。 所有其他设置（如 ActiveX）基于为客户端定义的 Internet Explorer 设置。 |
|
ReloadOnParamChange |
可选的 WebpageControlOptions 特性。 指定是 (true) 否 (false) 在更改工作项窗体中的参数 (true) 时重新加载网页的内容。 特性类型为 xs:boolean。 默认值为 true。 |
Link |
|
可选的 WebpageControlOptions 元素。 此元素与 Content 元素互斥。 指定要在工作项窗体中呈现的网页的 URL。 有关详细信息，请参阅Link 和 Param XML 元素引用。 |
Content |
|
可选的 WebpageControlOptions 元素。 此元素与 Link 元素互斥。 指定要由网页控件呈现的 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 元素互斥。
使用 Content 元素时不允许使用 AllowScript 和 ReloadOnParamChange 特性。
网页控件配置为显示原始 HTML 时，将禁用所有脚本。 如果工作项窗体在 Visual Studio 或 Internet Explorer 中显示，则内容中单击的任何超链接都会在 Visual Studio Web 浏览器中打开。
多个工具栏按钮会添加到包含 WebpageControl 的选项卡的工作项窗体。 这些选项包括以下功能：
后退和前进导航
停止内容加载和刷新内容
返回到内容主页
在新窗口中或在外部浏览器中打开内容
此外，如果要加载的网页包含不受信任的内容，则会阻止图标，并且阻止的图标会显示。
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 |
可为空 |
不适用 |