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

Справка по XML-элементам Link и Param

  • Статья

С помощью элемента Link к полю или отдельной подписи в рабочем элементе можно добавить гиперссылку. Элемент Link используется в следующих экземплярах:

  • Добавить гиперссылку в метку поля

  • Добавить гиперссылку в автономную метку или в части информационного текста

  • Укажите URL-адрес для содержимого, которое будет отображаться в форме рабочего элемента

Элемент Link является дочерним для элемента Control или дочерним для элемента WebpageControlTarget или WebpageControlOptions. Дополнительные сведения об этих элементах см. в разделах Справка по XML-элементу Control и Справка по XML-элементам WebpageControlOptions.

Иерархия схемы

WITD

   WORKITEMTYPE

       FORM

           Макет

               Группа

               Столбец

               Вкладка

                     Control

<xs:element name="Link" type="HyperLinkType" minOccurs="0" maxOccurs="1" />
<xs:element name="Param" type="HyperLinkParamType" minOccurs="0" maxOccurs="unbounded"/>

<LINK URLRoot="URLRoot" URLPath ="URLPathWithParameters">
   <Param index="IndexValue " value="ParamValue " type ="Original | Current"/>
</LINK>

Атрибуты и элементы

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

Дочерние элементы и атрибуты

Элемент

Атрибут

Описание

Link

 

Необязательный элемент Control при type="FieldControl".

Необязательный элемент LabelText.

Необязательный элемент Text.

Необязательный элемент WebpageControlOptions.

Элемент контейнера для определения гиперссылки или URL-адреса. Тип элемента – это сложный тип: HyperLinkType.

 

UrlRoot

Обязательный атрибут элемента Link.

Указывает протокол и имя сервера URL-адреса, с которым связана метка. Поддерживаемые протоколы – HTTP, HTTPS и MAILTO.

Можно либо жестко кодировать указанное имя сервера, либо использовать один из следующих макросов и при необходимости добавить в макрос дополнительные сведения об адресе:

ПримечаниеПримечание
Каждый маркер связан с URL-адресом, который определен и включен для командного проекта формы рабочего элемента, для которой определен элемент Link.Если какие-либо ресурсы не подготовлены или не включена для командного проекта, появится ошибка «страница не найдена».

  • @PortalPage: URL-адрес сайта SharePoint для текущего командного проекта (например, http://имя_сервера/sites/имя_коллекции/имя_командного_проекта).

  • @ProcessGuidanceUrl: URL-адрес сайта SharePoint для руководства по процессу для командного проекта.

  • @ReportManagerUrl: URL-адрес сервера, на котором располагается диспетчер отчетов для текущего командного проекта. Предоставляет ссылку на представления папок для отчетов (например, https://serverName/Reports/Pages/Folder.aspx?ItemPath=/collectionName/teamProjectName).

  • @ReportServiceSiteUrl: URL-адрес сервера, на котором размещены службы отчетов SQL Server для текущего командного проекта и базовый путь для командного проекта (например, http://имя_сервера/Reports/Pages/reportservice.asmx?ItemPath=/имя_коллекци/имя_командного_проекта).

Чтобы определить жестко закодированное значение для первых двух макросов, можно открыть параметры портала проекта для командного проекта. Дополнительные сведения см. в разделе Доступ к порталу командного проекта и руководству по процессам.

Тип атрибута – это простой тип NonBlankString.

 

UrlPath

Необязательный атрибут элемента Link.

Указывает URL-путь для гиперссылки. Этот атрибут используется для указания параметров переменной, которые определяются во время выполнения. Тип атрибута – это простой тип NonBlankString.

Param

 

Необязательный элемент Link. Требуется, если указан UrlPath.

Задает значение, которое используется для определения URL-адреса гиперссылки, если для элемента задано значение UrlPath.

Тип элемента – это сложный тип: HyperLinkParamType.

 

index

Обязательный атрибут элемента Param.

Указывает индекс параметра, значение которого должно быть отформатировано в строку URL-адреса. Значения индекса не требуется упорядочивать, однако они должны соответствовать номеру индекса в строке URLPath.

Типом атрибута является PositiveInteger. Первый номер индекса должен быть 1.

 

value

Обязательный атрибут элемента Param.

Задает номер, связанный со значением для пути URL-адреса для гиперссылки.

Задает значение, которое должно быть отформатировано в строку URLPath. Значения должны быть допустимыми именами ссылок на поля, используемые в определении типа рабочего элемента.

Поддерживается переменная @Me. Она заменяется на имя текущего участника группы, просматривающего форму рабочего элемента. Записи значений нечувствительны к регистру

Типом атрибута является xs:string.

 

type

Необязательный атрибут элемента Param.

Указывает, что для этого параметра должно использоваться исходное значение поля. Тип атрибута – это простой тип HyperLinkParamValueKind.

Допустимы следующие значения:

  • Original: указывает, что для определения пути URL-адреса должно использоваться исходное значение параметра.

  • Current: указывает, что для определения пути URL-адреса должно использоваться текущее значение параметра.

Если этот атрибут не указан, в качестве параметра используется текущее значение поля

Родительские элементы

Элемент

Описание

Control

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

LabelText

Необязательный элемент Control.

Элемент контейнера для метки, отображаемой в форме рабочих элементов.

Text

Необязательный элемент LabelText.

Элемент контейнера для информации или метки, отображаемых в форме рабочего элемента.

WebpageControlOptions

Необязательный элемент Control.

Элемент контейнера, представляющий параметры для элемента управления веб-страницы.

Дополнительные сведения см. в разделе Displaying Web Content within a Work Item Form: WebpageControlOptions Elements.

Заметки

Поведение по умолчанию элемента LINK состоит в открытии гиперссылки в форме рабочего элемента или на веб-странице. Если гиперссылка разработана для открытия в новом окне (target="_blank"), то открывается внешний браузер.

Можно совмещать обычный текст и текст с гиперссылками, добавив несколько элементов TEXT в элемент LABELTEXT.

Элемент LABELTEXT распознается только клиентами, на которых работает последняя версия Сред. Командный обозреватель. Поэтому следует указать атрибут Label в элементе CONTROL, если задается дочерний элемент LINK. Для клиентов, работающих с последней версией Сред. Командный обозреватель, текст, предоставленный элементом LABELTEXT, отображается в форме рабочего элемента. Для клиентов, работающих с предыдущими версиями Сред. Командный обозреватель, текст, заданный атрибутом Label элемента CONTROL, отображается в форме рабочего элемента.

Пример. Указание гиперссылки с параметрами

Описание

В следующем примере показывается, как можно определить гиперссылку, которая связывается с инструкцией процесса для раздела "Итерация":

http://имя_сервера/sites/имя_коллекции/имя_проекта/render.aspx?wit=bug&amp;topic=Iteration

Имя проекта является производным от значения, присвоенного полю System.Project.

Код

<Link UrlRoot="https://serverName" UrlPath="sites/{0}/render.aspx?wit=bug&amp;topic=Iteration">
   <Param index="1 " value="System.Project"/>
</Link>

Пример. Добавление гиперссылки к автономной метке

Описание

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

Код

<Control type="LabelControl">
   <LabelText> 
      <Text>
         <Link UrlRoot="https://www.msn.com" />
      work item guidance
      </Text>
   </LabelText> 
</Control>

Пример. Добавление гиперссылки в поле

Описание

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

Код

<Control Type="FieldControl" FieldName="System.Title" LabelPosition="Left" Label="This text comes from the Label attribute:">
   <LabelText>
      <Text>
         <Link UrlRoot="http://www.live.com/" />
         This text comes from the inner Label Text
      </Text>
   </LabelText>
</Control>

Определения схем

  • HyperLinkType

  • NonBlankString

  • HyperLinkParamType

  • HyperLinkParamValueKind

Сложный тип: HyperLinkType

<xs:complexType name="HyperLinkType" >
   <xs:sequence>
      <xs:element name="Param" type="HyperLinkParamType" minOccurs="0" maxOccurs="unbounded"/>
   </xs:sequence>
   <xs:attribute name="UrlRoot"  type="NonBlankString" use="required" />
   <xs:attribute name="UrlPath"  type="NonBlankString" use="optional" />
</xs:complexType>

HyperLinkParamType

<xs:complexType name="HyperLinkParamType" >
   <xs:attribute name="Index"     type="PositiveInteger" use="required" />
   <xs:attribute name="Value"     type="xs:string" use="required" />
   <xs:attribute name="Type" type="HyperLinkParamValueKind" use="optional" />
</xs:complexType>

NonBlankString

<xs:simpleType name="NonBlankString">
   <xs:restriction  base="xs:string">
   <xs:pattern value=".*\S+.*"/>
   </xs:restriction>
</xs:simpleType>

HyperLinkParamValueKind

<xs:simpleType name="HyperLinkParamValueKind">
   <xs:restriction base="xs:string">
   <xs:enumeration value="Original"/>
   <xs:enumeration value="Current"/>
   </xs:restriction>
</xs:simpleType>

Сведения об элементе

Пространство имен

https://schemas.microsoft.com/VisualStudio/2008/workitemtracking/typedef

Имя схемы

Определение типа рабочего элемента

Файл проверки

WorkItemTypeDefinition.xsd

Тип элемента

HyperLinkType, HyperLinkParamType

Может быть пустым

Неприменимо

См. также

Основные понятия

Указание элементов управления на форме рабочего элемента

Проектирование и настройка формы рабочего элемента

Другие ресурсы

Elements (Work Item Type Definition Schema)

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

Дата

Журнал

Причина

Май 2011

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

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

Январь 2011

Удалены ссылки на удаленные разделы.

Улучшение информации.