Udostępnij za pośrednictwem


Wszystkie elementy FORM XML — Odwołanie

Informacje w tym temacie służy jako podręcznego wykazu do wszystkich elementów i atrybutów głównego, kontrolujących formularza dla typu elementu roboczego.Określ tych elementów w FORM kontener elementu, trzeci i ostatnia głównych sekcji definicji typu elementu roboczego.Wiele elementów są zagnieżdżone w innym grupom formularza, sekcje lub na kartach formularza elementu pracy.Aby uzyskać więcej informacji dotyczących sposobu grupowania tych elementów, zobacz Projektowanie formularza elementu roboczego.

W tym temacie:

  • Przykład formularza

  • Składnia elementów formularza

  • Atrybuty, które określają elementów formularza

  • Elementów określających etykiety autonomicznej, hiperłącza, stron sieci Web lub zawartość HTML

  • Elementy, które filtrować i wyświetlić relacje łącza

Przykład formularza

W poniższym przykładzie przedstawiono ogólną strukturę FORM elementu.Określanie układu formularza przy użyciu Layout elementu.Można określić różne układy prowadzących różnych klientów.Na przykład można określić jedną układu dla klientów systemu Windows i innego układu dla Team Web Access.Układ zwykle składa się z góry formularza, a następnie grupę kart.Sekwencji, w której definiujesz elementy w układzie, określa kolejność, w jakiej elementy są wyświetlane w formularzu.

Grupuj elementy, które są wyświetlane w kolumnach przy użyciu Group i Column elementów.Możesz użyć Control elementu do definiowania każdego pola, które mają być wyświetlane w formularzu.Możesz użyć Tab elementu do obsługi różnych obszarów funkcjonalnych grup pól.

<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>

Elementy formularza

Można określić sposób grupowania pól elementu informacji i pracy i są wyświetlane w postaci elementów pracy za pomocą elementów, które są opisane w poniższej tabeli.

[!UWAGA]

Aby uzyskać najlepsze wyniki, należy zagnieździć Control elementów w Group, i należy zagnieździć Group elementów w Column, nawet jeśli kolumna obejmuje pełną szerokość formularza.Ponadto należy zagnieździć co Column w sekcji Group, nawet jeśli grupa nie ma etykiety widoczne ani granic.

Element

Opis

Wymagany?

Column

Dzieli formularza na kolumny.

<Column PercentWidth="WidthPerceOfContainingElement" FixedWidth="WidthInPixels">
   <Group> . . . </Group
   <Control> . . . </Control>
   <TabGroup> . . . </TabGroup>
   <Splitter> . . . </Splitter>
</Column >

Zalecane

Control

Definiuje pole, tekst, hiperłącze lub innego elementu sterowania pojawi się w formularzu elementu pracy.

<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" />

Aby uzyskać więcej informacji, zobacz Element formantu XML — Odwołanie.

Wymagane

FORM

Definiuje element form najwyższego poziomu.

<FORM>
   <Layout> . . . </Layout>
</FORM>

Wymagane

Group

Udostępnia visual grupowania elementów, podobnie jak okno grupowe systemu Windows.

<Group Label="LabelText" Padding="(top, bottom, left, right)" Margin="(top, bottom, left, right)">
   <Column> . . . </Column>
</Group >

Zalecane

Layout

Definiuje układ formularza elementu pracy.

<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>

Wymagane

Splitter

Dzieli formularza na następujących dwóch obszarach do obsługi układu dwóch elementów formularza element równorzędny.

Splitter />

Optional

Tab

Określa układ jedną kartę w grupie kart.

<Tab Label="LabelText" Padding="(top, bottom, left, right)" Margin="(top, bottom, left, right)">
   <Group> . . . </Group
   <Control> . . . </Control>
   <TabGroup> . . . </TabGroup>
   <Splitter> . . . </Splitter>
</Tab>

Optional

TabGroup

Definiuje jedną lub kilka kart formularza.

<TabGroup Padding="( top, bottom, left, right)" Margin="(top, bottom, left, right)">
   <Tab> . . . </Tab>
</TabGroup>

Optional

Atrybuty, które są używane do formatowania elementów formularza

Odstępy, a rozmiar wiele elementów na formularza elementu pracy można kontrolować, określając atrybuty, które w poniższej tabeli opisano.Aby uzyskać więcej informacji, zobacz Projektowanie formularza elementu roboczego.

Atrybut

Opis

Dotyczy elementów

ControlSpacing

Parametr opcjonalny.Określa przesunięcie w pionie kontrolek.Liczba całkowita.

Layout

FixedWidth

Parametr opcjonalny.Szerokość kolumny w pikselach.PercentWidthi FixedWidth wykluczają się wzajemnie.

Column

Label

Parametr opcjonalny.Tekst wyświetlany dla formantu lub grupy.Jeśli nie zostanie określona etykieta, zastępuje wszelkie etykiety, która jest skojarzony z polem w metadanych dla formantu.

Wymagany dla Tab elementu.Tekst wyświetlany na karcie.

LabelText to ciąg tekstowy, który zawiera od 1 do 80 znaków.

Control

Group

Tab

LabelPosition

Parametr opcjonalny.Położenie etykiety względem pola danych.Możliwe wartości to góry, u dołu, w lewo i w prawo.

Control

LabelSpacing

Parametr opcjonalny.Określa liczbę pikseli pomiędzy etykiety i obszar edycji formantu.

Layout

Margin

Parametr opcjonalny.Ciąg formularza (od lewej, górnej, prawej strony, u dołu), który określa wyrażoną w pikselach ilość miejsca wokół formantu i między wokół i kontroli.Ilość miejsca na każdej stronie mogą się różnić.

Wartość do wzorca: ^ \(\d+\,\d+\,\d+\,\d+\)$

Przykład wartość wzorzec: (2,0,2,0)

Control

Group

Layout

Tab

TabGroup

MinimumSize

Parametr opcjonalny.Ciąg w postaci (szerokość, wysokość).Ta wartość określa minimalny rozmiar samego formularza.Gdy kontener kontrolować mniejszych niż rozmiar, są wyświetlane paski przewijania poziomie i w pionie.

Control

Layout

Name

Parametr opcjonalny.Nazwa kontrolki.Jeśli nie zostanie podany, nazwa jest taka sama jak FieldName.

Control

Padding

Parametr opcjonalny.Ciąg w postaci (góra, dół lewej, do prawej) Określa wyrażoną w pikselach ilość miejsca wokół zewnętrznego obramowania formantu i wokół wewnątrz obramowania.Ilość miejsca na każdej stronie mogą się różnić.

Control

Group

Layout

Tab

TabGroup

PercentWidth

Parametr opcjonalny.Szerokość kolumny w postaci wartości procentowej szerokości elementu zawierającego.PercentWidthi FixedWidth wykluczają się wzajemnie.

Column

ReadOnly

Parametr opcjonalny.Pole tylko do odczytu można wyświetlić w formancie.Różne formanty mają ten atrybut nieco różne sposoby.

Control

Target

Parametr opcjonalny.Ciąg określający, na który klient ma zastosowanie tego układu.Visual StudioWyświetla tego typu elementu roboczego w tym układzie, jeśli Target atrybutu jest pominięty lub Ustaw formularze systemu Windows.Zewnętrzne klienci mogą określić dodatkowe układów przy użyciu niestandardowego Target atrybuty, które Visual Studio ignoruje.

Następujące wartości są prawidłowe:

  • WinForms: Dotyczy formularza, aby Team Explorer i Team Explorer Everywhere.

  • Web: Dotyczy formularza, aby Team Web Access.

Layout

Type

Parametr wymagany.Typ formantu.Aby uzyskać więcej informacji, zobacz Element formantu XML — Odwołanie.

Control

Elementów określających autonomiczne etykiety, hiperłącza, stron sieci Web lub zawartość HTML

WebpageControlOptions Elementu i jego elementów podrzędnych ma następującą strukturę składni:

<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>

Możesz używać elementów, które są opisane w poniższej tabeli, aby zdefiniować zwykły tekst lub hiperłącze etykiety, Dodaj hiperłącza do pola lub wyświetlać zawartość strony sieci Web w postaci elementów roboczych.Aby uzyskać więcej informacji, zobacz Dodawanie tekstów pomocy, hiperłączy lub zawartości WWW do formularza elementów pracy.

Element

Wymagany?

Opis

Content

Opcjonalny WebpageControlOptions elementu.

Określa zawartości na podstawie CDATA HTML do są wyświetlane w postaci elementów roboczych.

<Content>
   <![CDATA[Contents of HTML]]>
</Content>

Aby uzyskać więcej informacji, zobacz WebpageControlOptions Elementy XML — Odwołanie.

LabelText

Opcjonalny Control elementu po type="LabelControl".

Definiuje albo etykietę zwykły lub hiperłącze.

Aby uzyskać więcej informacji, zobacz LabelText i odnośniki do elementów tekstowych XML.

Link

Opcjonalny Control elementu po type="FieldControl".

Opcjonalny Text elementu.

Opcjonalny WebpageControl elementu.

Opcjonalny WebpageControlOptions elementu.

Definiuje hiperłącza dla pola, etykiety lub zawartości przeglądarki sieci Web do są wyświetlane w postaci elementów roboczych.

<Link URLRoot="URLRoot" URLPath ="URLPathWithParameters">
   <Param />
</Link>

Aby uzyskać więcej informacji, zobacz Elementy XML Link and Param — Odwołanie.

Param

Opcjonalny Link elementu.

Określa wartość, aby określić adres URL hiperłącza po URLPath jest określone dla Link elementu.

<Param index="IndexValue " value="ParamValue " type ="Original | Current"/>

Aby uzyskać więcej informacji, zobacz Elementy XML Link and Param — Odwołanie.

Text

Opcjonalny LabelText elementu.

Kontener element label pojawi się w formularzu elementu pracy lub informacji.

<Text>
   <Link >
      <Param />
   </Link>
   LabelText
</Text>

Aby uzyskać więcej informacji, zobacz LabelText i odnośniki do elementów tekstowych XML.

WebpageControlOptions

Opcjonalny Control elementu potype="WebpageControl"

Element kontenera, który określa opcje dla formantu strony sieci Web.

Aby uzyskać więcej informacji, zobacz WebpageControlOptions Elementy XML — Odwołanie.

Elementy, które filtrować i wyświetlić relacje łącza

Możesz użyć LinksControlOptions elementu do definiowania opcje do sterowania tym, co stanowi łącze można dodać do elementu pracy i domyślne kolumny, które mają być wyświetlane dla listy łączy w elemencie pracy.Po dodaniu łącza do formularza elementu pracy, można określić filtry ograniczyć typy łączy, czy użytkownicy mogą tworzyć i typy elementów pracy między użytkownikami, których można tworzyć łącza.LinksControlOptions Elementu i jego elementów podrzędnych ma następującą strukturę:

<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>

W szczególności możesz używać elementów, które przedstawiono w poniższej tabeli.Aby uzyskać więcej informacji na temat używania tych elementów, zobacz Zmiana sterowania łączami w taki sposób, aby ograniczyć relacje pomiędzy nimi i Elementy LinksControlOptions.

Element

Wymagany?

Opis

LinksControlOptions

Opcjonalny Control elementu potype="LinksControl"

Udostępnia kontener dla elementów, które określają opcje kontrolujące jakie łącza można dodać do elementu pracy i domyślne kolumny, które mają być wyświetlane dla listy łączy w elemencie pracy.

WorkItemLinkFilters

Opcjonalny LinksControlOptions elementu

Udostępnia kontener dla jednego lub kilku Filter kryteria na potrzeby typy łączy, które są definiowane dla kolekcji projektów zespołowych filtrowania elementów, które określają łącza.

ExternalLinkFilters

Opcjonalny LinksControlOptions elementu

Udostępnia kontener dla jednego lub kilku Filter elementy, które Określ kryteria filtrowania na potrzeby łącze typów zdefiniowanych w innych projektów zespołowych.

WorkItemTypeFilters

Opcjonalny LinksControlOptions elementu

Udostępnia kontener dla jednego lub kilku Filter elementy, które Określ kryteria filtrowania, które ma być stosowana do elementu pracy typów.

Filter(typy łączy)

Wymagane WorkItemLinkFilters elementu po FilterType atrybut jest exclude lub include.

Wymagane ExternalLinkFilters elementu po FilterType atrybut jest exclude lub include.

Określa typy łączy lub wykluczane z zestawu łączy, które mogą być tworzone dla elementu roboczego.

Filter(typy elementów roboczych)

Opcjonalny WorkItemTypeFilters elementu po FilterType atrybut jest exclude lub include.

Określa typy elementów roboczych lub wykluczane z zestawu typów elementów pracy między którymi można połączyć użytkowników.

LinkColumns

Opcjonalny LinksControlOptions elementu

Udostępnia kontener dla jednego lub kilku LinkColumn tagów.

LinkColumn

Wymagane LinkColumns elementu

Określa pola elementów roboczych i atrybuty typu łącza pojawi się w formularzu elementu pracy dla listy łącza.

Zobacz też

Koncepcje

Projektowanie formularza elementu roboczego

Inne zasoby

Śledzenie elementu pracy: Indeks do definicji elementów XML