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

Статья
06/09/2015

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

для добавления гиперссылки в метку поля;
для добавления гиперссылки в автономную метку или в части информационного текста;
для указания URL-адреса контента для отображения в форме рабочего элемента.

Чтобы добавить элементы в форму, измените определение типа рабочего элемента. См. раздел Изменение или добавление пользовательского типа рабочего элемента (WIT).

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

Схема иерархии

<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/ИмяКоллекции/ИмяКомандногоПроекта). @ProcessGuidance: URL-адрес сайта SharePoint для руководства по процессу для командного проекта. @ReportManagerUrl: URL-адрес сервера, на котором размещен диспетчер отчетов для текущего командного проекта. Этот атрибут предоставляет ссылку на представление папок для отчетов (например, http://ИмяСервера/Reports/Pages/Folder.aspx?ItemPath=/ИмяКоллекции/ИмяКомандногоПроекта). @ReportServiceSiteUrl: URL-адрес сервера, на котором размещены службы SQL Server Reporting Services для текущего командного проекта, а также базовый путь для командного проекта (например, http://ИмяСервера/Reports/Pages/reportservice.asmx?ItemPath=/ИмяКоллекции/ИмяКомандногоПроекта). Чтобы определить жестко закодированное значение для первых двух макросов, можно открыть параметры портала проекта для командного проекта. Для получения дополнительной информации см. Настройка или перенаправление руководства по процессу. Этот атрибут имеет простой тип NonBlankString.
	UrlPath	Необязательный атрибут элемента Link. Задает URL-адрес гиперссылки. Этот атрибут используется для указания переменных параметров, которые определяются во время выполнения. Этот атрибут имеет простой тип NonBlankString.
Param		Необязательный элемент Link. Требуется, если задан параметр UrlPath. Указывает значение, которое должно использоваться для определения URL-адреса гиперссылки, если указан параметр UrlPath. Этот элемент имеет сложный тип HyperLinkParamType.
	Index	Обязательный атрибут элемента Param. Указывает индекс параметра, где значение должно быть отформатировано в строку URL-адреса. Этот атрибут не требуется для упорядочивания значений индекса последовательно; однако эти значения должны соответствовать номеру индекса в строке URLPath. Тип атрибута —PositiveInteger. Первый номер индекса должен быть равен 0.
	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.

Заметки

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

Вы можете объединять обычный текст с текстом с гиперссылками, добавив несколько элементов Text в элемент LabelText.

Элемент LabelText распознается только клиентами, на которых работает последняя версия Team Explorer. Таким образом, вы должны указать атрибут Label в элементе Control при указании дочернего элемента Link. Для клиентов, на которых работает последняя версия Team Explorer, текст, предоставляемый элементом LabelText, отображается в форме рабочего элемента. Для клиентов, на которых работают предыдущие версии Team Explorer, текст, заданный атрибутом Label элемента Control, отображается в форме рабочего элемента.

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

Описание

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

http://ИмяСервера/sites/ИмяКоллекции/ИмяПроекта/render.aspx?wit=bug&topic=Iteration

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

Код

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

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

Описание

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

Код

<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
Может быть пустым	Неприменимо

См. также

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

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

Разработка формы рабочего элемента

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

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

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

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

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

Заметки

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

Описание

Код

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

Описание

Код

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

Описание

Код

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

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

HyperLinkParamType

NonBlankString

HyperLinkParamValueKind

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

См. также

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

Дополнительные ресурсы