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

Статья
02/20/2013

Элемент 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" 
Dock="Fill | Top | Bottom | Left | Right" Padding="(left, top, right, bottom)" 
Margin="(left, top, right, bottom)" 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: используется для отображения текста, который не связан с полем.Текст может быть обычным или HTML-кодом.Можно определить дополнительные элементы управления с помощью элементов 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: Размещает метку справа от данных элемента управления.
Dock	Необязательный атрибут элемента Control. Выравнивает поле по заданному краю контейнера или растягивает поле на весь контейнер.Типом атрибута является DockType.Укажите строку из одного из следующих значений: Fill. Выравнивает поле по всему контейнеру.Это значение ориентации не поддерживается для элемента Splitter. Top: выравнивает поле по верхней стороне контейнера.Это значение ориентации не поддерживается для элемента Splitter. Bottom: выравнивает поле по нижней стороне контейнера.Это значение ориентации не поддерживается для элемента Splitter. Left: выравнивает поле по левой стороне контейнера. Right: выравнивает поле по правой стороне контейнера.Это значение ориентации не поддерживается для элемента Splitter.
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. Определяет формат поля с типом DateTime, который соответствует одному из значений перечисления DateTimePickerFormat.Ниже приведены допустимые значения: Custom: отображает значение даты/времени в пользовательском формате.Можно задать пользовательский формат, указав Custom в качестве значения атрибута Format и присвоив другому атрибуту CustomFormat значение строки пользовательского формата.Например: Format="Custom" CustomFormat = "MMM dd, 'года' yyyy " Дополнительные сведения см. на веб-сайте Майкрософт: DateTimePicker.CustomFormat - свойство. Long: Отображает значение даты/времени в длинном формате даты, настроенном в операционной системе пользователя. Short: Отображает значение даты/времени в коротком формате даты, настроенном в операционной системе пользователя. Time: Отображает значение даты/времени в формате времени, настроенном в операционной системе пользователя. Дополнительные сведения см. на веб-сайте корпорации Майкрософт: Перечисление DateTimePickerFormat (страница может быть на английском языке).
CustomFormat	Необязательный атрибут Control, который является допустимым только при использовании с атрибутом DateTimeControl и Format. Определяет пользовательский формат для полей с типом DateTime, который соответствует синтаксису, определенному для свойства DateTimePicker.CustomFormat.Дополнительные сведения см. на веб-сайте Майкрософт: DateTimePicker.CustomFormat - свойство.

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

Элемент	Описание
LabelText	Необязательный элемент.Этот элемент можно определить, если атрибут Type имеет значение FieldControl или LabelControl. Элемент контейнера для задания текста, гиперссылки и расположения поля или метки, текст которых частично связан с гиперссылкой. Дополнительные сведения см. в разделах Справка по XML-элементам LabelText и Text и Предоставление текста справки, руководства по процессам, веб-содержимого и ссылок на веб-страницы на форме рабочего элемента.
Ссылка	Необязательный элемент.Этот элемент можно определить, если атрибут Type имеет значение FieldControl или LabelControl. Определяет гиперссылку для поля или метки. Дополнительные сведения см. в разделах Справка по XML-элементам Link и Param и Предоставление текста справки, руководства по процессам, веб-содержимого и ссылок на веб-страницы на форме рабочего элемента.
LinksControlOptions	Необязательный элемент.Этот элемент можно определить, если атрибут Type имеет значение LinksControl. Задает фильтры ссылок и структуру полей столбцов для отображения списка ссылок. Дополнительные сведения см. в разделе Определение элементов управления Link для ограничения ссылочных отношений.
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" />

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

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