ServiceDescription クラス

定義

XML Web サービスの記述に必要な名前空間、要素、および属性を完全に備えた、有効な Web サービス記述言語 (WSDL: Web Services Description Language) ドキュメント ファイルを作成する方法およびフォーマット方法を提供します。Provides a means of creating and formatting a valid Web Services Description Language (WSDL) document file, complete with appropriate namespaces, elements, and attributes, for describing an XML Web service. このクラスは継承できません。This class cannot be inherited.

public ref class ServiceDescription sealed : System::Web::Services::Description::NamedItem
[System.Web.Services.Configuration.XmlFormatExtensionPoint("Extensions")]
public sealed class ServiceDescription : System.Web.Services.Description.NamedItem
type ServiceDescription = class
    inherit NamedItem
Public NotInheritable Class ServiceDescription
Inherits NamedItem
継承
ServiceDescription
継承
ServiceDescription
属性

ServiceDescription クラスのインスタンスを作成する方法の例を次に示します。The following example shows how to create an instance of the ServiceDescription class.

// Obtain the ServiceDescription of existing Wsdl.
ServiceDescription^ myDescription = ServiceDescription::Read( "MyWsdl_CS.wsdl" );

// Remove the Binding from the Binding Collection of ServiceDescription.
BindingCollection^ myBindingCollection = myDescription->Bindings;
myBindingCollection->Remove( myBindingCollection[ 0 ] );

// Form a new Binding.
Binding^ myBinding = gcnew Binding;
myBinding->Name = "Service1Soap";
XmlQualifiedName^ myXmlQualifiedName = gcnew XmlQualifiedName( "s0:Service1Soap" );
myBinding->Type = myXmlQualifiedName;
SoapBinding^ mySoapBinding = gcnew SoapBinding;
mySoapBinding->Transport = "http://schemas.xmlsoap.org/soap/http";
mySoapBinding->Style = SoapBindingStyle::Document;
OperationBinding^ addOperationBinding = CreateOperationBinding( "Add", myDescription->TargetNamespace );
myBinding->Operations->Add( addOperationBinding );
myBinding->Extensions->Add( mySoapBinding );

// Add the Binding to the ServiceDescription.
myDescription->Bindings->Add( myBinding );
myDescription->Write( "MyOutWsdl.wsdl" );
// Obtain the ServiceDescription of existing Wsdl.
ServiceDescription myDescription = ServiceDescription.Read("MyWsdl_CS.wsdl");
// Remove the Binding from the Binding Collection of ServiceDescription.
BindingCollection myBindingCollection = myDescription.Bindings;
myBindingCollection.Remove(myBindingCollection[0]);

// Form a new Binding.
Binding myBinding = new Binding();
myBinding.Name = "Service1Soap";
XmlQualifiedName myXmlQualifiedName = 
                     new XmlQualifiedName("s0:Service1Soap");
myBinding.Type = myXmlQualifiedName;

SoapBinding mySoapBinding = new SoapBinding();
mySoapBinding.Transport = "http://schemas.xmlsoap.org/soap/http";
mySoapBinding.Style = SoapBindingStyle.Document;

OperationBinding addOperationBinding = 
       CreateOperationBinding("Add",myDescription.TargetNamespace);
myBinding.Operations.Add(addOperationBinding);
myBinding.Extensions.Add(mySoapBinding);

// Add the Binding to the ServiceDescription.
myDescription.Bindings.Add(myBinding);
myDescription.Write("MyOutWsdl.wsdl");
' Obtain the ServiceDescription of existing Wsdl.
Dim myDescription As ServiceDescription = ServiceDescription.Read("MyWsdl_VB.wsdl")
' Remove the Binding from the Binding Collection of ServiceDescription.
Dim myBindingCollection As BindingCollection = myDescription.Bindings
myBindingCollection.Remove(myBindingCollection(0))

' Form a new Binding.
Dim myBinding As New Binding()
myBinding.Name = "Service1Soap"
Dim myXmlQualifiedName As New XmlQualifiedName("s0:Service1Soap")
myBinding.Type = myXmlQualifiedName

Dim mySoapBinding As New SoapBinding()
mySoapBinding.Transport = "http://schemas.xmlsoap.org/soap/http"
mySoapBinding.Style = SoapBindingStyle.Document

Dim addOperationBinding As OperationBinding = CreateOperationBinding("Add", _
                                             myDescription.TargetNamespace)
myBinding.Operations.Add(addOperationBinding)
myBinding.Extensions.Add(mySoapBinding)

' Add the Binding to the ServiceDescription.
myDescription.Bindings.Add(myBinding)
myDescription.Write("MyOutWsdl.wsdl")

注釈

このクラスのインスタンスは、 newキーワードまたは静的Readメソッドのいずれかを使用して作成できます。このメソッドは、WSDL ファイルを解析し、その値をクラスの適切なメンバーに割り当てます。Instances of this class can be created with either the new keyword or the static Read method, which parses a WSDL file and assigns its values to appropriate members of the class.

WSDL は、xml Web サービスを記述するための XML ベースの言語です。WSDL is an XML-based language for describing XML Web services. クラスServiceDescriptionは、WSDL ファイルのルートdefinitions要素に対応しています。The ServiceDescription class corresponds to the root element, definitions, of a WSDL file. WSDL の詳細については、WSDL 仕様を参照してください。For more information about WSDL, see the WSDL specification.

コンストラクター

ServiceDescription()

ServiceDescription クラスの新しいインスタンスを初期化します。Initializes a new instance of the ServiceDescription class.

フィールド

Namespace

ServiceDescription クラスが定義されている XML 名前空間 ("http://schemas.xmlsoap.org/wsdl/")。The XML namespace in which the ServiceDescription class is defined ("http://schemas.xmlsoap.org/wsdl/"). このフィールドは定数です。This field is constant.

プロパティ

Bindings

Binding に格納されている ServiceDescription 要素のコレクションを取得します。Gets the collection of Binding elements contained in the ServiceDescription.

Documentation

DocumentableItem のインスタンスのテキスト ドキュメントを取得または設定します。Gets or sets the text documentation for the instance of the DocumentableItem.

(継承元 DocumentableItem)
DocumentationElement

DocumentableItem のドキュメント要素を取得または設定します。Gets or sets the documentation element for the DocumentableItem.

(継承元 DocumentableItem)
ExtensibleAttributes

Web Services Interoperability (WS-I) Basic Profile 1.1 に準拠する WSDL の属性の拡張機能を表す XmlAttribute 型の配列を取得または設定します。Gets or sets an array of type XmlAttribute that represents attribute extensions of WSDL to comply with Web Services Interoperability (WS-I) Basic Profile 1.1.

(継承元 DocumentableItem)
Extensions

ServiceDescription に格納されている機能拡張要素のコレクションを取得します。Gets the collection of extensibility elements contained in the ServiceDescription.

Imports

Import に格納されている ServiceDescription 要素のコレクションを取得します。Gets the collection of Import elements contained in the ServiceDescription.

Messages

Message に格納されている ServiceDescription 要素のコレクションを取得します。Gets the collection of Message elements contained in the ServiceDescription.

Name

Web サービス記述言語 (WSDL) ファイルを囲む descriptions タグの XML 名前属性を取得または設定します。Gets or sets the XML name attribute of the descriptions tag enclosing the Web Services Description Language (WSDL) file.

Namespaces

ServiceDescription オブジェクトが生成されるときに名前空間プレフィックスと名前空間を保持するために使用する、名前空間プレフィックスと名前空間のディクショナリを取得または設定します。Gets or sets the dictionary of namespace prefixes and namespaces used to preserve namespace prefixes and namespaces when a ServiceDescription object is constructed.

(継承元 DocumentableItem)
PortTypes

PortType に格納されている ServiceDescription 要素のコレクションを取得します。Gets the collection of PortType elements contained in the ServiceDescription.

RetrievalUrl

ServiceDescription インスタンスが適用される XML Web サービスの URL を取得または設定します。Gets or sets the URL of the XML Web service to which the ServiceDescription instance applies.

Schema

この ServiceDescription に関連付けられているスキーマを取得します。Gets the schema associated with this ServiceDescription.

Serializer

ServiceDescription オブジェクトと Web サービス記述言語 (WSDL: Web Services Description Language) ドキュメント間のシリアル化および逆シリアル化に使用される XML シリアライザーを取得します。Gets the XML serializer used to serialize and deserialize between a ServiceDescription object and a Web Services Description Language (WSDL) document.

ServiceDescriptions

ServiceDescriptionCollection がメンバーとして含まれている ServiceDescription インスタンスを取得します。Gets the ServiceDescriptionCollection instance of which the ServiceDescription is a member.

Services

Service に格納されている ServiceDescription インスタンスのコレクションを取得します。Gets the collection of Service instances contained in the ServiceDescription.

TargetNamespace

Web サービス記述言語 (WSDL :Web Services Description Language) ファイルを囲む targetNamespace タグの XML descriptions 属性を取得または設定します。Gets or sets the XML targetNamespace attribute of the descriptions tag enclosing a Web Services Description Language (WSDL) file.

Types

Types に格納された ServiceDescription を取得または設定します。Gets or sets the Types contained by the ServiceDescription.

ValidationWarnings

StringCollectionRead(Stream, Boolean)Read(TextReader, Boolean)、または Read(String, Boolean) を、true に設定した validate パラメーターを指定して呼び出したときに生成された検証の警告を格納する Read(XmlReader, Boolean) を取得します。Gets a StringCollection that contains any validation warnings that were generated during a call to Read(Stream, Boolean), Read(TextReader, Boolean), Read(String, Boolean), or Read(XmlReader, Boolean) with the validate parameter set to true.

メソッド

CanRead(XmlReader)

XmlReader が、解析できる有効な Web サービス記述言語 (WSDL: Web Services Description Language) ファイルを表すかどうかを示す値を取得します。Gets a value that indicates whether an XmlReader represents a valid Web Services Description Language (WSDL) file that can be parsed.

Equals(Object)

指定されたオブジェクトが現在のオブジェクトと等しいかどうかを判定します。Determines whether the specified object is equal to the current object.

(継承元 Object)
GetHashCode()

既定のハッシュ関数として機能します。Serves as the default hash function.

(継承元 Object)
GetType()

現在のインスタンスの Type を取得します。Gets the Type of the current instance.

(継承元 Object)
MemberwiseClone()

現在の Object の簡易コピーを作成します。Creates a shallow copy of the current Object.

(継承元 Object)
Read(Stream)

ServiceDescription インスタンスから XML を直接読み込んで Stream クラスのインスタンスを初期化します。Initializes an instance of the ServiceDescription class by directly loading the XML from a Stream instance.

Read(Stream, Boolean)

ServiceDescription インスタンスから XML を直接読み込んで Stream クラスのインスタンスを初期化します。Initializes an instance of the ServiceDescription class by directly loading the XML from a Stream instance.

Read(String)

指定したファイルから XML を直接読み込んで ServiceDescription オブジェクトのインスタンスを初期化します。Initializes an instance of a ServiceDescription object by directly loading the XML from the specified file.

Read(String, Boolean)

指定したファイルから XML を直接読み込んで ServiceDescription オブジェクトのインスタンスを初期化します。Initializes an instance of a ServiceDescription object by directly loading the XML from the specified file.

Read(TextReader)

ServiceDescription から XML を直接読み込んで TextReader クラスのインスタンスを初期化します。Initializes an instance of the ServiceDescription class by directly loading the XML from a TextReader.

Read(TextReader, Boolean)

ServiceDescription から XML を直接読み込んで TextReader クラスのインスタンスを初期化します。Initializes an instance of the ServiceDescription class by directly loading the XML from a TextReader.

Read(XmlReader)

ServiceDescription から XML を直接読み込んで XmlReader クラスのインスタンスを初期化します。Initializes an instance of the ServiceDescription class by directly loading the XML from an XmlReader.

Read(XmlReader, Boolean)

ServiceDescription から XML を直接読み込んで XmlReader クラスのインスタンスを初期化します。Initializes an instance of the ServiceDescription class by directly loading the XML from an XmlReader.

ToString()

現在のオブジェクトを表す string を返します。Returns a string that represents the current object.

(継承元 Object)
Write(Stream)

ServiceDescription を指定した Stream に書き込みます。Writes out the ServiceDescription to the specified Stream.

Write(String)

ServiceDescription を Web サービス記述言語 (WSDL) ファイルとして指定したパスに書き込みます。Writes out the ServiceDescription as a Web Services Description Language (WSDL) file to the specified path.

Write(TextWriter)

ServiceDescription を、Web サービス記述言語 (WSDL) ファイルとして TextWriter に書き込みます。Writes out the ServiceDescription as a Web Services Description Language (WSDL) file to the TextWriter.

Write(XmlWriter)

ServiceDescription を、Web サービス記述言語 (WSDL) ファイルとして XmlWriter に書き込みます。Writes out the ServiceDescription to the XmlWriter as a Web Services Description Language (WSDL) file.

適用対象