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


Элементы LinksControlOptions

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

  • WorkItemLinkFilters: используется для ограничения типов связей между рабочими элементами текущего командного проекта.

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

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

В каждом из этих элементов можно указать элементы Filter для задания типов связи или типов рабочих элементов, которые требуется включить или исключить. Дополнительные сведения об использовании этих элементов см. в разделе Определение элементов управления Link для ограничения ссылочных отношений.

Элемент LinksControlOptions является дочерним для элемента CONTROL.

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

WITD

   WORKITEMTYPE

       FORM

           Макет

               Группа

               Столбец

               Вкладка

                     Control

<xs:element name="LinksControlOptions" type="LinksControlOptionsType" minOccurs="0"/>
<xs:element name="WorkItemLinkFilters" type="WorkItemLinkFiltersType" minOccurs="0" maxOccurs="1"/>
<xs:element name="Filter" type="WorkItemLinkFilterElementType" minOccurs="0" maxOccurs="unbounded"/>
<xs:element name="ExternalLinkFilters" type="ExternalLinkFiltersType" minOccurs="0" maxOccurs="1" />
<xs:element name="Filter" type="ExternalLinkFilterElementType" minOccurs="0" maxOccurs="unbounded"/>
<xs:element name="WorkItemTypeFilters"   type="LinksControlWorkItemTypeFiltersElementType" minOccurs="0" maxOccurs="1" />
<xs:element name="Filter" type="LinksControlWorkItemTypeFilterElementType" minOccurs="0" maxOccurs="unbounded"/>
<xs:element name="LinkColumns" type="LinkColumnsType" minOccurs="0" maxOccurs="1" />
<xs:element name="LinkColumn" type="LinkColumnType" minOccurs="1" maxOccurs="unbounded"/>

<LinksControlOptions>
   <WorkItemLinkFilters FilterType="include | exclude | includeAll | excludeAll">
       <Filter LinkType="linkTypeRefName" FilterOn="reverseName | forwardName" />
   </WorkItemLinkFilters>
   <ExternalLinkFilters FilterType ="include | exclude | includeAll | excludeAll">
       <Filter LinkType="externalLinkName"/>
   </ExternalLinkFilters>
   <WorkItemTypeFilters Scope=" project | all" FilterType=" include | exclude | includeAll" />
       <Filter WorkItemType="workItemTypeReferenceName"/>
   </WorkItemTypeFilters>
   <LinkColumns>
      <LinkColumn RefName="reference name" | LinkAttribute="link attribute name"/>
   </LinkColumns>
</LinksControlOptions>

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

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

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

Элемент

Атрибут

Описание

LinksControlOptions

 

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

Обеспечивает контейнер для элементов, определяющих параметры управления ссылками, добавляемыми в рабочий элемент, а также отображение столбцов со списком отношений ссылок в рабочем элементе, настраиваемых по умолчанию.

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

WorkItemLinkFilters

 

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

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

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

 

FilterType

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

Определяет метод, используемый для фильтрации набора типов связей, предоставленных в наборе элементов Filter. Тип элемента – это простой тип LinksControlFilterKind.

Допустимые типы, которые можно использовать:

  • exclude: используется для запрета создания ссылок из типов связей, перечисленных в элементах Filter.

  • excludeAll: используется для запрета всех типов связей.

  • include: используется для разрешения только типов связей, перечисленных в элементах Filter.

  • includeAll: используется для разрешения создания ссылок из всех типов связей.

Filter

 

Обязательный элемент WorkItemLinkFilters, если FilterType имеет значение exclude или include.

Если значение FilterType равно excludeAll или includeAll, элементы Filter не указываются.

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

 

LinkType

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

Задает ссылочное имя типа связи. Типом атрибута является typelib:ReferenceFieldName. Дополнительные сведения см. в разделе Работа с типами связей.

 

FilterOn

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

Задает тип фильтра, применяемого к типу связи. Тип элемента – это простой тип LinksControlFilterOnKind.

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

  • forwardName: используется для фильтрации по имени прямой связи, определенном для типа ссылки.

  • revserseName: используется для фильтрации по имени обратной связи, определенном для типа ссылки.

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

ПримечаниеПримечание
Если топология типа связи — сеть, имена прямой и обратной связи совпадают.Дополнительные сведения см. в разделе Работа с типами связей.

ExternalLinkFilters

 

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

Предоставляет контейнер для одного или нескольких элементов Filter, определяющие типы ссылок, которые пользователи могут указать, для создания связей с объектами, которые не являются рабочими элементами, такие как наборы изменений, гиперссылки и файлы, подпадающие под управление версиями. Тип элемента – это сложный тип: ExternalLinkFiltersType.

 

FilterType

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

Определяет метод, используемый для фильтрации списка типов связей, предоставленных в наборе элементов Filter. Тип элемента – это простой тип LinksControlFilterKind.

Можно использовать следующие значения:

  • exclude: используется для запрета создания ссылок из типов связей, перечисленных в элементах Filter.

  • excludeAll: используется для запрета всех типов связей.

  • include: используется для разрешения только типов связей, перечисленных в элементах Filter.

  • includeAll: используется для разрешения создания ссылок из всех типов связей.

Если этот атрибут не задан, исключаются все связи с внешними рабочими элементами.

Filter

 

Обязательный элемент ExternalLinkFilters, если FilterType имеет значение exclude или include.

Если значение FilterType равно excludeAll или includeAll, элементы Filter не указываются.

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

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

 

LinkType

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

Задает ссылочное имя включаемого или исключаемого типа связи. Тип атрибута – это простой тип ExternalLinkTypeName. Можно указать следующие типы связей:

  • "Исправлено в наборе изменений";

  • "Присоединение результата";

  • "Файл с исходным кодом";

  • "Результат теста";

  • "Гиперссылка на рабочий элемент".

WorkItemTypeFilters

 

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

Обеспечивает контейнер для одного или более элементов Filter, определяющих критерий фильтра, применяемого к типам рабочего элемента.

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

 

Scope

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

Определяет область фильтра, который применяется к набору типов рабочих элементов, предоставленных в наборе элементов Filter. Тип элемента – это простой тип LinksControlWorkItemTypeFilterScopeKind.

Допустимые типы, которые можно использовать:

  • all: используется для разрешения создания ссылок на все типы рабочих элементов, указанные в тегах Filter.

  • project: используется для разрешения создания ссылок только на те типы рабочих элементов, которые были заданы для текущего проекта.

Если этот параметр не указан, то разрешены ссылки на все типы рабочих элементов.

 

FilterType

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

Определяет метод, используемый для фильтрации набора типов рабочих элементов, предоставленных в наборе элементов Filter. Тип элемента – это простой тип LinksControlWorkItemTypeFilterKind.

Можно использовать следующие значения:

  • exclude: Используется для запрета типов рабочих элементов в элементах Filter.

  • excludeAll: используется для запрета всех типов рабочих элементов.

  • include: Использовать типы рабочих элементов в элементах Filter.

  • includeAll: используется для разрешения всех типов рабочих элементов.

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

Filter

 

Атрибут WorkItemTypeFilters необязателен, если значение FilterType равно exclude или include.

Если значение FilterType — excludeAll или includeAll, не следует указывать элементы Filter.

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

 

WorkItemType

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

Задает имя ссылки рабочего элемента для фильтрации. Тип атрибута: typelib:NonEmptyPlainConstant.

Минимальная длина: 1; максимальная длина: 255.

Значение шаблона: ^[^\\]*$

Пример значения шаблона: "Задача"

LinkColumns

 

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

Обеспечивает контейнер для одного или более элементов LinkColumn. Тип элемента – это сложный тип: LinkColumnsType.

LinkColumn

 

Обязательный элемент LinkColumns.

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

Этот список столбцов отображается по умолчанию. Пользователь может добавлять и удалять столбцы из списка ссылок.

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

 

RefName

Необязательный атрибут элемента LinkColumn. Укажите RefName или LinkAttribute, но не оба.

Задает имя ссылки, соответствующее допустимому полю рабочего элемента для коллекции командных проектов. Типом атрибута является typelib:ReferenceFieldName.

 

LinkAttribute

Необязательный атрибут элемента LinkColumn. Укажите RefName или LinkAttribute, но не оба.

Задает имя ссылки, соответствующее любому атрибуту допустимого типа связи для коллекции командных проектов. Типом атрибута является typelib:ReferenceFieldName.

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

Элемент

Описание

Control

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

Заметки

LinksControlOptions — необязательный потомок элемента Control, где ControlType="LinksControl". Элемент LinksControlOptions можно использовать для поддержки следующих действий.

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

  • Укажите ограничения, которые управляют созданием связей с объектами, не являющимися рабочими элементами, такие как набор изменений, гиперссылки и т. д, на основе типов внешних ссылок.

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

  • Укажите поля столбца по умолчанию, которые требуются для отображения списка ссылок.

Пример

В следующем примере указывается, как включить создание ссылок с типом связи Microsoft.VSTS.Common.TestedBy и отобразить Forward Name для этого типа связи. Параметры фильтра запрещают создание ссылки на все типы внешних связей. Кроме того, отображаемые поля столбцов по умолчанию для приведенных ссылок соответствуют следующим понятным именам полей, заданным для ссылки: "Идентификатор", "Тип рабочего элемента", "Заголовок", "Назначено", "Состояние" и "Примечания". Дополнительные примеры см. в разделе Определение элементов управления Link для ограничения ссылочных отношений.

<CONTROL Type="LinksControl" Name="TestedBy" Label="&amp;Work items testing this bug:" LabelPosition="Top">
   <LinksControlOptions>
      <WorkItemLinkFilters FilterType="include">
         <Filter LinkType="Microsoft.VSTS.Common.TestedBy" FilterOn="forwardname" />
      </WorkItemLinkFilters>
      <WorkItemTypeFilters FilterType="include">
          <Filter WorkItemType="Test Case" />
      </WorkItemTypeFilters>
          <ExternalLinkFilters FilterType="excludeAll"/>
      <LinkColumns>
          <LinkColumn RefName="System.ID" />
          <LinkColumn RefName="System.WorkItemType" />
          <LinkColumn RefName="System.Title" />
          <LinkColumn RefName="System.AssignedTo" />
          <LinkColumn RefName="System.State" />
          <LinkColumn LinkAttribute="System.Links.Comment" />
      </LinkColumns>
   </LinksControlOptions>
</CONTROL>

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

  • LinksControlOptionsType

  • WorkItemLinkFiltersType

  • WorkItemLinkFilterElementType

  • ExternalLinkFiltersType

  • ExternalLinkFilterElementType

  • LinksControlFilterKind

  • LinksControlFilterOnKind

  • ExternalLinkTypeName

  • LinksControlWorkItemTypeFiltersElementType

  • LinksControlWorkItemTypeFilterElementType

  • LinksControlWorkItemTypeFilterScopeKind

  • LinksControlWorkItemTypeFilterKind

  • LinkColumnsType

  • LinkColumnType

LinksControlOptionsType

<xs:complexType name="LinksControlOptionsType">
   <xs:all>
      <xs:element name="LinkColumns" type="LinkColumnsType" minOccurs="0" maxOccurs="1" />
      <xs:element name="WorkItemLinkFilters" type="WorkItemLinkFiltersType" minOccurs="0" maxOccurs="1"/>
      <xs:element name="ExternalLinkFilters" type="ExternalLinkFiltersType" minOccurs="0" maxOccurs="1" />
      <xs:element name="WorkItemTypeFilters" type="LinksControlWorkItemTypeFiltersElementType" minOccurs="0" maxOccurs="1" />
   </xs:all>
</xs:complexType>

WorkItemLinkFiltersType

<xs:complexType name="WorkItemLinkFiltersType" >
   <xs:sequence>
      <xs:element name="Filter" type="WorkItemLinkFilterElementType" minOccurs="0" maxOccurs="unbounded"/>
   </xs:sequence>
      <xs:attribute name="FilterType" type="LinksControlFilterKind" use="required" />
</xs:complexType>

WorkItemLinkFilterElementType

<xs:complexType name="WorkItemLinkFilterElementType" >
   <xs:attribute name="LinkType" type="typelib:ReferenceFieldName" use="required" />
   <xs:attribute name="FilterOn" type="LinksControlFilterOnKind" use="optional" />
</xs:complexType>

ExternalLinkFiltersType

<xs:complexType name="ExternalLinkFiltersType" >
   <xs:sequence>
      <xs:element name="Filter" type="ExternalLinkFilterElementType" minOccurs="0" maxOccurs="unbounded"/>
   </xs:sequence>
      <xs:attribute name="FilterType" type="LinksControlFilterKind" use="required" />
</xs:complexType>

ExternalLinkFilterElementType

<xs:complexType name="ExternalLinkFilterElementType" >
   <xs:attribute name="LinkType" type="ExternalLinkTypeName" use="required" />
</xs:complexType>

LinksControlFilterKind

<xs:simpleType name="LinksControlFilterKind">
   <xs:restriction base="xs:string">
      <xs:enumeration value="include" />
      <xs:enumeration value="exclude" />
      <xs:enumeration value="includeAll" />
      <xs:enumeration value="excludeAll" />
   </xs:restriction>
</xs:simpleType>

LinksControlFilterOnKind

<xs:simpleType name="LinksControlFilterOnKind">
   <xs:restriction base="xs:string">
      <xs:enumeration value="forwardname" />
      <xs:enumeration value="reversename" />
   </xs:restriction>
</xs:simpleType>

ExternalLinkTypeName

<xs:simpleType name="ExternalLinkTypeName">
   <xs:restriction base="xs:string">
      <xs:minLength value="1"/>
      <xs:maxLength value="128"/>
   </xs:restriction>
</xs:simpleType>

LinksControlWorkItemTypeFiltersElementType

<xs:complexType name="LinksControlWorkItemTypeFiltersElementType" >
   <xs:sequence>
      <xs:element name="Filter" type="LinksControlWorkItemTypeFilterElementType" minOccurs="0" maxOccurs="unbounded"/>
   </xs:sequence>
      <xs:attribute name="Scope" type="LinksControlWorkItemTypeFilterScopeKind" use="optional" />
      <xs:attribute name="FilterType" type="LinksControlWorkItemTypeFilterKind" use="required" />
</xs:complexType>

LinksControlWorkItemTypeFilterElementType

<xs:complexType name="LinksControlWorkItemTypeFilterElementType" >
   <xs:attribute name="WorkItemType" type="typelib:NonEmptyPlainConstant" use="required" />
</xs:complexType>

LinksControlWorkItemTypeFilterScopeKind

<xs:simpleType name="LinksControlWorkItemTypeFilterScopeKind">
   <xs:restriction base="xs:string">
   <xs:enumeration value="project" />
   <xs:enumeration value="all" />
</xs:restriction>
</xs:simpleType>

LinksControlWorkItemTypeFilterKind

<xs:simpleType name="LinksControlWorkItemTypeFilterKind">
   <xs:restriction base="xs:string">
      <xs:enumeration value="include" />
      <xs:enumeration value="exclude" />
      <xs:enumeration value="includeAll" />
   </xs:restriction>
</xs:simpleType>

LinkColumnsType

<xs:complexType name="LinkColumnsType" >
   <xs:sequence>
      <xs:element name="LinkColumn" type="LinkColumnType" minOccurs="1" maxOccurs="unbounded"/>
   </xs:sequence>
</xs:complexType>

LinkColumnType

<xs:complexType name="LinkColumnType" >
   <!-- Must be one or the other, but not both -->
      <xs:attribute name="LinkAttribute" type="typelib:ReferenceFieldName" use="optional" />
      <xs:attribute name="RefName" type="typelib:ReferenceFieldName" use="optional" />
</xs:complexType>

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

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

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

Имя схемы

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

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

WorkItemTypeDefinition.xsd

Тип элемента

LinksControlOptionsType

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

Неприменимо

См. также

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

Работа с типами связей

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

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

Настройка отношений между рабочими элементами посредством типов связей

Определение элементов управления Link для ограничения ссылочных отношений

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

Дата

Журнал

Причина

Май 2011

Исправлен случай с несколькими XML-элементами. Определение схемы для отслеживания рабочих элементов определяет все дочерние элементы элемента FORM в "верблюжем" (CaMel) стиле, а все остальные элементы — прописными буквами.

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

Январь 2011

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

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

Июль 2010

Добавлен полный список имен ссылок, которые можно использовать с элементом ExternalLinkFilters.

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

Июнь 2010

Исправлено описание элементов ExternalLinkFilters WorkItemTypeFilters.

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