次の方法で共有


Control XML 要素のリファレンス

Control 要素は、作業項目フォームに表示する作業項目フィールド、テキスト、ハイパーリンク、またはその他のコントロール要素の定義に使用します。この要素の使用方法の例については、「作業項目フォーム上のコントロールの指定」を参照してください。詳細については、「作業項目フォームのデザインとカスタマイズ」を参照してください。

スキーマの階層

WITD

   WORKITEMTYPE

       FORM

           [レイアウト]

               グループ

               [列]

               タブ

<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" 
Dock="Fill | Top | Bottom | Left | Right" Padding="(left, top, right, bottom)" 
Margin="(left, top, right, bottom)" ReadOnly="True | False" MinimumSize="(width,height)" 
Name="InstanceName" >
<LabelText> . . . </LabelText>
<Link> . . . </Link>
<LinksControlOptions> . . . </LinksControlOptions>
<WebpageControlOptions> . . . </WebpageControlOptions>
</Control>

属性および要素

以降のセクションでは、属性、子要素、および親要素について説明します。

属性

属性

Description

FieldName

省略可能な Control 型の属性です。

コントロールに関連付ける作業項目フィールドを指定します。属性型は typelib:ReferenceFieldName です。最小長は 1、最大長は 70 です。

パターン値 : ^[a-zA-Z_][a-zA-Z0-9_]*(\.[a-zA-Z0-9_]+)+$

パターン値の例 : Company.Division.IssueType

Type

必須の Control 属性です。

コントロールのデータ型を指定します。属性型は ValidControlsType 単純型です。次の組み込み型のいずれかの文字列を指定します。

  • AttachmentControl: 作業項目の添付ファイルの表示に使用します。このコントロールには、関連付けられているフィールドまたはフィールドの種類はありません。

  • DateTimeControl: フィールドの種類が DateTime の書式指定された日付フィールドの表示に使用します。

  • FieldControl: プレーンテキスト フィールドまたは数値フィールド、およびフィールドの種類が String、Identity、Integer、Double、および PlainText のフィールドの値リストの表示に使用します。

  • HtmlFieldControl: フィールドの種類が HTML のフィールドの複数行のリッチ テキスト形式の表示に使用します。

  • LabelControl: フィールドが関連付けられていないテキストの表示に使用します。テキストは、プレーンテキストでもハイパーリンクでもかまいません。その他のコントロールを使用してを指定することができます、 LabelText、 LinkとTextの要素。詳細については、「LabelText および Text XML 要素のリファレンス」および「Link および Param XML 要素のリファレンス」を参照してください。

  • LinksControl: リンク コントロール ツールバーを表示し、作業項目とストーリー ボードのリンクの関係を管理するには、使用します。このコントロールには、関連付けられているフィールドまたはフィールドの種類はありません。フィルターを使用して他のコントロール オプションへのリンクの種類を指定、 LinksControlOptions要素。「LinksControlOptions 要素」を参照してください。

  • WebpageControl: URI により定義されているか、CDATA タグ内に埋め込まれている HTML ベースのコンテンツの表示に使用します。このコントロールには、関連付けられているフィールドまたはフィールドの種類はありません。.コンテンツとリンクを使用してを表示するを指定、 WebpageControlOptions要素。「WebpageControlOptions XML 要素のリファレンス」を参照してください。

  • WorkItemClassificationControl: フィールドの種類が TreePath の階層パス フィールドの表示に使用します。

    メモメモ
    System.AreaPath フィールドと System.IterationPath フィールドだけがこのデータ型を使用します。このデータ型を使用して、カスタム フィールドを定義することはできません。
  • WorkItemLogControl: 作業項目の履歴情報と、フィールドの種類が History のフィールドの表示に使用します。

    メモメモ
    System.History フィールドだけがこのデータ型を使用します。このデータ型を使用して、カスタム フィールドを定義することはできません。

詳細については、「作業項目フォーム上のコントロールの指定」を参照してください。

メモメモ
Type 属性にカスタム値を設定すると、カスタム コントロールを使用できます。 Type 値が組み込み型の名前と一致しない場合、そのコントロールはカスタム コントロールと見なされます。詳細については、Microsoft Web サイトの「Work Item Tracking Custom Controls (作業項目トラッキング カスタム コントロール)」を参照してください。

ControlFontSize

省略可能な Control 型の属性です。

フィールド名、またはラベルのフォント サイズには、フォーム上を指定します。Valid values of FontSize: small, normal, large, xlarge, and xxlarge.

EmptyText

省略可能な Control 型の属性です。

1 ~ 255 の文字でフィールドが空の場合に表示される文字列を指定します。

Label

省略可能な Control 型の属性です。

コントロールを識別する、フォーム上に表示されるテキストを指定します。80 文字以下の文字列を指定します。

LabelFontSize

ラベルのフォント サイズには、フォーム上を指定します。Valid values for FontSize: small, normal, large, xlarge, and xxlarge.

LabelPosition

省略可能な Control 型の属性です。

コントロールのデータに対するラベルの相対位置を指定します。次のいずれかの文字列を指定します。

  • Top: ラベルをコントロール データの上に配置します。

  • Bottom: ラベルをコントロール データの下に配置します。

  • Left: ラベルをコントロール データの左側に配置します。

  • Right: ラベルをコントロール データの右側に配置します。

Dock

省略可能な Control 型の属性です。

コンテナー内の指定した辺に合わせてフィールドを配置します。または、コンテナーの全面にフィールドを拡張します。属性型は DockType です。次のいずれかの文字列を指定します。

  • Fill: コンテナー全体に表示されるようにフィールドを配置します。この値は Splitter 要素でサポートされている方向ではありません。

  • Top: フィールドをコンテナーの上部に合わせて配置します。この値は Splitter 要素でサポートされている方向ではありません。

  • Bottom: フィールドをコンテナーの下部に合わせて配置します。この値は Splitter 要素でサポートされている方向ではありません。

  • Left: フィールドをコンテナーの左側に合わせて配置します。

  • Right: フィールドをコンテナーの右側に合わせて配置します。この値は Splitter 要素でサポートされている方向ではありません。

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 です。次のいずれかの文字列を指定します。

  • True: コントロール データを読み取り専用として指定します。

  • False: コントロール データが読み取り専用でないことを指定します。

MinimumSize

省略可能な Control 型の属性です。

コントロールがフォーム上で占める大きさの最小サイズ (ピクセル単位) を指定します。構文は、(width,height) の形式で指定します。属性型は SizeType です。

パターン値 : ^\(\d+\,\d+\)$

パターン値の例 : (100,100)

メモメモ
高さが十分でない場合は、スクロール バーが表示されて、最小サイズが維持されます。この属性を指定しないと、より多くの領域を使用してその他のタブにコントロールが表示されるのでない限り、コントロールは既定のサイズで表示されます。1 つのフォーム コントロールの全体のサイズは、最も大きなフォーム領域またはタブのサイズによって決まります。

Name

省略可能な Control 型の属性です。

コントロールを一意に識別します。フォーム上の複数のコントロールが同じ作業項目フィールドに関連付けられる場合、Name は重要です。属性型は xs:string です。

メモメモ
フォーム上の複数の場所に同じフィールドを表示する場合は、Name 属性を使用します。両方のコントロール エントリに対する Name 属性に一意の値を指定すると、システムはそれぞれのコントロールを一意に識別できるようになります。タブのコンテキストに基づいてさまざまな場所に同じコントロールを表示するときに、役に立ちます。

NumberFormat

省略可能な Control 属性で、FieldControl と共に使用する場合にのみ有効です。

フィールド コントロールに入力できる文字を指定します。使用できる有効値は、次のとおりです。

  • WholeNumbers: 整数を入力できることを指定します。

  • SignedWholeNumbers: 符号付き整数を入力できることを指定します。

  • DecimalNumbers: 10 進数を入力できることを指定します。

  • SignedDecimalNumbers: 符号付き 10 進数を入力できることを指定します。

MaxLength

省略可能な Control 属性で、FieldControl と共に使用する場合にのみ有効です。

フィールド コントロールに入力できる文字列長の上限を指定します。属性型は xs:integer です。

Format

省略可能な Control 属性で、DateTimeControl と共に使用する場合にのみ有効です。

DateTimePickerFormat の列挙値の 1 つに対応する日時フィールドの形式を指定します。使用できる有効値は、次のとおりです。

  • Custom: 日付/時刻値をカスタム書式で表示します。カスタム書式は、Format 属性の値に 'Custom' を指定し、CustomFormat という名前の別の属性にカスタム書式指定文字列を設定することで、設定できます。次に例を示します。

    Format="Custom"

    CustomFormat = "MMM dd, 'of the year' yyyy "

    詳細については、Microsoft Web サイトの「DateTimePicker.CustomFormat プロパティ」を参照してください。

  • Long: ユーザーのオペレーティング システムで設定されている長い日付形式で日付/時刻値を表示します。

  • Short: ユーザーのオペレーティング システムで設定されている短い日付形式で日付/時刻値を表示します。

  • Time: ユーザーのオペレーティング システムで設定されている時刻の形式で日付/時刻値を表示します。

詳細については、Microsoft Web サイトの「DateTimePickerFormat 列挙体」を参照してください。

CustomFormat

省略可能な Control 属性で、DateTimeControl と Format 属性と共に使用する場合にのみ有効です。

DateTimePicker.CustomFormat プロパティに定義されている構文に対応する日時フィールドのカスタム形式を指定します。詳細については、Microsoft Web サイトの「DateTimePicker.CustomFormat プロパティ」を参照してください。

子要素

要素

Description

LabelText

省略可能な要素です。この要素を指定することができますと、 Type属性を指定してFieldControlまたはLabelControl。

テキスト、ハイパーリンク、およびテキストの一部がハイパーリンクに関連付けられているフィールドまたはラベルの位置を指定するためのコンテナー要素です。

詳細については、「LabelText および Text XML 要素のリファレンス」および「作業項目フォーム上の Web ページへのヘルプ テキスト、プロセス ガイダンス、Web コンテンツ、およびリンクの追加」を参照してください。

Link

省略可能な要素です。この要素を指定することができますと、 Type属性を指定してFieldControlまたはLabelControl。

フィールドやラベルに対するハイパーリンクを定義します。

詳細については、「Link および Param XML 要素のリファレンス」および「作業項目フォーム上の Web ページへのヘルプ テキスト、プロセス ガイダンス、Web コンテンツ、およびリンクの追加」を参照してください。

LinksControlOptions

省略可能な要素です。この要素を指定することができますと、 Type属性を指定してLinksControl。

リンクの一覧を表示する列フィールドのリンク フィルターおよびレイアウトを定義します。

詳細については、「リンク コントロールの定義とリンク関係の制限」を参照してください。

WebpageControlOptions

省略可能な要素です。この要素を指定することができる場合、 Type属性がWebpageControl。

作業項目フォームへの対象 Web ページの読み込みを制御するコントロールを指定します。

詳細については、「WebpageControlOptions XML 要素のリファレンス」および「作業項目フォーム上の Web ページへのヘルプ テキスト、プロセス ガイダンス、Web コンテンツ、およびリンクの追加」を参照してください。

anyAttribute

省略可能な要素です。

省略可能です。anyAttribute 要素を使用すると、Control の機能を拡張できます。

親要素

要素

Description

[レイアウト]

必ず指定します。作業項目フォームに要素を表示する方法を定義します。

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

要素情報

名前空間

https://schemas.microsoft.com/VisualStudio/2008/workitemtracking/typedef

スキーマ名

作業項目の種類の定義

検証ファイル

WorkItemTypeDefinition.xsd

要素の型

ControlType 複合型

空も使用できる

該当なし

参照

概念

作業項目フォームのデザインとカスタマイズ

すべての FORM XML 要素のリファレンス

作業項目フォーム上のコントロールの指定