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

Статья
06/09/2015

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

Содержание раздела

Пример элемента FORM
Синтаксис элементов FORM
Атрибуты, задаваемые в элементах FORM
Элементы, определяющие отдельные метки, гиперссылки, веб-страницы и содержимое HTML
Элементы, фильтрующие и отображающие ссылочные отношения

Пример элемента FORM

В следующем примере показана общая структура элемента FORM. Макет формы задается с помощью элемента Layout. Для различных клиентов можно задавать различные макеты. Например, можно задать один макет для клиентов Windows и другой клиент для Team Web Access. Макет обычно состоит из верхней части формы и группы вкладок. Последовательность определения элементов макета определяет последовательность, в которой эти элементы отображаются в форме.

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

<FORM>
      <Layout>
        <Group>
          <Column PercentWidth="70">
            <Group>
              <Column PercentWidth="100">
                <Control FieldName="System.Title" Type="FieldControl" Label="Title" LabelPosition="Left" />
                <Control FieldName="System.AreaPath" Type="WorkItemClassificationControl" Label="Area Path" LabelPosition="Left" />
                <Control FieldName="System.IterationPath" Type="WorkItemClassificationControl" Label="&amp;Iteration Path:" LabelPosition="Left" />
                <Group>
                  <Column PercentWidth="50">
                    <Control FieldName="Microsoft.VSTS.Common.ProductUnit" Type="FieldControl" Label="PU (Use Area Path)" LabelPosition="Left" />
                  </Column>
                  <Column PercentWidth="50">
                    <Control FieldName="Microsoft.VSTS.Common.Priority" Type="FieldControl" Label="Priority" LabelPosition="Left" />
                  </Column>
                </Group>
              </Column>
            </Group>
          </Column>
          <Column PercentWidth="30">
            <Group Label="Status">
              <Column PercentWidth="100">
                <Control FieldName="System.Id" Type="FieldControl" Label="Id" LabelPosition="Left" />
                <Control FieldName="System.State" Type="FieldControl" Label="State" LabelPosition="Left" />
                <Control FieldName="System.AssignedTo" Type="FieldControl" Label="Assigned To" LabelPosition="Left" />
              </Column>
            </Group>
          </Column>
        </Group>

. . .
</Layout>
</FORM>

Элементы формы

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

Примечание

Для улучшения результата, элементы Control следует вложить в Group, а элементы Group— в Column, даже в случае, если столбец занимает всю ширину формы. Каждый раздел Column также должен быть вложен в Group, даже если группа не имеет отображаемой метки или границы.

Элемент	Описание	Обязательный?
Column	Делит области формы на столбцы. `<Column PercentWidth="WidthPerceOfContainingElement" FixedWidth="WidthInPixels"> <Group> . . . </Group <Control> . . . </Control> <TabGroup> . . . </TabGroup> <Splitter> . . . </Splitter> </Column >`	Рекомендовано
Control	Определяет отображение в форме рабочего элемента поля, текста, гиперссылки или другого элемента управления. `<Control FieldName="FieldName" Type="AttachmentsControl \| DateTimeControl \| FieldControl \| HtmlFieldControl \| LabelControl \| LinksControl \| WebpageControl \| WorkItemClassificationControl \| WorkItemLogControl" 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" />` Для получения дополнительной информации см. Справочник по XML-элементу Control.	Обязательно
FORM	Определяет элемент формы верхнего уровня. `<FORM> <Layout> . . . </Layout> </FORM>`	Обязательно
Group	Обеспечивает визуальную группировку элементов, подобную той, которую предоставляет элемент Windows GroupBox. `<Group Label="LabelText" Padding="(top, bottom, left, right)" Margin="(top, bottom, left, right)"> <Column> . . . </Column> </Group >`	Рекомендовано
Layout	Определение макета формы рабочего элемента. `<Layout Target="ClientName" MinimumSize="(width,height)" Padding="(top, bottom, left, right)" Margin="(left, top, right, bottom)" ControlSpacing="Distance" LabelSpacing="Distance"> <Group> . . . </Group> <Control> . . . </Control> <TabGroup> . . . </TabGroup> <Splitter> . . . </Splitter> </Layout>`	Обязательно
Splitter	Делит форму на две области для поддержания макета двух одноуровневых элементов формы. `Splitter />`	Необязательный
Tab	Определяет макет одной вкладки в группе вкладок. `<Tab Label="LabelText" Padding="(top, bottom, left, right)" Margin="(top, bottom, left, right)"> <Group> . . . </Group <Control> . . . </Control> <TabGroup> . . . </TabGroup> <Splitter> . . . </Splitter> </Tab>`	Необязательный
TabGroup	Определяет одну или более вкладок формы. `<TabGroup Padding="( top, bottom, left, right)" Margin="(top, bottom, left, right)"> <Tab> . . . </Tab> </TabGroup>`	Необязательный

Атрибуты, используемые для форматирования элементов FORM

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

Атрибут	Описание	Применяемые элементы
ControlSpacing	Необязательно. Задает вертикальное смещение элементов управления. Integer.	Layout
FixedWidth	Необязательно. Ширина столбца в пикселях. Атрибуты PercentWidth и FixedWidth являются взаимоисключающими.	Column
Label	Необязательно. Текст, отображающийся для элемента управления или группы. Если метка указана, она переопределяет любую метку, связанную с полем посредством метаданных для элемента управления. Обязательный для элемента Tab. Текст, отображающийся для вкладки. LabelText— текстовая строка длиной от 1 до 80 знаков.	Control Group Tab
LabelPosition	Необязательно. Расположение метки относительно данных поля. Возможные значения: «Top», «Bottom», «Left» и «Right».	Control
LabelSpacing	Необязательно. Задает количество пикселей между меткой и редактируемой областью элемента управления.	Layout
Margin	Необязательно. Строка формы (левый, верхний, правый, нижний), указывающая, в пикселях, количество свободного места, которое следует оставить вокруг элемента управления и между элементом управления и его соседями. Можно задавать разное количество свободного места для каждой стороны. Значение шаблона: ^$\d+\,\d+\,\d+\,\d+$$ Пример значения шаблона: (2,0,2,0)	Control Group Layout Tab TabGroup
MinimumSize	Необязательно. Строка формы (ширина, высота). Это значение определяет минимальный размер самой формы. Когда контейнерный элемент управления меньше, чем заданный этим значением, появляются горизонтальные и вертикальные полосы прокрутки.	Control Layout
Name	Необязательно. Имя элемента управления. Если не указано, то совпадает со значением FieldName.	Control
Padding	Необязательно. Строка формы (top, bottom, left, right), где указывается пространство (в пикселях), которое следует оставить свободным около внешней границы элемента управления и около его внутренней границы. Можно задавать разное количество свободного места для каждой стороны.	Control Group Layout Tab TabGroup
PercentWidth	Необязательно. Значение ширины столбца в процентах от ширины элемента, содержащего столбец. Атрибуты PercentWidth и FixedWidth являются взаимоисключающими.	Column
ReadOnly	Необязательно. В элементе управления можно отобразить поле только для чтения. Поведение различных элементов управления для этого атрибута несколько различается.	Control
Target	Необязательно. Строка, которая определяет, к какому клиенту применим данный макет. Среда разработки Visual Studio отображает этот тип рабочего элемента с данным макетом, если атрибут Target опущен или установлен в значение Windows Forms. Внешние клиенты могут указывать дополнительные макеты с помощью настраиваемых атрибутов Target, игнорируемых средой разработки Visual Studio. Допустимы следующие значения. WinForms. Применяет форму к Team Explorer и Team Explorer Everywhere. Web. Применяет форму к Team Web Access.	Layout
Type	Обязательный. Тип элемента управления. Для получения дополнительной информации см. Справочник по XML-элементу Control.	Control

Элементы, определяющие отдельные метки, гиперссылки, веб-страницы и содержимое HTML

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

<WebpageControlOptions AllowScript="true | false" ReloadOnParamChange="true | false" >
   <Link UrlRoot="UrlRoot" UrlPath ="UrlPathWithParameters">
      <Param index="IndexValue" value="ParamValue" type ="Original | Current"/>
   </Link>
   <Content>
      <![CDATA[Contents of HTML]]>
   </Content>
</WebpageControlOptions>

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

Элемент	Обязательный?	Описание
Content	Необязательный элемент WebpageControlOptions.	Указывает CDATA содержимое на базе HTML для отображения в форме рабочего элемента. `<Content> <![CDATA[Contents of HTML]]> </Content>` Для получения дополнительной информации см. Справка по XML-элементам WebpageControlOptions.
LabelText	Необязательный элемент Control при type="LabelControl".	Определяет обычную метку или метку с гиперссылкой. Для получения дополнительной информации см. Справка по XML-элементам LabelText и Text.
Link	Необязательный элемент Control при type="FieldControl". Необязательный элемент Text. Необязательный элемент WebpageControl. Необязательный элемент WebpageControlOptions.	Определяет гиперссылку для поля, метки или содержимого веб-браузера для отображения в форме рабочего элемента. `<Link URLRoot="URLRoot" URLPath ="URLPathWithParameters"> <Param /> </Link>` Для получения дополнительной информации см. Справка по XML-элементам Link и Param.
Param	Необязательный элемент Link.	Указывает значение для определения URL-адреса гиперссылки, если для элемента URLPath задано значение Link. `<Param index="IndexValue " value="ParamValue " type ="Original \| Current"/>` Для получения дополнительной информации см. Справка по XML-элементам Link и Param.
Text	Необязательный элемент LabelText.	Элемент контейнера для информации или метки, отображаемых в форме рабочего элемента. `<Text> <Link > <Param /> </Link> LabelText </Text>` Для получения дополнительной информации см. Справка по XML-элементам LabelText и Text.
WebpageControlOptions	Необязательный элемент Control при type="WebpageControl".	Элемент контейнера, представляющий параметры для элемента управления веб-страницы. Для получения дополнительной информации см. Справка по XML-элементам WebpageControlOptions.

Элементы, фильтрующие и отображающие ссылочные отношения

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

<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="referenceName" | LinkAttribute="linkAttributeName"/>
   </LinkColumns>
</LinksControlOptions>

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

Элемент	Обязательный?	Описание
LinksControlOptions	Необязательный элемент Control при type="LinksControl".	Обеспечивает контейнер для элементов, определяющих параметры управления ссылками, добавляемыми в рабочий элемент, а также отображение столбцов со списком ссылок в рабочем элементе, настраиваемых по умолчанию.
WorkItemLinkFilters	Необязательный элемент типа LinksControlOptions.	Обеспечивает контейнер для одного или более элементов Filter, указывающих, какой критерий фильтра ссылки следует использовать для типов ссылок, определенных для коллекции командного проекта.
ExternalLinkFilters	Необязательный элемент типа LinksControlOptions.	Обеспечивает контейнер для одного или более элементов Filter, указывающих, какой критерий фильтра ссылки следует использовать для типов ссылок, определенных в другом командном проекте.
WorkItemTypeFilters	Необязательный элемент типа LinksControlOptions.	Обеспечивает контейнер для одного или более элементов Filter, определяющих критерий фильтра, применяемого к типам рабочего элемента.
Filter (типы ссылок).	Обязательный элемент WorkItemLinkFilters при FilterType имеет значение exclude или include. Обязательный элемент ExternalLinkFilters при FilterType имеет значение exclude или include.	Указывает типы ссылок для их включения или исключения из набора ссылок, который может быть создан для рабочего элемента.
Filter(типы рабочих элементов)	Атрибут WorkItemTypeFilters необязателен, при FilterType, принимающем значение exclude или include.	Указывает типы рабочих элементов для их включения или исключения из набора типов рабочих элементов, между которыми может быть создана связь.
LinkColumns	Необязательный элемент типа LinksControlOptions.	Обеспечивает контейнер для одного или более тегов LinkColumn.
LinkColumn	Обязательный элемент LinkColumns.	Указывает поля рабочего элемента и атрибуты типа ссылки, которые отображаются в форме рабочего элемента для списка ссылок.

См. также

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

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

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

Отслеживание рабочих элементов. Указатель определений XML-элементов

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