WebpageControlOptions XML 元素引用
Azure DevOps Server 2020 |Azure DevOps Server 2019 |TFS 2018
可以使用元素在工作项窗体 WebpageControlOptions 上显示为网页或 CDATA 标记定义的内容。 可以包括 链接 或 内容 子元素，以指定要显示在窗体中的内容的 URL 或 HTML。
若要将元素添加到窗体，可以修改工作项类型。 请参阅 修改或添加自定义工作项类型。
该 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>
特性和元素
下列各节描述了特性、子元素和父元素。
子元素和特性
| 元素 | Attribute | 说明 |
|---|---|---|
WebpageControlOptions |
可选 Control 元素时 type="WebpageControl"。用于定义将在工作项窗体中呈现其内容的 URL 的容器元素。 可选 Link 元素。 指定时 UrlPath 是必需的。指定一个值，该值用于确定指定时 UrlPath 超链接的 URL。 |
|
AllowScript |
可选的 WebpageControlOptions 特性。指定是否允许网页中的 JavaScript 运行 () true () false 。 属性类型为 xs:boolean.所有其他设置（如 ActiveX）基于为客户端定义的 Internet Explorer 设置。 |
|
ReloadOnParamChange |
可选的 WebpageControlOptions 特性。指定在工作项窗体中的参数 () () 更改 true时，是否重新加载true网页 () false 内容。 属性类型为 xs:boolean.默认值是 true。 |
|
Link |
可选 WebpageControlOptions 元素。 此元素与 Content 元素互斥。指定要在工作项窗体中呈现的网页的 URL。 有关详细信息，请参阅 链接和参数。 |
|
Content |
可选 WebpageControlOptions 元素。此元素与 Link 元素互斥。指定要由网页控件呈现的 HTML 内容。 内容在 CDATA 标记中指定。 例如： <![CDATA[Click here for detailed <b><a href="https://www.microsoft.com">Process Guidance</a></b>]]>元素类型为 xs:string. 注意： 在工作项窗体中呈现 HTML 内容之前，不会对其进行验证。 |
父元素
| 元素 | 说明 |
|---|---|
| 控件 | 必需父元素。 定义要在工作项窗体上显示的字段、文本、超链接或其他控件元素。 |
| 文本 | 可选 LabelText 元素。要在工作项窗体上显示的信息或标签的容器元素。 有关详细信息，请参阅 LabelText 和 Text。 |
备注
元素LinkContent相互排斥。
AllowScript使用元素时不允许使用Content和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>