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

Статья
06/09/2015

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

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

<xs:element name="Control" type="ControlType" minOccurs="0"/>

<Control FieldName="FieldName" Type="AttachmentsControl | DateTimeControl | FieldControl | 
HtmlFieldControl | LabelControl | LinksControl | WebpageControl | WorkItemClassificationControl | 
WorkItemLogControl" ControlFontSize="FontSize" EmptyText="TextString"
Label="LabelText" LabelPosition="Top | Bottom | Left | Right" 
Padding="(top, bottom, left, right)" 
Margin="(top, bottom, left, right)" ReadOnly="True | False" MinimumSize="(width,height)" 
Name="InstanceName" >
<LabelText> . . . </LabelText>
<Link> . . . </Link>
<LinksControlOptions> . . . </LinksControlOptions>
<WebpageControlOptions> . . . </WebpageControlOptions>
</Control>

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

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

Атрибуты

Атрибут	Описание
FieldName	Необязательный атрибут элемента Control. Определяет поле рабочего элемента, с которым связывается элемент управления. Тип атрибута —typelib:ReferenceFieldName. Минимальная длина: 1; максимальная длина: 70. Значение шаблона: ^[a-zA-Z_][a-zA-Z0-9_]*(\.[a-zA-Z0-9_]+)+$ Пример значения шаблона: Company.Division.IssueType
Type	Обязательный атрибут элемента Control. Определяет тип данных элемента управления. Тип атрибута — ValidControlsType (простой тип). Укажите строку из одного из перечисленных ниже встроенных типов. AttachmentControl: используется для отображения вложений рабочих элементов. С этим элементом управления не связано никакое поле или тип поля. DateTimeControl: используется для отображения форматированных полей даты с типом поля DateTime. FieldControl: используется для отображения простых текстовых или числовых полей и списков значений для полей с типом поля String, Identity, Integer, Double и PlainText. HtmlFieldControl: используется для отображения многострочных полей в формате RTF с типом поля HTML. LabelControl: используется для отображения текста, не связанного с полем. Текст может быть обычным или в виде гиперссылок. С помощью элементов LabelText, Link и Text можно определить дополнительные элементы управления. См. разделы Справка по XML-элементам LabelText и Text и Справка по XML-элементам Link и Param. LinksControl: используется для отображения панели инструментов с элементами управления ссылками и для управления ссылочными отношениями между рабочими элементами и раскадровками. С этим элементом управления не связано никакое поле или тип поля. Типы ссылок для фильтрации и другие параметры элемента управления задаются с помощью элемента LinksControlOptions. См. раздел Элементы LinksControlOptions. WebpageControl: используется для отображения содержимого на основе HTML, определенного универсальным кодом ресурса (URI) или включенного в тег CDATA. С этим элементом управления не связано никакое поле или тип поля. . Подлежащие отображению содержимое и ссылки задаются с помощью элемента WebpageControlOptions. См. раздел Справка по XML-элементам WebpageControlOptions. WorkItemClassificationControl используется для отображения полей иерархических путей с типом поля TreePath. Примечание Этот тип данных используется только полями System.AreaPath и System.IterationPath.С помощью этого типа данных можно определить настраиваемое поле. WorkItemLogControl: используется для отображения сведений об истории рабочих элементов и полей с типом поля History. Примечание Этот тип данных используется только полем System.History.С помощью этого типа данных можно определить настраиваемое поле. Для получения дополнительной информации см. Указание элементов управления на форме рабочего элемента. Примечание Можно использовать пользовательский элемент управления, присвоив атрибуту Type пользовательское значение.Пользовательским элементом управления считается любой элемент управления, атрибут Type которого имеет значение, отличное от имени встроенного типа.Дополнительные сведения см. на веб-сайте Майкрософт: Настраиваемые элементы управления отслеживанием рабочих элементов.
ControlFontSize	Необязательный атрибут элемента Control. Указывает размер шрифта имени поля или метки в форме. Допустимые значения параметра FontSize: small, normal, large, xlarge и xxlarge.
EmptyText	Необязательный атрибут элемента Control. Задает текстовую строку длиной от 1 до 255 символов, которая появляется при отсутствии значения в поле.
Label	Необязательный атрибут элемента Control. Задает отображаемый в форме текст, определяющий элемент управления. Введите строку, длина которой не превышает 80 символов.
LabelFontSize	Определяет размер шрифта метки в форме. Допустимые значения параметра FontSize: small, normal, large, xlarge и xxlarge.
LabelPosition	Необязательный атрибут элемента Control. Определяет положение метки относительно данных элемента управления. Задайте строку, используя одно из следующих значений: Top: метка размещается над данными элемента управления. Bottom: метка размещается под данными элемента управления. Left: метка размещается слева от данных элемента управления. Right: метка размещается справа от данных элемента управления.
Padding	Необязательный атрибут элемента Control. Задает пространство в пикселях вокруг внутренней границы элемента управления, соответствующее верхней, нижней, левой и правой областям. Тип атрибута —SizeType. Значение шаблона: ^$\d+\,\d+\,\d+\,\d+$$ Пример значения шаблона: (2,0,2,0)
Margin	Необязательный атрибут элемента Control. Задает пространство в пикселях вокруг внешней границы элемента управления, соответствующее верхней, нижней, левой и правой областям. Тип атрибута —SizeType. Значение шаблона: ^$\d+\,\d+\,\d+\,\d+$$ Пример значения шаблона: (2,0,2,0)
ReadOnly	Необязательный атрибут элемента Control. Задает доступность поля только для чтения. Тип атрибута —ReadOnlyType. Задайте строку, используя одно из следующих значений: True: данные элемента управления доступны только для чтения. False: данные элемента управления доступны не только для чтения.
MinimumSize	Необязательный атрибут элемента Control. Задает минимальный размер в пикселях, который элемент управления должен занимать в форме. Синтаксис следующий: (width,height). Тип атрибута —SizeType. Значение шаблона: ^$\d+\,\d+$$ Пример значения шаблона: (100,100) Примечание Если вертикального пространства недостаточно, появляется полоса прокрутки, чтобы сохранить минимальный размер.Без этого атрибута элементы управления отображаются с размерами по умолчанию, если на других вкладках они не занимают больше места.Общий размер любого элемента управления формы зависит от размера вкладки или наибольшей области формы.
Name	Необязательный атрибут элемента Control. Является уникальным идентификатором элемента управления. Атрибут Name важен, если несколько элементов управления в форме связаны с одним полем рабочего элемента. Тип атрибута —xs:string. Примечание Атрибут Name используется для отображения одного и того же поля в нескольких местах формы.Атрибуту Name задается уникальное значение для обоих элементов управления, чтобы система могла однозначно определить каждый элемент управления.Рекомендуется отображать один и тот же элемент управления в различных расположениях, в зависимости от контекста вкладок.
NumberFormat	Необязательный атрибут элемента Control, допустимый только при использовании с атрибутом FieldControl. Задает символы, которые могут быть введены в поле элемента управления. Ниже приведены допустимые значения. WholeNumbers: указывает, что разрешены целые числа. SignedWholeNumbers: указывает, что разрешены целые числа со знаком. DecimalNumbers: указывает, что разрешены десятичные числа. SignedDecimalNumbers: указывает, что разрешены десятичные числа со знаком.
MaxLength	Необязательный атрибут элемента Control, допустимый только при использовании с атрибутом FieldControl. Указывает максимальную длину строки символов, которую можно использовать для элемента управления поля. Тип атрибута —xs:integer.
Format	Необязательный атрибут элемента Control, допустимый только при использовании с атрибутом DateTimeControl. Определяет формат поля даты и времени, соответствующий одному из значений перечисления DateTimePickerFormat. Ниже приведены допустимые значения. Custom: отображение даты и времени в пользовательском формате. Пользовательский формат можно задать, указав Custom в качестве значения атрибута Format и присвоив другому атрибуту CustomFormat значение строки пользовательского формата. Например: Format="Custom" CustomFormat = "MMM dd, 'of the year' yyyy" Дополнительные сведения см. на веб-сайте Майкрософт: Свойство DateTimePicker.CustomFormat. Long: отображение даты и времени в длинном формате даты, установленном операционной системой пользователя. Short: отображение даты и времени в коротком формате даты, установленном операционной системой пользователя. Time: отображение даты и времени в формате времени, установленном операционной системой пользователя. Дополнительные сведения см. на веб-сайте Майкрософт: Перечисление DateTimePickerFormat.
CustomFormat	Необязательный атрибут элемента Control, допустимый только при использовании с атрибутами DateTimeControl и Format. Определяет пользовательский формат для поля даты и времени, соответствующий синтаксису, заданному для свойства DateTimePicker.CustomFormat. Дополнительные сведения см. на веб-сайте Майкрософт: Свойство DateTimePicker.CustomFormat.

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

Элемент	Описание
LabelText	Необязательный элемент. Этот элемент можно задать, если атрибут Type имеет значение FieldControl или LabelControl. Элемент-контейнер для задания текста, гиперссылки и расположения поля или метки, текст которых частично связан с гиперссылкой. Дополнительные сведения см. в разделах Справка по XML-элементам LabelText и Text и Предоставление текста справки, гиперссылок или веб-содержимого в форму рабочего элемента.
Ссылка	Необязательный элемент. Этот элемент можно задать, если атрибут Type имеет значение FieldControl или LabelControl. Определяет гиперссылку для поля или метки. Дополнительные сведения см. в разделах Справка по XML-элементам Link и Param и Предоставление текста справки, гиперссылок или веб-содержимого в форму рабочего элемента.
LinksControlOptions	Необязательный элемент. Этот элемент можно задать, если атрибут Type имеет значение LinksControl. Определяет фильтры ссылок и структуру полей столбцов для отображения списка ссылок. Для получения дополнительной информации см. Определение элементов управления связей для ограничения ссылочных отношений.
WebpageControlOptions	Необязательный элемент. Этот элемент можно задать, если атрибут Type имеет значение WebpageControl. Определяет элементы управления, управляющие загрузкой целевой веб-страницы в форму рабочего элемента. Дополнительные сведения см. в разделах Справка по XML-элементам WebpageControlOptions и Предоставление текста справки, гиперссылок или веб-содержимого в форму рабочего элемента.
anyAttribute	Необязательный элемент. Необязательно. Элемент Control может расширяться путем использования элемента anyAttribute.

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

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

Заметки

Control — необязательный дочерний элемент элементов Layout, Column и Tab.

Индикаторы Layout и Column:

minOccurs = "0"

maxOccurs = "1"

Индикаторы Tab:

minOccurs = "0"

maxOccurs = "unbounded"

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

Примеры всех типов элементов управления см. в разделе Указание элементов управления на форме рабочего элемента.

Пример

<Control Type=" WorkItemClassificationControl " FieldName="System.AreaPath"
  Label="Area" LabelPosition="Left" Padding="(2,0,2,0)" Margin="(2,2,2,2)" />

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

Пространство имен	https://schemas.microsoft.com/VisualStudio/2008/workitemtracking/typedef
Имя схемы	Определение типа рабочего элемента
Файл проверки	WorkItemTypeDefinition.xsd
Тип элемента	Сложный тип ControlType
Может быть пустым	Неприменимо