Предоставление текста справки, руководства по процессам, веб-содержимого и ссылок на веб-страницы на форме рабочего элемента

Статья
08/11/2011

Во время настройки формы рабочего элемента иногда имеет смысл разместить информацию или ссылки на содержимое, которые помогут команде разработчиков при определении полей в форме. Если информация легко доступна или внедрена в форму, членам команды будет легче отслеживать полезные данные.

С помощью элементов управления формы, описанных в данной теме, можно добавлять в форму текст подсказок для отдельных полей, отдельный текст, гиперссылки на веб-страницы, внедренное HTML-содержимое или веб-содержимое.

Содержание раздела

Предоставление текста справки или всплывающей подсказки
Добавление отдельных меток полей гиперссылки и текста
Отображение веб-содержимого
Внедрение руководства по процессу

Предоставление текста справки или всплывающей подсказки

Текст справки можно предоставить одним из двух способов. Первый способ заключается в добавлении элемента HELPTEXT в качестве дочернего элемента для элемента FIELD в разделе FIELDS определения типа. Можно создавать подсказку для поля с помощью HELPTEXT. Для этого способа существует ограничение в 255 символов.

<FIELD name="Sub-Title" refname="ACME.ACE.ImpactStatement" type="HTML" >
<HELPTEXT>Provide information about the impact to the ACE organization. </HELPTEXT>
</FIELD>

Второй способ заключается в задании отдельного текста с помощью дочерних элементов LabelText и Text. С помощью этого способа можно добавлять столько информации, сколько потребуется, и текст всегда будет отображаться на форме. Не требуется никаких действий пользователя. Также можно добавлять необязательную ссылку на дополнительную информацию с помощью Link, как показано в следующем примере.

<Control FieldName=" ACME.ACE.ImpactStatement" Type="HTMLControl" Label="Impact" LabelPosition="Left"> 
   <LabelText>
      <Text> Provide information about the impact to the ACE organization. Specifically address the following: customer segment, target strategic opportunity, resources required, and time dependencies. For more detailed information, see the Impact Statement specification at:
         <Link OpenInNewWindow="true" UrlRoot=http://ACE.ImpactStatement.aspx />
      </Text>
   </LabelText>
</Control>

Добавление отдельных меток полей гиперссылки и текста

С помощью атрибута Type параметра LabelControl элемента Control можно добавить текст в форму рабочего элемента, который не связан с каким-либо полем. Это может быть обычный текст или гиперссылка. Также с помощью параметра FieldControl можно присоединить гиперссылку к добавленной метке поля.

Пример. Метка в виде обычного текста

В следующем примере показано добавление обычного текста: "Введите сведения об ошибке. Необязательные поля рекомендуется заполнять." к полю рабочего элемента.

<Control Type="LabelControl" Label="Fill in the details of the bug here. Fields that are not required are recommended to be filled in." />

Пример. Метка поля в виде гиперссылки

В следующем примере показан способ добавления гиперссылки к метке поля.

<Control Type="FieldControl" FieldName="System.Title" LabelPosition="Left" Label="Title 1"
   <LabelText>
      <Text>
         <Link UrlRoot="http://www.live.com/" />
            Title 2
      </Text>
   </LabelText>
</Control>

Примечание

Для клиентов Team Foundation, которые не выполнили обновление до новой версии, отображается текст атрибута Label.Для клиентов Visual Studio 2010 тег Text отображается в виде гиперссылки с URL-адресом, который задается тегом Link.

Пример. Метка поля, часть текста которой представляет гиперссылку

В следующем примере показан способ добавления гиперссылки к части метки поля. В данном примере URL-адрес определяется значениями, которые назначены элементам Param в зависимости от рабочего элемента.

<Control Type="FieldControl" FieldName="System.IterationPath">
   <LabelText LabelPosition="Left">
      <Text>
         <Link UrlPath="http://{0}/sites/{1}/render.aspx?wit=bug&amp;topic=Iteration">
            <Param value="@Server"/>
            <Param value="System.Project"/>
         </Link>
            Iteration Path
      </Text>
      <Text> (must be 3 levels deep)</Text>
   </LabelText>
</Control>

Пример. Метка текстовой подписи в виде гиперссылки

Метка текстовой подписи в виде гиперссылки

Пример гиперссылки, применяемой к автономной метке

В следующем примере представлен порядок добавления гиперссылки к отображаемому тексту в форме рабочего элемента.

<Group>
   <Column PercentWidth="100">
      <!-- Standalone label control 2 -->
      <Control Type="LabelControl" Label="How do I use this work item?">
         <Link UrlRoot="http://www.live.com"></Link>
      </Control>
   </Column>
</Group>

Пример. Объединение текста и гиперссылок в одну метку

Объединение текста и гиперссылок в одну метку

Пример двух гиперссылок, применяемых к тексту

В следующем примере представлен порядок добавления двух гиперссылок к части метки на форме рабочего элемента.

<Group>
   <Column PercentWidth="100">
   <!-- Standalone label control 3 -->
      <Control Type="LabelControl" Name="Microsoft.VSTS.Common.GuidanceLabel3">
         <LabelText>
            <Text>Click here for </Text>
            <Text>
               <Link UrlRoot="https://www.msn.com"></Link>
               work item guidance</Text>
            <Text> or here for </Text>
            <Text>
               <Link UrlRoot="http://www.msdn.com"></Link>
               process guidance
            </Text>
         </LabelText>
      </Control>
   </Column>
</Group>

Пример. Созданная параметром метка поля гиперссылки

В следующем примере показан способ добавления гиперссылки к метке поля, которая создана на основании значений параметров открытого рабочего элемента.

<Control Type="FieldControl" FieldName="System.State" Label="&amp;State:" LabelPosition="Left">
   <Link OpenInNewWindow="true" URLRoot="http://{0}/sites/{1}/render.aspx?wit=bug&amp;state={2}">
      <Param value="@Server"/>
      <Param value="System.Project"/>
      <Param value="System.State" type ="original"/>
   </Link>
</Control>

Отображение веб-содержимого

Можно использовать атрибут Type параметра WebpageControl для отображения веб-содержимого в форме рабочего элемента в виде элемента управления вместо создания ссылки на отдельную веб-страницу. Такое отображение рекомендуется использовать для обеспечения метрик, которые позволяют членам команды видеть содержимое отчетов, панели мониторинга или другого HTML-содержимого. Можно указать ссылку на содержимое или внедрять исходное HTML-содержимое в CDATA-тег.

Пример. Отображение содержимого, на которое указывает универсальный код ресурса (URI)

В следующем примере показан способ внедрения содержимого с веб-страницы путем указания ее URL-адреса с помощью элементов WebpageControlOptions и LINK.

<Tab Label="Web">
   <Group>
      <Column PercentWidth="100">
         <Control Type="WebpageControl" Name="WssPortalPage" Label="WssPortalPage" LabelPosition="Top" Dock="Fill">
            < WebpageControlOptions AllowScript="false">
               <Link UrlRoot="http://www.msdn.com" />
            </WebpageControlOptions >
         </Control>
      </Column>
   </Group>
</Tab>

Пример. Отображение содержимого, на которое указывает CDATA-тег

В следующем примере показан способ добавления HTML-содержимого в форму рабочего элемента, которое содержится в теге CDATA.

<Control Type="WebpageControl">
   <WebpageControlOptions>
      <Content>
      <![CDATA[Place HTML Formatted Content Here ]]
   </Content>
   </WebpageControlOptions >
</CONTROL>

Внедрение руководства по процессу

Чтобы в форме рабочего элемента сделать доступным руководство по процессу, добавьте вкладку, содержащую информацию о рабочем процессе и использовании типа рабочего элемента. Это можно сделать с помощью атрибута Type параметра WebpageControl. Этот параметр обеспечивает поддержку внедрения текста с расширенным форматированием и изображений в форму с помощью дочерних элементов WebpageControlOptions и Content.

<FORM>
. . .
<TabGroup>
. . . 
   <Tab Label="Process Guidance">
      <Group>
         <Column PercentWidth="100">
            <Control Type="WebpageControl">
            <WebpageControlOptions >
            <Content>
               <![CDATA[Place HTML Formatted Process Guidance Content Here ]]>
            </Content>
            </WebpageControlOptions>
            </Control>
         </Column>
      </Group>
   </Tab>
. . .
</TabGroup>
. . .
</FORM>

См. также

Журнал изменений

Дата	Журнал	Причина
Май 2011	Исправлен регистр нескольких элементов и атрибутов в описании синтаксиса XML. Определение схемы для отслеживания рабочих элементов определяет все дочерние элементы элемента FORM в формате Camel, а все буквы в именах остальных элементов при этом должны быть прописными.	Исправление ошибки содержимого.

Май 2011

Исправлен регистр нескольких элементов и атрибутов в описании синтаксиса XML. Определение схемы для отслеживания рабочих элементов определяет все дочерние элементы элемента FORM в формате Camel, а все буквы в именах остальных элементов при этом должны быть прописными.

Исправление ошибки содержимого.

Поделиться через