WebReferenceCollection

.NET Framework クラス ライブラリ リファレンス

WebReferenceCollection クラス

メモ : このクラスは、.NET Framework version 2.0 で新しく追加されたものです。

WebReference オブジェクトのコレクションを記述します。

名前空間: System.Web.Services.Description
アセンブリ: System.Web.Services (system.web.services.dll 内)
構文

Visual Basic (宣言)

Public NotInheritable Class
 WebReferenceCollection
    Inherits CollectionBase

Visual Basic (使用法)

Dim instance As WebReferenceCollection

C#

public sealed class WebReferenceCollection
 : CollectionBase

C++

public ref class WebReferenceCollection sealed
 : public CollectionBase

J#

public final class WebReferenceCollection extends
 CollectionBase

JScript

public final class WebReferenceCollection extends
 CollectionBase

解説

ServiceDescriptionImporter クラスの静的な GenerateWebReferences メソッドを呼び出すときに、このクラスを使用して WebReference オブジェクトのコレクションを渡します。

使用例

このクラスの使用方法を示すコードの例を次に示します。

C#

using System;
using System.CodeDom;
using System.CodeDom.Compiler;
using System.Security.Permissions;
using System.Web.Services;
using System.Web.Services.Description;
using System.Web.Services.Discovery;
using System.Xml;
using System.Xml.Serialization;

class Test
{

    [SecurityPermissionAttribute(SecurityAction.Demand, Unrestricted=true)]
    static void Run(){

   // Get a WSDL file describing a service.
        ServiceDescription description = ServiceDescription.Read("DataTypes_CS.wsdl");

    // Initialize a service description importer.
    ServiceDescriptionImporter importer = new ServiceDescriptionImporter();
    importer.ProtocolName = "Soap12";  // Use SOAP 1.2.
    importer.AddServiceDescription(description,null,null);

    // Report on the service descriptions.
    Console.WriteLine("Importing {0} service descriptions with {1} associated
 schemas.",
                      importer.ServiceDescriptions.Count, importer.Schemas.Count);

    // Generate a proxy client.
    importer.Style = ServiceDescriptionImportStyle.Client;

    // Generate properties to represent primitive values.
    importer.CodeGenerationOptions = System.Xml.Serialization.CodeGenerationOptions.GenerateProperties;

    // Initialize a Code-DOM tree into which we will import the service.
    CodeNamespace nmspace = new CodeNamespace();
    CodeCompileUnit unit1 = new CodeCompileUnit();
    unit1.Namespaces.Add(nmspace);

    // Import the service into the Code-DOM tree. This creates proxy
 code
    // that uses the service.
    ServiceDescriptionImportWarnings warning = importer.Import(nmspace, unit1);

    if (warning == 0)
    {
        // Generate and print the proxy code in C#.
        CodeDomProvider provider1 = CodeDomProvider.CreateProvider("CSharp");
        provider1.GenerateCodeFromCompileUnit(unit1, Console.Out, new
 CodeGeneratorOptions());
    }
    else
    {
        // Print an error message.
        Console.WriteLine("Warning: " + warning); 
    }


        string url = "AddNumbers.wsdl";

        // Read in a WSDL service description.
        XmlTextReader reader = new XmlTextReader(url);
        ServiceDescription wsdl = ServiceDescription.Read(reader);

        // Create a WSDL collection.
        DiscoveryClientDocumentCollection wsdlCollection = new
 DiscoveryClientDocumentCollection();
        wsdlCollection.Add(url, wsdl);

        // Create a namespace and a unit for compilation.
        CodeNamespace space = new CodeNamespace();
        CodeCompileUnit unit = new CodeCompileUnit();
        unit.Namespaces.Add(space);

        // Create a web referernce using the WSDL collection.
        WebReference reference = new WebReference(wsdlCollection,
 space);
        reference.ProtocolName = "Soap12";

        // Print some information about the web reference.
        Console.WriteLine("Base Url = {0}", reference.AppSettingBaseUrl);
        Console.WriteLine("Url Key = {0}", reference.AppSettingUrlKey);
        Console.WriteLine("Documents = {0}", reference.Documents.Count);

        // Create a web reference collection.
        WebReferenceCollection references = new WebReferenceCollection();
        references.Add(reference);

        // Compile a proxy client and print out the code. 
        CodeDomProvider provider = CodeDomProvider.CreateProvider("CSharp");
        WebReferenceOptions options = new WebReferenceOptions();
        options.Style = ServiceDescriptionImportStyle.Client;
        options.CodeGenerationOptions = CodeGenerationOptions.GenerateNewAsync;
        ServiceDescriptionImporter.GenerateWebReferences(
            references,
            provider,
            unit,
            options        
        );
        provider.GenerateCodeFromCompileUnit(unit, Console.Out, new
 CodeGeneratorOptions() );          
    
    }

    static void Main ()
    {

        Test.Run();
 

    }
}

継承階層

System.Object
   System.Collections.CollectionBase
    System.Web.Services.Description.WebReferenceCollection

スレッド セーフ

この型の public static (Visual Basic では Shared) メンバはすべて、スレッド セーフです。インスタンス メンバの場合は、スレッド セーフであるとは限りません。

プラットフォーム

Windows 98, Windows 2000 SP4, Windows Millennium Edition, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0

参照

関連項目
WebReferenceCollection メンバ
System.Web.Services.Description 名前空間

WebReferenceCollection コンストラクタ

メモ : このコンストラクタは、.NET Framework version 2.0 で新しく追加されたものです。

WebReferenceCollection クラスの新しいインスタンスを初期化します。

名前空間: System.Web.Services.Description
アセンブリ: System.Web.Services (system.web.services.dll 内)
構文

Visual Basic (宣言)

Public Sub New

Visual Basic (使用法)

Dim instance As New WebReferenceCollection

C#

public WebReferenceCollection ()

C++

public:
WebReferenceCollection ()

J#

public WebReferenceCollection ()

JScript

public function WebReferenceCollection ()

使用例

このコンストラクタの使用方法を示すコードの例を次に示します。このコード例は、WebReferenceCollection クラスのトピックで取り上げているコード例の一部分です。

C#

// Create a web reference collection.
WebReferenceCollection references = new WebReferenceCollection();
references.Add(reference);

プラットフォーム

Windows 98, Windows 2000 SP4, Windows Millennium Edition, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0

参照

関連項目
WebReferenceCollection クラス
WebReferenceCollection メンバ
System.Web.Services.Description 名前空間

WebReferenceCollection プロパティ

パブリック プロパティ

( プロテクト プロパティ も参照)

	名前	説明
	Capacity	CollectionBase に格納できる要素の数を取得または設定します。 ( CollectionBase から継承されます。)
	Count	CollectionBase インスタンスに格納されている要素の数を取得します。このプロパティはオーバーライドできません。 ( CollectionBase から継承されます。)
	Item	指定したインデックス位置にある WebReference インスタンスを取得または設定します。

プロテクト プロパティ

	名前	説明
	InnerList	CollectionBase インスタンス内の要素のリストを格納する ArrayList を取得します。 ( CollectionBase から継承されます。)
	List	CollectionBase インスタンス内の要素のリストを格納する IList を取得します。 ( CollectionBase から継承されます。)

参照

関連項目

WebReferenceCollection クラス
System.Web.Services.Description 名前空間

WebReferenceCollection メソッド

パブリック メソッド

( プロテクト メソッド も参照)

	名前	説明
	Add	WebReference インスタンスをコレクションに追加します。
	Clear	CollectionBase インスタンスからすべてのオブジェクトを削除します。このメソッドはオーバーライドできません。 ( CollectionBase から継承されます。)
	Contains	コレクションに、指定した WebReference インスタンスが格納されているかどうかを判断します。
	CopyTo	指定した配列インデックスを開始位置として、指定した配列にコレクションのメンバをコピーします。
	Equals	オーバーロードされます。 2 つの Object インスタンスが等しいかどうかを判断します。 ( Object から継承されます。)
	GetEnumerator	CollectionBase インスタンスを反復処理する列挙子を返します。 ( CollectionBase から継承されます。)
	GetHashCode	特定の型のハッシュ関数として機能します。GetHashCode は、ハッシュ アルゴリズムや、ハッシュ テーブルのようなデータ構造での使用に適しています。 ( Object から継承されます。)
	GetType	現在のインスタンスの Type を取得します。 ( Object から継承されます。)
	IndexOf	指定した WebReference インスタンスのインデックスを確認します。
	Insert	指定したインデックス位置に指定した WebReference インスタンスを挿入します。
	ReferenceEquals	指定した複数の Object インスタンスが同一かどうかを判断します。 ( Object から継承されます。)
	Remove	指定した WebReference インスタンスをコレクションから削除します。
	RemoveAt	CollectionBase インスタンスの指定したインデックスにある要素を削除します。このメソッドはオーバーライドできません。 ( CollectionBase から継承されます。)
	ToString	現在の Object を表す String を返します。 ( Object から継承されます。)

プロテクト メソッド

	名前	説明
	Finalize	Object がガベージ コレクションにより収集される前に、その Object がリソースを解放し、その他のクリーンアップ操作を実行できるようにします。 ( Object から継承されます。)
	MemberwiseClone	現在の Object の簡易コピーを作成します。 ( Object から継承されます。)
	OnClear	CollectionBase インスタンスの内容を消去するときに、追加のカスタム プロセスを実行します。 ( CollectionBase から継承されます。)
	OnClearComplete	CollectionBase インスタンスの内容を消去した後に、追加のカスタム プロセスを実行します。 ( CollectionBase から継承されます。)
	OnInsert	CollectionBase インスタンスに新しい要素を挿入する前に、追加のカスタム プロセスを実行します。 ( CollectionBase から継承されます。)
	OnInsertComplete	CollectionBase インスタンスに新しい要素を挿入した後に、追加のカスタム プロセスを実行します。 ( CollectionBase から継承されます。)
	OnRemove	CollectionBase インスタンスから要素を削除するときに、追加のカスタム プロセスを実行します。 ( CollectionBase から継承されます。)
	OnRemoveComplete	CollectionBase インスタンスから要素を削除した後に、追加のカスタム プロセスを実行します。 ( CollectionBase から継承されます。)
	OnSet	CollectionBase インスタンスに値を設定する前に、追加のカスタム プロセスを実行します。 ( CollectionBase から継承されます。)
	OnSetComplete	CollectionBase インスタンスに値を設定した後に、追加のカスタム プロセスを実行します。 ( CollectionBase から継承されます。)
	OnValidate	値を検証するときに、追加のカスタム プロセスを実行します。 ( CollectionBase から継承されます。)

参照

関連項目

WebReferenceCollection クラス
System.Web.Services.Description 名前空間

WebReferenceCollection メンバ

WebReference オブジェクトのコレクションを記述します。

WebReferenceCollection データ型で公開されるメンバを以下の表に示します。

パブリック コンストラクタ

	名前	説明
	WebReferenceCollection	WebReferenceCollection クラスの新しいインスタンスを初期化します。

パブリック プロパティ

( プロテクト プロパティ も参照)

	名前	説明
	Capacity	CollectionBase に格納できる要素の数を取得または設定します。(CollectionBase から継承されます。)
	Count	CollectionBase インスタンスに格納されている要素の数を取得します。このプロパティはオーバーライドできません。(CollectionBase から継承されます。)
	Item	指定したインデックス位置にある WebReference インスタンスを取得または設定します。

プロテクト プロパティ

	名前	説明
	InnerList	CollectionBase インスタンス内の要素のリストを格納する ArrayList を取得します。(CollectionBase から継承されます。)
	List	CollectionBase インスタンス内の要素のリストを格納する IList を取得します。(CollectionBase から継承されます。)

パブリック メソッド

( プロテクト メソッド も参照)

	名前	説明
	Add	WebReference インスタンスをコレクションに追加します。
	Clear	CollectionBase インスタンスからすべてのオブジェクトを削除します。このメソッドはオーバーライドできません。 (CollectionBase から継承されます。)
	Contains	コレクションに、指定した WebReference インスタンスが格納されているかどうかを判断します。
	CopyTo	指定した配列インデックスを開始位置として、指定した配列にコレクションのメンバをコピーします。
	Equals	オーバーロードされます。 2 つの Object インスタンスが等しいかどうかを判断します。 (Object から継承されます。)
	GetEnumerator	CollectionBase インスタンスを反復処理する列挙子を返します。 (CollectionBase から継承されます。)
	GetHashCode	特定の型のハッシュ関数として機能します。GetHashCode は、ハッシュ アルゴリズムや、ハッシュ テーブルのようなデータ構造での使用に適しています。 (Object から継承されます。)
	GetType	現在のインスタンスの Type を取得します。 (Object から継承されます。)
	IndexOf	指定した WebReference インスタンスのインデックスを確認します。
	Insert	指定したインデックス位置に指定した WebReference インスタンスを挿入します。
	ReferenceEquals	指定した複数の Object インスタンスが同一かどうかを判断します。 (Object から継承されます。)
	Remove	指定した WebReference インスタンスをコレクションから削除します。
	RemoveAt	CollectionBase インスタンスの指定したインデックスにある要素を削除します。このメソッドはオーバーライドできません。 (CollectionBase から継承されます。)
	ToString	現在の Object を表す String を返します。 (Object から継承されます。)

プロテクト メソッド

	名前	説明
	Finalize	Object がガベージ コレクションにより収集される前に、その Object がリソースを解放し、その他のクリーンアップ操作を実行できるようにします。 (Object から継承されます。)
	MemberwiseClone	現在の Object の簡易コピーを作成します。 (Object から継承されます。)
	OnClear	CollectionBase インスタンスの内容を消去するときに、追加のカスタム プロセスを実行します。 (CollectionBase から継承されます。)
	OnClearComplete	CollectionBase インスタンスの内容を消去した後に、追加のカスタム プロセスを実行します。 (CollectionBase から継承されます。)
	OnInsert	CollectionBase インスタンスに新しい要素を挿入する前に、追加のカスタム プロセスを実行します。 (CollectionBase から継承されます。)
	OnInsertComplete	CollectionBase インスタンスに新しい要素を挿入した後に、追加のカスタム プロセスを実行します。 (CollectionBase から継承されます。)
	OnRemove	CollectionBase インスタンスから要素を削除するときに、追加のカスタム プロセスを実行します。 (CollectionBase から継承されます。)
	OnRemoveComplete	CollectionBase インスタンスから要素を削除した後に、追加のカスタム プロセスを実行します。 (CollectionBase から継承されます。)
	OnSet	CollectionBase インスタンスに値を設定する前に、追加のカスタム プロセスを実行します。 (CollectionBase から継承されます。)
	OnSetComplete	CollectionBase インスタンスに値を設定した後に、追加のカスタム プロセスを実行します。 (CollectionBase から継承されます。)
	OnValidate	値を検証するときに、追加のカスタム プロセスを実行します。 (CollectionBase から継承されます。)

参照

関連項目

WebReferenceCollection クラス
System.Web.Services.Description 名前空間