Visual Basic における XML IntelliSense

[アーティクル]
08/09/2011

Visual Basic コードエディターには、XML スキーマで定義されている要素の単語入力を補完する、XML 用の IntelliSense 機能が付属しています。 XML スキーマ定義 (XSD: XML Schema Definition) ファイルをプロジェクトに追加し、スキーマの対象名前空間を Imports ステートメントを使用してインポートすると、コードエディターによって、XSD スキーマの要素が、XElement オブジェクトと XDocument オブジェクト用の IntelliSense 有効メンバー変数リストに取り込まれます。 XElement オブジェクト用の IntelliSense メンバーリストを次に示します。

XML IntelliSense

Visual Basic での XML IntelliSense の有効化

Visual Basic で XML IntelliSense を有効にするには、XSD スキーマファイルを Visual Basic プロジェクトに追加する必要があります。また、XSD スキーマの対象名前空間を Imports ステートメントを使用してコードファイルにインポートする必要があります。また、Visual Basic プロジェクトデザイナーの [参照] ページを使用して、プロジェクトレベルの名前空間リストにスキーマの名前空間を追加することもできます。例については、「方法 : Visual Basic で XML IntelliSense を有効にする」を参照してください。詳細については、「Imports ステートメント (XML 名前空間)」および「[参照設定] ページ (プロジェクトデザイナー) (Visual Basic)」を参照してください。

既定では、Visual Basic プロジェクトの XSD スキーマファイルは表示されません。プロジェクトに追加する XSD ファイルを選択するには、[すべてのファイルを表示] ボタンをクリックすることが必要な場合があります。

スキーマファイルの生成 (スキーマの推論)

Visual Studio の XML ツールを使用して XSD スキーマを推論することにより、既存の XML ファイル用の XSD スキーマを作成できます。

SP1 より、XML to Schema ウィザードを使用して、1 つ以上の XML ドキュメントから推論される XML スキーマセットを作成し、プロジェクトに追加できるようになりました。テキストファイル形式の XML ドキュメント、HTTP インターネットアドレスからの XML、および XML to Schema ウィザードに入力するか貼り付ける XML を任意に組み合わせて使用できます。 XML to Schema ウィザードにアクセスするには、[プロジェクト] メニューの [新しい項目の追加] をクリックし、[データ] と [共通項目] のいずれかのテンプレートグループから XML to Schema テンプレートを追加します。 XML スキーマセットを推論する対象の XML ドキュメントソースをすべて追加したら、[OK] をクリックして推論されるスキーマセットを作成します。詳細については、「XML to Schema ウィザード (Visual Basic)」および「方法: XML to Schema ウィザードを使用して XML スキーマセットを作成する (Visual Basic)」を参照してください。
Visual Studio XML エディターを使用して XML ファイルから XSD スキーマセットを推論することもできます。 XML エディターを使用して XML スキーマセットを作成するには、Visual Studio の XML デザイナーで XML ファイルを開き、[XML] メニューの [スキーマの作成] をクリックします。作成した XSD スキーマセットは、1 つ以上の XSD ファイルに保存し、プロジェクトに追加できます。詳細については、「方法 : Visual Basic で XML IntelliSense を有効にする」を参照してください。

スキーマが同じである必要のある複数の XML ドキュメントから、複数の異なる XSD スキーマセットが推論される場合があることに注意してください。このようなことは、特定の要素と属性がいずれかの XML だけに存在したり、含まれている要素の順序が異なっていたりする場合に、発生する可能性があります。 XSD スキーマの推論を使用するときは、推論された XSD スキーマセットが完全で正確であることを確認する必要があります。

メンバーリスト

ピリオド (.) を入力して XElement オブジェクトまたは XDocument オブジェクトのインスタンスか、IEnumerable(Of XElement) または IEnumerable(Of XDocument) のインスタンスを区切ると、Visual Basic IntelliSense によって、使用可能なオブジェクトメンバーの一覧が表示されます。この初期リストには、次に示す XML 軸プロパティを表す 3 つのオプションが含まれます。

オプション	説明
< >	使用可能な子要素の一覧を表示するには、このオプションを選択します。詳細については、XML 要素リテラル (Visual Basic) メソッドと Elements メソッドを参照してください。
@	使用可能な属性の一覧を表示するには、このオプションを選択します。詳細については、「XML 軸プロパティ (Visual Basic)」を参照してください。このオプションは、XElement 型のオブジェクトに対してのみ使用できます。
…< >	使用可能な子孫要素の一覧を表示するには、このオプションを選択します。詳細については、方法 : XML 子孫要素にアクセスする (Visual Basic) メソッドと Elements メソッドを参照してください。

一覧から任意の XML オプションを選択するか、入力を開始します。選択したオプションに固有の XML スキーマのメンバーで、使用可能なメンバーが、メンバーリストに表示されます。特定の XML 名前空間プレフィックスに関連付けられた XML 名前空間をインポートしている場合は、使用可能な XML 名前空間プレフィックスの一覧もメンバーリストに表示されます。

たとえば、次のような XSD スキーマがあるとします。

<?xml version="1.0" encoding="utf-8"?>
<xs:schema attributeFormDefault="unqualified" 
           elementFormDefault="qualified" 
           targetNamespace="http://SamplePurchaseOrder" 
           xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:element name="PurchaseOrders">
    <xs:complexType>
      <xs:sequence>
        <xs:element name="PurchaseOrder">
          <xs:complexType>
            <xs:sequence>
              <xs:element name="Address" />
              <xs:element name="Items" />
              <xs:element name="Comment" />
            </xs:sequence>
            <xs:attribute name="PurchaseOrderNumber" type="xs:unsignedShort" use="required" />
            <xs:attribute name="OrderDate" type="xs:string" use="required" />
          </xs:complexType>
        </xs:element>
      </xs:sequence>
    </xs:complexType>
  </xs:element>
</xs:schema>

この XSD スキーマで有効な XML は次のようになります。

<?xml version="1.0"?>
<PurchaseOrders xmlns="http://SamplePurchaseOrder">
  <PurchaseOrder PurchaseOrderNumber="12345" OrderDate="2000-1-1">
    <Address />
    <Items />
    <Comment />
  </PurchaseOrder>
</PurchaseOrders>

この XSD スキーマファイルをプロジェクトに追加し、スキーマの対象名前空間を XSD スキーマからコードファイルまたはプロジェクトにインポートすると、Visual Basic コードの入力時に、Visual Basic IntelliSense によって、このスキーマのメンバーが表示されます。 XSD スキーマの対象名前空間を既定の名前空間としてインポートし、次のように入力すると、IntelliSense によって、PurchaseOrder XML 要素の使用可能な子要素の一覧が表示されます。

Dim po = <PurchaseOrder />
po.<

この一覧は、Address、Comment、および Items の各要素で構成されます。

IntelliSense リスト項目の確実性のレベル

IntelliSense で使用する XSD 型の判別は厳密ではありません。その結果として、XML IntelliSense では多くの場合、使用可能なメンバーを示す展開されたリストが表示されます。 IntelliSense メンバーリストから項目を選択しやすくするために、項目は、XML IntelliSense で特定のメンバーに割り当てられている確実性のレベルを示すインジケーターと共に表示されます。

XML IntelliSense は、XSD スキーマの特定の型を識別できる場合があります。そのような場合、その XSD 型で使用できる高い確実性がある子要素、属性、または子孫要素が表示されます。これらの項目は、チェックマークによって識別されます。

ただし、XML IntelliSense は、XSD スキーマの特定の型を識別できない場合もあります。そのような場合、プロジェクトで使用できる確実性の低い XSD スキーマの子要素、属性、または子孫要素を示す展開されたリストが表示されます。これらの項目は、疑問符によって識別されます。