编辑 WIT 定义以向工作项窗体添加 Web 内容

项目
03/19/2022

Azure DevOps Server 2020 | Azure DevOps Server 2019 | TFS 2018 - TFS 2013

可以通过导出类型定义 XML 文件并添加在节中，将 Web 内容或 HTML WebpageControl 内容添加到工作项 FORM 窗体。修改并导入 XML 文件之后，可以验证 Web 内容在更新的工作项类型中的显示。

可以采用以下方式之一来指定所显示的 Web 内容：

网页的 URL
在运行时根据为工作项定义的一个或多个字段值动态确定的 URL 路径
HTML 内容

有关用于将 Web 内容添加到工作项类型 (WIT) 的元素的语法结构的信息，请参阅网页ControlOptions 和 Link 和 Param。

更新 WIT 的 XML 定义

如果对 WIT 自定义很新，请注意以下事项：

若要自定义 WIT 的任何方面，需要更新 WIT 的 XML 定义。所有 WITD XML 元素参考中介绍了 WIT XML 定义
如果要自定义使用新工作项体验的 Web 窗体，需要引用 WebLayout 和 Control 元素
如果要自定义客户端窗体以用于Visual Studio，需要引用布局 XML 元素引用
按照自定义工作项跟踪 Web 窗体中概述的步骤序列操作。

导出并打开 WIT 定义文件

根据要执行的自定义的范围，执行以下步骤之一：

如果要修改单个项目的工作项类型：
1. 运行 witadmin exportwitd 以导出要修改的工作项类型的 XML 文件。有关详细信息，请参阅导入、导出和管理工作项类型。
2. 在Visual Studio，选择"文件"、"打开"和"文件"。
3. 在 "查找位置"下，移动到导出文件的位置。
如果要修改工作项类型以自定义进程模板：
1. 查找下载过程模板的位置。
2. 选择要更新的工作项类型 XML 文件，然后选择"打开 "。当系统提示你有关行尾时，单击"否 "。

向定义文件的 FORM 节添加 Web 内容

<TabGroup>找到 XML 文件的部分。请注意，链接 <Tab> 和文件附件等项都有元素，其中每个 <Tab> 元素都包含呈现 <Control> 相应控件的元素。
```
<Tab Label="Links">  
      <Control Type="LinksControl" />  
</Tab>  
<Tab Label="File Attachments">  
      <Control Type="AttachmentsControl" />  
</Tab>  
```

添加一 <Tab> 个新元素，该元素将包含要显示在工作项窗体中的 Web 或 HTML 内容。根据定义 Web <TabGroup> 内容时，将以下代码复制到文件的部分。

指定网页的 URL：

<Tab Label="Tab Label">  
      <Group>  
      <Column PercentWidth="100">  
         <Control Type="WebpageControl" Name="Webpage" Label=" Name of Web Page" LabelPosition="Top" >  
               <WebpageControlOptions AllowScript="false">  
               <Link UrlRoot="URL of Web Page" />  
               </WebpageControlOptions>  
         </Control>  
      </Column>  
      </Group>  
</Tab>

将"选项卡标签"和"网页 URL"替换为要显示在工作项窗体上的信息。

指定要运行时确定的动态 URL：

<Tab Label="Tab Label">  
      <Group>  
      <Column PercentWidth="100">  
         <Control Type="WebpageControl" Name="Webpage" Label=" Name of Web Page" LabelPosition="Top" >  
               <WebpageControlOptions AllowScript="false">  
               <Link UrlRoot="URL of Web Page" URLPath="URL path with parameters >  
      <Param Index="0" Value="Param Value 0"/>  
      <Param Index="1" Value="Param Value 1"/>  
      <Param Index="2" Value="Param Value 2"/>  
               </Link>  
               </WebpageControlOptions>  
         </Control>  
      </Column>  
      </Group>  
</Tab>

将 Tab 标签、 网页 URL、URL 路径替换为参数，将 参数值 1、2 和 3 替换为要显示在工作项窗体上的信息。

指定 HTML 内容：
```
<Tab Label="Tab Label">  
      <Group>  
      <Column PercentWidth="100">  
         <Control Type="WebpageControl">  
               <Content>  
               <![CDATA[HTML Content]]>  
               </Content>  
         </Control>  
      </Column>  
      </Group>  
</Tab>  
```
将 "选项卡 标签 " 和"HTML 内容"替换为要显示在工作项窗体上的信息。

注意

为获得最佳结果，每个 Control（控件）或 Group（组）应显示在一个 Column（列）中，即使该列跨越整个窗体宽度也应如此。相应地，每列应该显示在一个组中，即使该组没有可见的标签或边界也应如此。

保存对 XML 文件所做的更改。
使用 witadmin importwitd 将新工作项类型导入到单个项目。若要将工作项类型添加到进程模板，请参阅添加工作项的类型定义。

验证网页或 HTML 内容是否显示在窗体中

在团队资源管理器，打开包含修改的 WIT 定义的项目的工作项，然后选择"刷新 "。

此时将从服务器下载最新更新，包括你刚刚导入的更改。等待几秒钟，直到 "工作项" 节点刷新。仍在加载的节点显示"工作" 一词。
使用已修改的 WIT 创建工作项。

验证网页或 HTML 内容是否按预期显示在窗体中。
选择 " 关闭"以关闭新工作项。

编辑 WIT 定义以向工作项窗体添加 Web 内容

更新 WIT 的 XML 定义

导出并打开 WIT 定义文件

向定义文件的 FORM 节添加 Web 内容

验证网页或 HTML 内容是否显示在窗体中

相关文章