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

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

  • Статья

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

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

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

Добавление полей рабочего элемента

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

Каждый рабочий элемент связан с определенным типом данных. Сведения в следующей таблице можно использовать для определения типа поля, который поддерживается атрибутом Type элемента Control. С помощью атрибута Label можно указать текст, отображаемый возле элемента управления. С помощью связанного атрибута LabelPosition можно указать, где располагается подпись относительно элемента управления. Подробнее см. в разделе Control the display of work item fields.

Примечание

Нельзя изменять значения системных полей, обновляемых вручную.Например, поля "Дата создания" и "Кем создано" определены при первом сохранении рабочего элемента.Однако эти поля можно использовать в условиях поиска.Описание каждого системного поля см. в разделе Справочник по полям рабочих элементов для Visual Studio ALM.

Тип поля

Атрибут Type элемента управления

Использование

DateTime

FieldControl

DateTimeControl

Используйте элемент управления с типом FieldControl для предоставления текстового поля ввода или для отображения поля с типом DateTime.

<Control FieldName=" MyCompany.Group1.StartDate " Type="FieldControl" Label="Start Date" LabelPosition="Left" />

Используйте элемент управления с типом DateTimeControl для предоставления полю календаря с выбором даты, как показано на следующем рисунке.

Поле календаря 
<Control Type="DateTimeControl" FieldName="MyCompany.Group.ScheduleStart" Label="Scheduling Start Date:" LabelPosition="Left" Dock="Fill" Format="Short" />

Double

FieldControl

Используйте элемент управления с типом FieldControl для предоставления текстового поля ввода или для отображения полей с типом Double.

<Control FieldName="ABC_Company.Statistics.Analysis" Type="FieldControl" Label="Analysis %" LabelPosition="Left" />

History

WorkItemLogControl

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

Вкладка и поле "Журнал" в форме рабочего элемента

Этот элемент управления можно использовать только для поддержки отображения поля журнала рабочего элемента (поле рабочего элемента System.History). С его помощью пользователь может разворачивать и сворачивать сведения о всех редакциях рабочего элемента. Также можно форматировать текст, добавляемый в поле журнала.

<Control Type="WorkItemLogControl" FieldName="System.History" Label="Detailed Description
and History" LabelPosition="Top" Dock="Fill" />

HTML

HTMLControl

Используйте элемент управления с типом HTMLControl для предоставления поля элемента управления для полей с типом HTML, чтобы захватывать текст RTF, как показано на следующем рисунке.

Поле HTML в форме рабочего элемента 
<Control Type="HtmlFieldControl" FieldName="Microsoft.VSTS.Notes" Label="Notes" Dock="Fill" />

Integer

FieldControl

Используйте элемент управления с типом FieldControl для предоставления поля элемента управления полям с типом Integer.

<Control FieldName="System.Id" Type="FieldControl" Label="Id" LabelPosition="Left" />

PlainText

FieldControl

Используйте элемент управления с типом FieldControl для предоставления поля элемента управления полям с типом PlainText, например, текстовому полю, которое содержит описание с длиной не более 255 символов.

<Control FieldName="Microsoft.VSTS.DocName" Type="FieldControl" Label="Vision Doc Location" LabelPosition="Left" />

String

FieldControl

Используйте элемент управления с типом FieldControl для предоставления поля элемента управления полям с типом String. Поля с типом String могут содержать не более 255 символов.

<Control FieldName="System.Title" Type="FieldControl" Label="Title" LabelPosition="Left" />

TreePath

WorkItemClassificationControl

Используйте элемент управления с типом WorkItemClassificationControl для предоставления поля элемента управления полям с типом TreePath.

<Control FieldName="System.AreaPath" Type="WorkItemClassificationControl" Label="Area Path" LabelPosition="Left" />

Необязательные атрибуты полей элемента управления для всех типов элементов управления

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

Атрибут

Описание

Field

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

Label

Задает отображаемый в форме текст, определяющий элемент управления. Введите строку, длина которой не превышает 80 символов.

Примечание

Используя FieldControl, можно вложить гиперссылку в метку поля, которая добавляется в форму рабочего элемента.Этот элемент управления рекомендуется использовать для предоставления ссылок на сведения о порядке использования поля.Подробнее см. в разделе Предоставление текста справки, гиперссылок или веб-содержимого в форму рабочего элемента.

LabelPosition

Задает положение метки относительно данных элемента управления. Укажите строку, которая представляет собой одно из следующих значений: Top, Bottom, Left, Right.

Dock

Задает выравнивание метки по заданному краю контейнера или растягивает поле на весь контейнер. Укажите строку, которая представляет собой одно из следующих значений: Fill, Top, Bottom, Left, Right.

Padding

Задает интервал в пикселях вокруг внутренней границы элемента управления. Четыре значения, соответствующие верхнему, нижнему, левому и правому интервалам. Например: (2,0,2,0).

Margin

Задает интервал в пикселях вокруг внешней границы элемента управления. Четыре значения, соответствующие верхнему, нижнему, левому и правому интервалам. Например: (2,0,2,0).

ReadOnly

Задает доступность поля только для чтения. Следует задать True или False.

MinimumSize

Задает минимальный размер в пикселях, который должен занимать элемент управления в форме. Два значения, соответствующие ширине и высоте. Например: (100,100).

Name

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

Примечание

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

Необязательные атрибуты полей элемента управления для определенных типов элементов управления

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

Атрибут

Типы элементов управления

Описание

NumberFormat

FieldControl

Задает символы, которые могут быть введены в поле элемента управления. Допустимыми являются следующие значения: WholeNumbers, SignedWholeNumbers, DecimalNumbers и SignedDecimalNumbers.

MaxLength

FieldControl

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

Format

DateTimeControl

Задает для поля даты-времени формат, соответствующий одному из значений перечисления DateTimePickerFormat. Допустимы следующие значения: Custom, Long, Short, Time.

CustomFormat

DateTimeControl

Задает пользовательский формат, используемый для полей даты-времени, который соответствует синтаксису, определенному для свойства DateTimePicker.CustomFormat.

Добавление специальных элементов управления

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

Атрибут Type элемента управления

Использование

AttachmentsControl

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



Управление вложениями

Вложение файлов в рабочий элемент

Подробнее см. в разделе Добавление элемента управления для работы с вложениями.

LabelControl

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

Пример двух гиперссылок, применяемых к тексту

Для определения текста, гиперссылки, расположения поля или метки, текст которых частично связан с гиперссылкой, используются дочерние элементы LabelText и Link, а также элементы контейнера. Подробнее см. в разделах Предоставление текста справки, гиперссылок или веб-содержимого в форму рабочего элемента, Справочник по XML-элементам LabelText и Text и Справочник по XML-элементам Link и Param.

LinksControl

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

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

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

StoryboardsControl

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

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

Чтобы добавить StoryboardsControl в раздел FORM, добавьте следующий фрагмент кода:

<Tab Label="Storyboards"> 
   <Control Name="StoryboardsControl" Type="LinksControl"> 
      <LinksControlOptions> 
         <WorkItemLinkFilters FilterType="excludeAll" /> 
         <ExternalLinkFilters FilterType="include"> 
            <Filter LinkType="Storyboard" /> 
         </ExternalLinkFilters> 
         <LinkColumns> 
            <LinkColumn RefName="System.Title" /> 
            <LinkColumn LinkAttribute="System.Links.Comment" /> 
         </LinkColumns> 
      </LinksControlOptions> 
   </Control> 
</Tab>

WebpageControl

Используется для отображения веб-содержимого в форме рабочего элемента. Этот элемент управления обычно содержится в выделенной группе элементов управления. Дочерние элементы WebpageControlOptions и Link используются для указания элементов управления, необходимых для загрузки целевой веб-страницы в форму рабочего элемента.

Подробнее см. в разделах Добавление веб-содержимого в форму рабочего элемента с помощью изменения определения WIT, Справочник по XML-элементам WebpageControlOptions и Справочник по XML-элементам Link и Param.

Добавление пользовательских элементов управления

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

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

Для реализации пользовательского элемента управления необходимо задать имя элемента управления для атрибута Type.

См. также

Задачи

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

Добавление веб-содержимого в форму рабочего элемента с помощью изменения определения WIT

Ссылки

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