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

Статья
11/18/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-адрес сервера, на котором размещен диспетчер отчетов для текущего командного проекта. Это ссылка на представление папки для отчетов (например, https://serverName/Reports/Pages/Folder.aspx?ItemPath=/ИмяКоллекции/ИмяКомандногоПроекта). @ReportServiceSiteUrl: URL-адрес сервера, на котором размещены Reporting Services SQL Server для текущего командного проекта, а также базовый путь для командного проекта (например, 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-адреса. Если этот атрибут не указан, в качестве параметра используется текущее значение поля.

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

Элемент	Описание
Управление	Обязательный. Определяет отображение в форме рабочего элемента поля, текста, гиперссылки или другого элемента управления.
LabelText	Необязательный элемент Control. Элемент контейнера для метки, отображаемой в форме рабочего элемента.
Текст	Необязательный элемент LabelText. Элемент контейнера для информации или метки, отображаемых в форме рабочего элемента.
WebpageControlOptions	Необязательный элемент Control. Элемент контейнера, представляющий параметры для элемента управления веб-страницы. Дополнительные сведения см. в разделе Отображение веб-содержимого в форме рабочего элемента.

Заметки

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

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

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

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

Описание

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

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

См. также

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

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

Design the work item form

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

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

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

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

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

Заметки

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

Описание

Код

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

Описание

Код

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

Описание

Код

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

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

HyperLinkParamType

NonBlankString

HyperLinkParamValueKind

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

См. также

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

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