SoapProtocolImporter Class

.NET Framework (current version)

Other Versions

Use BaseTrue

Generates classes for Web services that use the SOAP protocol.

Namespace: System.Web.Services.Description
Assembly: System.Web.Services (in System.Web.Services.dll)

Inheritance Hierarchy

System.Object
System.Web.Services.Description.ProtocolImporter
System.Web.Services.Description.SoapProtocolImporter

Syntax

C++

[PermissionSetAttribute(SecurityAction.LinkDemand, Name = "FullTrust")]
[PermissionSetAttribute(SecurityAction.InheritanceDemand, Name = "FullTrust")]
public class SoapProtocolImporter : ProtocolImporter

Constructors

	Name	Description
	SoapProtocolImporter()	Initializes a new instance of the SoapProtocolImporter class.

Properties

	Name	Description
	AbstractSchemas	Gets the abstract XML schemas used by the associated ServiceDescriptionImporter instance.(Inherited from ProtocolImporter.)
	Binding	Gets the Web Services Description Language (WSDL) binding that the protocol importer is currently processing to generate a class.(Inherited from ProtocolImporter.)
	ClassName	Gets the name of the binding class that is currently being generated.(Inherited from ProtocolImporter.)
	ClassNames	Gets the CodeIdentifiers object that generates a unique name for the binding class that is currently being generated.(Inherited from ProtocolImporter.)
	CodeNamespace	Gets a representation of the .NET Framework namespace of the binding classes that are being generated.(Inherited from ProtocolImporter.)
	CodeTypeDeclaration	Gets a representation of the binding class that is currently being generated.(Inherited from ProtocolImporter.)
	ConcreteSchemas	Gets the concrete XML schemas used by the associated ServiceDescriptionImporter instance.(Inherited from ProtocolImporter.)
	InputMessage	Gets the Web Services Description Language (WSDL) input message for the abstract operation that the protocol importer is currently processing to generate a method in a binding class.(Inherited from ProtocolImporter.)
	MethodName	Gets the name of the binding class method which that the protocol importer is currently generating.(Inherited from ProtocolImporter.)
	Operation	Gets the abstract Web Services Description Language (WSDL) operation that the protocol importer is currently processing to generate a method in a binding class.(Inherited from ProtocolImporter.)
	OperationBinding	Gets the Web Services Description Language (WSDL) operation binding that the protocol importer is currently processing to generate a method in a binding class.(Inherited from ProtocolImporter.)
	OutputMessage	Gets the Web Services Description Language (WSDL) output message for the abstract operation that the protocol importer is currently processing to generate a method in a binding class.(Inherited from ProtocolImporter.)
	Port	Gets a Web Services Description Language (WSDL) port that contains a reference to the binding that the protocol importer is currently processing to generate a binding class. If more than one port refers to the current binding, the current port is the one in which the binding has most recently been found.(Inherited from ProtocolImporter.)
	PortType	Gets the Web Services Description Language (WSDL) PortType that is implemented by the binding that the protocol importer is currently processing to generate a binding class.(Inherited from ProtocolImporter.)
	ProtocolName	Gets a value of "Soap".(Overrides ProtocolImporter.ProtocolName.)
	Schemas	Gets all the XML schemas, both abstract and concrete, used by the associated ServiceDescriptionImporter instance.(Inherited from ProtocolImporter.)
	Service	Gets the Web Services Description Language (WSDL) service that contains a reference to the binding that the protocol importer is currently processing to generate a binding class.(Inherited from ProtocolImporter.)
	ServiceDescriptions	Gets the ServiceDescriptionCollection objects that belong to the associated ServiceDescriptionImporter instance that are searched for bindings from which to generate binding classes.(Inherited from ProtocolImporter.)
	SoapBinding	Gets a SoapBinding instance obtained through the SoapBinding property's Extensions property.
	SoapExporter	Gets the object of type SoapCodeExporter used internally by the SoapProtocolImporter class to generate code from mappings between SOAP-encoded XML schema content and .NET Framework types.
	SoapImporter	Gets the object of type SoapSchemaImporter used internally by the SoapProtocolImporter class to generate mappings between SOAP-encoded XML schema content and .NET Framework types.
	Style	Gets an enumeration value that indicates whether a client proxy class or an abstract server class is being generated. The values are Client and Server. The value is that of the associated ServiceDescriptionImporter instance's Style property.(Inherited from ProtocolImporter.)
	Warnings	Gets or sets a ServiceDescriptionImportWarnings enumeration value that indicates the types of warnings, if any, issued by the protocol importer while generating binding classes.(Inherited from ProtocolImporter.)
	XmlExporter	Gets the object of type XmlCodeExporter used internally by the SoapProtocolImporter class to generate code from mappings between literal XML schema content and .NET Framework types.
	XmlImporter	Gets the object of type XmlSchemaImporter used internally by the SoapProtocolImporter class to generate mappings between literal XML schema content and .NET Framework types.

Methods

	Name	Description
	AddExtensionWarningComments(CodeCommentStatementCollection, ServiceDescriptionFormatExtensionCollection)	For each unhandled extension or XML element in the input extensions collection, turns on a RequiredExtensionsIgnored or OptionalExtensionsIgnored warning for each unhandled extension or XML element in the input extensions collection. (Inherited from ProtocolImporter.)
	BeginClass()	Initializes the generation of a binding class.(Overrides ProtocolImporter.BeginClass().)
	BeginNamespace()	Performs initialization for an entire code namespace during code generation.(Overrides ProtocolImporter.BeginNamespace().)
	EndClass()	Processes a binding class after the generation of methods.(Overrides ProtocolImporter.EndClass().)
	EndNamespace()	Performs processing for an entire code namespace after binding class generation.(Overrides ProtocolImporter.EndNamespace().)
	Equals(Object)	Determines whether the specified object is equal to the current object.(Inherited from Object.)
	Finalize()	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)
	GenerateMethod()	Generates method code for a binding class.(Overrides ProtocolImporter.GenerateMethod().)
	GetHashCode()	Serves as the default hash function. (Inherited from Object.)
	GetType()	Gets the Type of the current instance.(Inherited from Object.)
	IsBindingSupported()	Determines whether a class can be generated for the current binding.(Overrides ProtocolImporter.IsBindingSupported().)
	IsOperationFlowSupported(OperationFlow)	Determines whether the current operation's operation flow is supported.(Overrides ProtocolImporter.IsOperationFlowSupported(OperationFlow).)
	IsSoapEncodingPresent(String)	Checks for the presence of "http://schemas.xmlsoap.org/soap/encoding/" in a string that represents a list of Uniform Resource Indicators (URIs).
	MemberwiseClone()	Creates a shallow copy of the current Object.(Inherited from Object.)
	OperationBindingSyntaxException(String)	Produces an Exception indicating that the current OperationBinding instance for which a binding class is being generated is invalid within the target namespace.(Inherited from ProtocolImporter.)
	OperationSyntaxException(String)	Produces an Exception indicating that the current Operation instance for which a binding class is being generated is invalid within the target namespace.(Inherited from ProtocolImporter.)
	ToString()	Returns a string that represents the current object.(Inherited from Object.)
	UnsupportedBindingWarning(String)	Turns on an UnsupportedBindingsIgnored warning in the ServiceDescriptionImportWarnings enumeration obtained through the Warnings property. This method also adds a warning message to the comments for the class that is being generated.(Inherited from ProtocolImporter.)
	UnsupportedOperationBindingWarning(String)	Turns on an UnsupportedOperationsIgnored warning in the ServiceDescriptionImportWarnings enumeration obtained through the Warnings property. This method also adds a warning message to the comments for the class that is being generated.(Inherited from ProtocolImporter.)
	UnsupportedOperationWarning(String)	Turns on an UnsupportedOperationsIgnored warning in the ServiceDescriptionImportWarnings enumeration obtained through the Warnings property. This method also adds a warning message to the comments for the class that is being generated.(Inherited from ProtocolImporter.)

The SoapProtocolImporter class generates client proxy code or abstract server code according to the SOAP protocol. The class generates a class for each supported binding defined in a Web Services Description Language (WSDL) document.

Typically, instead of invoking SoapProtocolImporter directly, a developer uses the class indirectly through the ServiceDescriptionImporter class.

Version Information

.NET Framework
Available since 1.1

Thread Safety

Any public static ( Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.