Control XML 要素のリファレンス
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"
Padding="(top, bottom, left, right)"
Margin="(top, bottom, left, right)" 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 単純型です。 次の組み込み型のいずれかの文字列を指定します。
詳細については、「作業項目フォーム上のコントロールの指定」を参照してください。 注意 Type 属性にカスタム値を設定すると、カスタム コントロールを使用できます。Type 値が組み込み型の名前と一致しない場合、そのコントロールはカスタム コントロールと見なされます。詳細については、Microsoft Web サイトの「Work Item Tracking Custom Controls」を参照してください。 |
ControlFontSize |
省略可能な Control 属性です。 フォーム上のフィールド名またはラベルのフォント サイズを指定します。 FontSize の有効値は small、normal、large、xlarge、および xxlarge です。 |
EmptyText |
省略可能な Control 属性です。 フィールドが空のときに表示されるテキスト文字列の長さを 1 ～ 255 文字で指定します。 |
Label |
省略可能な Control 属性です。 コントロールを識別する、フォーム上に表示されるテキストを指定します。 80 文字以下の文字列を指定します。 |
LabelFontSize |
フォーム上のラベルのフォント サイズを指定します。 FontSize の有効値は、small、normal、large、xlarge、および xxlarge です。 |
LabelPosition |
省略可能な Control 属性です。 コントロールのデータに対するラベルの相対位置を指定します。 次のいずれかの文字列を指定します。
|
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 です。 次のいずれかの文字列を指定します。
|
MinimumSize |
省略可能な Control 属性です。 コントロールがフォーム上で占める大きさの最小サイズ (ピクセル単位) を指定します。 構文は、(width,height) の形式で指定します。 属性型は SizeType です。 パターン値: ^\(\d+\,\d+\)$ パターン値の例: (100,100) 注意 高さが十分でない場合は、スクロール バーが表示されて、最小サイズが維持されます。この属性を指定しないと、より多くの領域を使用してその他のタブにコントロールが表示されるのでない限り、コントロールは既定のサイズで表示されます。1 つのフォーム コントロールの全体のサイズは、最も大きなフォーム領域またはタブのサイズによって決まります。 |
Name |
省略可能な Control 属性です。 コントロールを一意に識別します。 フォーム上の複数のコントロールが同じ作業項目フィールドに関連付けられる場合、Name は重要です。 属性型は xs:string です。 注意 フォーム上の複数の場所に同じフィールドを表示する場合は、Name 属性を使用します。それぞれのコントロール エントリの Name 属性に一意の値を指定すると、システムはそれぞれのコントロールを一意に識別できるようになります。これは、タブのコンテキストに基づいて同じコントロールをさまざまな場所に表示する場合に役立ちます。 |
NumberFormat |
省略可能な Control 属性で、FieldControl と共に使用する場合にのみ有効です。 フィールド コントロールに入力できる文字を指定します。 使用できる有効値は、次のとおりです。
|
MaxLength |
省略可能な Control 属性で、FieldControl と共に使用する場合にのみ有効です。 フィールド コントロールに入力できる文字列長の上限を指定します。 属性型は xs:integer です。 |
Format |
省略可能な Control 属性で、DateTimeControl と共に使用する場合にのみ有効です。 DateTimePickerFormat の列挙値の 1 つに対応する日時フィールドの形式を指定します。 使用できる有効値は、次のとおりです。
詳細については、Microsoft Web サイトの「DateTimePickerFormat 列挙体」を参照してください。 |
CustomFormat |
省略可能な Control 属性で、DateTimeControl と Format 属性と共に使用する場合にのみ有効です。 DateTimePicker.CustomFormat プロパティに定義されている構文に対応する日時フィールドのカスタム形式を指定します。 詳細については、Microsoft Web サイトの「DateTimePicker.CustomFormat プロパティ」を参照してください。 |
子要素
要素 |
説明 |
|---|---|
省略可能な要素です。 この要素は、Type 属性が FieldControl または LabelControl に指定されている場合に、指定できます。 テキスト、ハイパーリンク、およびテキストの一部がハイパーリンクに関連付けられているフィールドまたはラベルの位置を指定するためのコンテナー要素です。 詳細については、「LabelText および Text XML 要素のリファレンス」および「作業項目フォームでのヘルプ テキスト、ハイパーリンク、または Web コンテンツの提供」を参照してください。 |
|
省略可能な要素です。 この要素は、Type 属性が FieldControl または LabelControl に指定されている場合に、指定できます。 フィールドやラベルに対するハイパーリンクを定義します。 詳細については、「Link および Param XML 要素のリファレンス」および「作業項目フォームでのヘルプ テキスト、ハイパーリンク、または Web コンテンツの提供」を参照してください。 |
|
省略可能な要素です。 この要素は、Type 属性が LinksControl に指定されている場合に、指定できます。 リンクの一覧を表示する列フィールドのリンク フィルターおよびレイアウトを定義します。 詳細については、「リンク コントロールの定義とリンク関係の制限」を参照してください。 |
|
省略可能な要素です。 この要素は、Type 属性が WebpageControl に指定されている場合に、指定できます。 作業項目フォームへの対象 Web ページの読み込みを制御するコントロールを指定します。 詳細については、「WebpageControlOptions XML 要素のリファレンス」および「作業項目フォームでのヘルプ テキスト、ハイパーリンク、または Web コンテンツの提供」を参照してください。 |
|
anyAttribute |
省略可能な要素です。 省略可能です。 Control 要素を使用すると、anyAttribute の機能を拡張できます。 |
親要素
要素 |
説明 |
|---|---|
必須。 作業項目フォームに要素を表示する方法を定義します。 |
|
Column 要素 |
必ず指定します。 フォームの列を定義します。 |
Tab 要素 |
必ず指定します。 フォームのタブを定義します。 |
解説
Control は、Layout、Column、および Tab の子要素で、省略可能な要素です。
Layout および Column インジケーター:
minOccurs = "0"
maxOccurs = "1"
Tab インジケーター:
minOccurs = "0"
maxOccurs = "unbounded"
カスタム コントロールを実装するには、Type 属性に対するコントロールの名前を指定する必要があります。 詳細については、Microsoft Web サイトの「Work Item Tracking Custom Controls」を参照してください。
各コントロール型の例については、「作業項目フォーム上のコントロールの指定」を参照してください。
使用例
<Control Type=" WorkItemClassificationControl " FieldName="System.AreaPath"
Label="Area" LabelPosition="Left" Padding="(2,0,2,0)" Margin="(2,2,2,2)" />
要素情報
名前空間 |
https://schemas.microsoft.com/VisualStudio/2008/workitemtracking/typedef |
スキーマ名 |
作業項目の種類の定義 |
検証ファイル |
WorkItemTypeDefinition.xsd |
要素型 |
ControlType 複合型 |
空も使用できる |
利用不可 |