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

Элементы LinksControlOptions

  • Статья

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

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

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

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

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

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

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

WITD

   WORKITEMTYPE

       ФОРМА

           Макет

               Группа

               Столбец

               Табуляция

                     Управление

<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.

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

  • Storyboard

  • System.LinkTypes.Dependency

  • System.LinkTypes.Hierarchy

  • System.LinkTypes.Related

Кроме того, вы можете указать ссылочные имена для пользовательских типов связей, определенных для коллекции командных проектов. Подробнее см. в разделе Справочник по элементам типов связей.

 

FilterOn

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

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

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

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

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

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

Примечание

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

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.

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

Элемент

Описание

Управление

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

Заметки

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

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

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

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

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

Пример

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

<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>

Кнопки панели инструментов LinksControl

Каждый элемент Control в Type=”LinksControl” предоставляет панель инструментов с кнопками, показанными на рисунке ниже.

Элементы управления панели инструментов для связывания в форме рабочего элемента

Эти кнопки становятся доступными только после выполнения определенного действия.

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

  • Кнопки для открытия списка рабочих элементов в запросе (Открыть в запросе) и в клиенте Microsoft Office (Открыть в Office) становятся доступными, только если хотя бы один рабочий элемент указан на вкладке управления связями.

  • Кнопки для открытия рабочего элемента (Открыть рабочий элемент), редактирования связи (Изменение связи) и удаления связи (Удаление связи) становятся доступными, только если щелкнуть один или несколько рабочих элементов, указанных на вкладке управления связями.

Элемент управления связями отображается одинаково в Team Web Access и Team Explorer, кроме случаев, когда он настроен на отображение только связей Storyboard. В этом случае панель инструментов содержит только элементы управления для добавления новой связи, открытия связанного элемента и удаления связи. Кроме того, в версии Team Web Access в меню управления есть ссылка Начать раскадровку.

Элемент управления "Связи раскадровки"

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

  • 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

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

Неприменимо

См. также

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

Справочник по элементам типов связей

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

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

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

Определение пользовательского типа связи