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

Статья
08/11/2011

Информацию данного раздела можно использовать для быстрого перехода ко всем элементам и основным атрибутам, управляющим формой типа рабочего элемента. Эти элементы указываются в контейнере элемента 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" Dock="Fill \| Top \| Bottom \| Left \| Right" Padding="(left, top, right, bottom)" Margin="(left, top, right, bottom)" ReadOnly="True \| False" MinimumSize="(Width,Height)" Name="InstanceName" />` Дополнительные сведения см. в разделе Справка по XML-элементу Control.	Обязательно
FORM	Определяет элемент формы верхнего уровня. `<FORM> <Layout> . . . </Layout> </FORM>`	Обязательно
Group	Обеспечивает визуальную группировку элементов, подобную той, которую предоставляет элемент Windows GroupBox. `<Group Label="LabelText" Padding="(left, top, right, bottom)" Margin="(left, top, right, bottom)"> <Column> . . . </Column> </Group >`	Рекомендовано
Layout	Определение макета формы рабочего элемента. `<Layout Target="ClientName" MinimumSize="(width,height)" Padding="(left, top, right, bottom)" Margin="(left, top, right, bottom)" ControlSpacing="Distance" LabelSpacing="Distance"> <Group> . . . </Group> <Control> . . . </Control> <TabGroup> . . . </TabGroup> <Splitter> . . . </Splitter> </Layout>`	Обязательно
Splitter	Делит форму на две области для поддержания макета двух одноуровневых элементов формы. `Splitter Dock="Left" />`	Необязательный
Tab	Определяет макет одной вкладки в группе вкладок. `<Tab Label="LabelText" Padding="(left, top, right, bottom)" Margin="(left, top, right, bottom)"> <Group> . . . </Group <Control> . . . </Control> <TabGroup> . . . </TabGroup> <Splitter> . . . </Splitter> </Tab>`	Необязательный
TabGroup	Определяет одну или более вкладок формы. `<TabGroup Padding="(left, top, right, bottom)" Margin="(left, top, right, bottom)"> <Tab> . . . </Tab> </TabGroup>`	Необязательный

К началу

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

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

Атрибут	Описание	Применяемые элементы
ControlSpacing	Необязательный. Задает вертикальное смещение элементов управления. Integer.	Layout
Dock	Необязательный. Растягивает элемент управления полем или разделитель, чтобы заполнить контейнер. Допустимы следующие значения атрибута закрепления поля: Fill, Top, Bottom, Left и Right. Fill. Выравнивает поле по всему контейнеру. Top. Выравнивает поле по верхней стороне контейнера. Bottom. Выравнивает поле по нижней стороне контейнера. Left. Выравнивает поле или разделитель по левой стороне контейнера. Это значение является единственной поддерживаемой ориентацией для элемента SPLITTER. Right. Выравнивает поле или разделитель по правой стороне контейнера.	Control Splitter
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	Необязательный. Строка формы (левый, верхний, правый, нижний), где указывается, в пикселях, количество места, которое следует оставить свободным возле внешней границы элемента управления и возле внутренней границы. Можно задавать разное количество свободного места для каждой стороны.	Control Group Layout Tab TabGroup
PercentWidth	Необязательный. Значение ширины столбца в процентах от ширины элемента, содержащего столбец. Атрибуты PercentWidth и FixedWidth являются взаимоисключающими.	Column
ReadOnly	Необязательный. В элементе управления можно отобразить поле только для чтения. Поведение различных элементов управления для этого атрибута несколько различается.	Control
Target	Необязательный. Строка, которая определяет, к какому клиенту применим данный макет. Среда разработки Visual Studio отображает этот тип рабочего элемента с данным макетом, если атрибут Target опущен или установлен в значение Windows Forms. Внешние клиенты могут указывать дополнительные макеты с помощью настраиваемых атрибутов Target, игнорируемых средой разработки Visual Studio. Допустимы следующие значения. WinForms. Применяет форму к Сред. Командный обозреватель и 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-адреса гиперссылки, если для элемента Link задано значение URLPath. `<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>

Можно использовать элементы, представленные в следующей таблице. Дополнительные сведения об использовании этих элементов см. в разделах Определение элементов управления Link для ограничения ссылочных отношений и Элементы 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-элементов для типов рабочих элементов

Журнал изменений

Дата	Журнал	Причина
Май 2011	Исправлен регистр нескольких элементов и атрибутов в описании синтаксиса XML. Определение схемы для отслеживания рабочих элементов определяет все дочерние элементы элемента FORM в формате Camel, а все буквы в именах остальных элементов при этом должны быть прописными.	Исправление ошибки содержимого.
Январь 2011	Добавлены пример и синтаксис для всех элементов FORM. Удалены ссылки на удаленные разделы.	Улучшение информации.
Июль 2010	Добавлены ссылки на разделы, добавленные при предыдущем обновлении.	Улучшение информации.

Май 2011

Исправлен регистр нескольких элементов и атрибутов в описании синтаксиса XML. Определение схемы для отслеживания рабочих элементов определяет все дочерние элементы элемента FORM в формате Camel, а все буквы в именах остальных элементов при этом должны быть прописными.

Исправление ошибки содержимого.

Январь 2011

Добавлены пример и синтаксис для всех элементов FORM. Удалены ссылки на удаленные разделы.

Улучшение информации.

Июль 2010

Добавлены ссылки на разделы, добавленные при предыдущем обновлении.

Улучшение информации.

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

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

Пример FORM

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

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

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

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

См. также

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

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

Журнал изменений

Дополнительные ресурсы