Referenční dokumentace všech elementů XML FORM
Informace v tomto tématu můžete použít jako rychlou referenci na všechny elementy a hlavní atributy, které řídí formulář pro typ pracovní položky.Zadejte tyto prvky v FORM kontejner elementu, třetím a posledním hlavní části definice typu pracovní položky.Mnoho prvků jsou vnořené ve ostatním uživatelům ke skupinám formuláře, oddíly nebo karty v formuláře pracovních položek.Další informace o tom, jak seskupit tyto prvky naleznete v tématu Návrh formuláře pracovní položky.
V tomto tématu
Příklad formuláře
Syntaxe pro prvků formuláře
Atributy, které určují prvků formuláře
Elementy, které určují samostatné popisky, hypertextových odkazů, webových stránek a obsah HTML
Elementy, které filtrovat a zobrazit odkaz relace
Příklad formuláře
Následující příklad ukazuje celkovou strukturu FORM elementu.Určete rozložení formuláře pomocí Layout elementu.Můžete zadat různá rozložení, které se zaměřují různé klienty.Například můžete zadat jedno rozložení pro klienty se systémem Windows a jiné rozložení pro Team Web Access.Rozložení se obvykle skládá z horní části formuláře a potom skupinu záložek.Pořadí, ve kterém můžete definovat elementů v rámci rozvržení určuje pořadí, ve kterém elementy zobrazeny ve formuláři.
Seskupit elementy zobrazit v rámci sloupce s použitím Group a Column elementy.Můžete použít Control elementu, který chcete definovat každé pole, které se mají zobrazit ve formuláři.Můžete použít Tab elementu, který chcete podporují různé funkční oblasti skupiny polí.
<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="&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>
Prvky formuláře
Můžete určit, jakým způsobem jsou seskupeny pole informace a pracovních položek a vložit do formuláře pracovních položek pomocí elementů, které jsou popsány v následující tabulce.
[!POZNÁMKA]
Nejlepších výsledků dosáhnete, by měl vnořit Control elementů v Group, a má vnořit Group elementů v Column, i v případě sloupec využito na celou šířku formuláře.Navíc by měl vnořit každých Column v oddílu Group, i když skupině nemá žádný viditelný popisek nebo hranice.
Prvek |
Popis |
Povinné? |
|
---|---|---|---|
Column |
Rozdělí oblastí formuláře na sloupce.
|
Doporučeno |
|
Control |
Definuje pole, text, hypertextový odkaz nebo jiného elementu ovládacího prvku na formulář pracovní položky.
Další informace naleznete v tématu Control – referenční dokumentace elementu XML. |
Požadováno |
|
FORM |
Definuje elementem formuláře nejvyšší úrovně.
|
Požadováno |
|
Group |
Poskytuje visual seskupení prvků, podobně jako skupinový rámeček systému Windows.
|
Doporučeno |
|
Layout |
Definuje rozložení formulář pracovní položky.
|
Požadováno |
|
Splitter |
Rozdělí formuláře na dvě oblasti pro podporu rozložení dva elementy formuláře na stejné úrovni.
|
Nepovinné |
|
Tab |
Definuje rozložení jednu kartu ve skupině karty.
|
Nepovinné |
|
TabGroup |
Definuje jedna nebo více karet pro daný formulář.
|
Nepovinné |
Atributy, které slouží k formátování prvků formuláře
Mezery a velikost mnoho elementů na formulář pracovní položky můžete ovládat tak, že určíte atributy, které jsou popsány v následující tabulce.Další informace naleznete v tématu Návrh formuláře pracovní položky.
Atribut |
Popis |
Použít elementy |
---|---|---|
ControlSpacing |
Volitelné.Určuje svislé posun ovládacích prvků.Celé číslo. |
Layout |
FixedWidth |
Volitelné.Šířka sloupce v pixelech.PercentWidtha FixedWidth se vzájemně vylučují. |
Column |
Label |
Volitelné.Text, který se zobrazí u ovládacího prvku nebo skupiny.Pokud je zadán popisek, přepíše všechny popisek, který je přidružen k poli v metadata pro ovládací prvek. Požadovaná Tab elementu.Text, který se zobrazí na kartu. LabelText je textový řetězec, který obsahuje mezi 1 až 80 znaků. |
Control Group Tab |
LabelPosition |
Volitelné.Popisek pozici vzhledem k datům pole.Možné hodnoty jsou nahoru, dolů, doleva a doprava. |
Control |
LabelSpacing |
Volitelné.Určuje počet pixelů mezi popiskem a upravit oblast ovládacího prvku. |
Layout |
Margin |
Volitelné.Řetězec ve formě (vlevo, horního, pravého, dolního), který určuje velikost místa kolem ovládacího prvku a mezi ovládacího prvku a jeho okolí v pixelech.Velikost místa na obou stranách může lišit. Hodnota vzorku: ^ \(\d+\,\d+\,\d+\,\d+\)$ Příklad hodnoty vzor: (2,0,2,0) |
Control Group Layout Tab TabGroup |
MinimumSize |
Volitelné.Řetězec ve formě (šířka, výšku).Tato hodnota určuje minimální velikost samotný formulář.Když ovládací prvek menší než velikost tohoto kontejneru, zobrazí se posuvníky vodorovně a svisle. |
Control Layout |
Name |
Volitelné.Název ovládacího prvku.Je-li tento parametr zadán, název je stejný jako FieldName. |
Control |
Padding |
Volitelné.Řetězec formuláři (nejvyšší, dolů, doleva, doprava), který určuje v pixelech množství prostor kolem vnějšího okraje ovládacího prvku a kolem uvnitř ohraničení.Velikost místa na obou stranách může lišit. |
Control Group Layout Tab TabGroup |
PercentWidth |
Volitelné.Šířka sloupce jako procentní podíl šířky nadřazeného elementu.PercentWidtha FixedWidth se vzájemně vylučují. |
Column |
ReadOnly |
Volitelné.Pole jen pro čtení lze zobrazit v ovládacím prvku.Různé ovládací prvky reagovat na tento atribut několika různými způsoby. |
Control |
Target |
Volitelné.Řetězec, který určuje, na který klient se vztahuje toto rozložení.Visual StudioZobrazí tento typ pracovní položky v tomto rozvržení, pokud Target atributu je vynechán nebo nastaven na Windows Forms.Externí klienti pomocí vlastní můžete zadat další rozložení Target atributy, které Visual Studio ignoruje. Platné jsou následující hodnoty:
|
Layout |
Type |
Požadováno.Typ ovládacího prvku.Další informace naleznete v tématu Control – referenční dokumentace elementu XML. |
Control |
Elementy, které určují samostatné popisky, hypertextových odkazů, webových stránek nebo obsah ve formátu HTML
WebpageControlOptions Elementu a jeho podřízených elementů mít následující strukturu syntaxe:
<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>
Můžete použít prvky, které jsou popsány v následující tabulce můžete definovat ve formátu prostého textu nebo hypertextového odkazu popisky, přidat hypertextové odkazy na pole nebo zobrazit obsah webové stránky v formuláře pracovních položek.Další informace naleznete v tématu Poskytnutí textu nápovědy, hypertextových odkazů nebo webového obsahu ve formuláři pracovní položky.
Prvek |
Povinné? |
Popis |
|
---|---|---|---|
Content |
Volitelný WebpageControlOptions elementu. |
Určuje obsah ve formátu CDATA HTML objevit formuláře pracovních položek.
Další informace naleznete v tématu Referenční dokumentace XML elementů WebpageControlOptions. |
|
LabelText |
Volitelný Control element při type="LabelControl". |
Definuje buď prostý nebo s hypertextovým odkazem popisku. Další informace naleznete v tématu Referenční dokumentace XML elementů LabelText a Text. |
|
Link |
Volitelný Control element při type="FieldControl". Volitelný Text elementu. Volitelný WebpageControl elementu. Volitelný WebpageControlOptions elementu. |
Definuje hypertextový odkaz na pole, popisku nebo webového prohlížeče obsahu se zobrazí v formuláře pracovních položek.
Další informace naleznete v tématu Referenční dokumentace XML elementů odkazů a parametrů. |
|
Param |
Volitelný Link elementu. |
Určuje hodnotu, která určuje adresu URL hypertextového odkazu při URLPath je určena pro Link elementu.
Další informace naleznete v tématu Referenční dokumentace XML elementů odkazů a parametrů. |
|
Text |
Volitelný LabelText elementu. |
Kontejner prvku informace nebo popisku na formulář pracovní položky.
Další informace naleznete v tématu Referenční dokumentace XML elementů LabelText a Text. |
|
WebpageControlOptions |
Volitelný Control element přitype="WebpageControl" |
Element kontejneru, který určuje možnosti pro ovládací prvek webové stránky. Další informace naleznete v tématu Referenční dokumentace XML elementů WebpageControlOptions. |
Elementy, které filtrovat a zobrazit odkaz relace
Můžete použít LinksControlOptions elementu, který chcete definovat možnosti pro ovládání, co odkazy mohou být přidány do pracovní položkou a výchozí sloupce, které chcete zobrazit seznam odkazů v pracovní položku.Když přidáte odkaz ovládacího prvku formuláře pracovních položek, můžete určit filtry, které omezit typy odkazů, zda mohou uživatelé vytvářet a typy pracovních položek, mezi které uživatele můžete vytvořit vazbu.LinksControlOptions Elementu a jeho podřízených elementů mít následující strukturu:
<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>
Konkrétně používají prvky, které je uveden v následující tabulce.Další informace o tom, jak používat tyto prvky naleznete v tématu Definice řízení propojení s cílem omezit vztahy určené propojeními a LinksControlOptions – elementy.
Prvek |
Povinné? |
Popis |
---|---|---|
LinksControlOptions |
Volitelný Control element přitype="LinksControl" |
Poskytuje kontejner pro prvky, které definují možnosti pro kontrolu odkazy, které mohou být přidány do pracovní položkou a výchozí sloupce, které chcete zobrazit seznam odkazů v pracovní položku. |
WorkItemLinkFilters |
Volitelný LinksControlOptions element |
Poskytuje kontejner pro jednu nebo více Filter elementy, které určují odkaz filtrovat kritéria, která má být použit pro typy odkazů, které jsou definovány pro kolekce týmových projektů. |
ExternalLinkFilters |
Volitelný LinksControlOptions element |
Poskytuje kontejner pro jednu nebo více Filter odkaz na elementy, které určují kritéria filtru, který má být použit pro typy, které jsou definovány v jiné týmové projekty. |
WorkItemTypeFilters |
Volitelný LinksControlOptions element |
Poskytuje kontejner pro jednu nebo více Filter elementy, které určují kritéria filtru, který má být použita pro pracovní položky typy. |
Filter(typy odkazů) |
Požadované WorkItemLinkFilters element při FilterType atribut je exclude nebo include. Požadované ExternalLinkFilters element při FilterType atribut je exclude nebo include. |
Určuje typy odkazů, které chcete zahrnout nebo vyloučit ze sady odkazů, které lze vytvořit pro pracovní položku. |
Filter(pracovní položky typy) |
Volitelný WorkItemTypeFilters element při FilterType atribut je exclude nebo include. |
Určuje typy pracovních položek, které chcete zahrnout nebo vyloučit z sadu pracovní položka typů mezi kterými lze propojit uživatelů. |
LinkColumns |
Volitelný LinksControlOptions element |
Poskytuje kontejner pro jednu nebo více LinkColumn klíčová slova. |
LinkColumn |
Požadované LinkColumns element |
Určuje pole pracovních položek a atributy typu odkaz na formulář pracovní položky pro seznam odkazů. |
Viz také
Koncepty
Návrh formuláře pracovní položky