SoapDocumentServiceAttribute Class (System.Web.Services.Protocols)

Switch View :
Classic
Lightweight
ScriptFree
.NET Framework Class Library
SoapDocumentServiceAttribute Class

Applying the optional SoapDocumentServiceAttribute to an XML Web service sets the default format of SOAP requests and responses sent to and from XML Web service methods within the XML Web service.

Inheritance Hierarchy
System.Object
  System.Attribute
    System.Web.Services.Protocols.SoapDocumentServiceAttribute

Namespace:  System.Web.Services.Protocols
Assembly:  System.Web.Services (in System.Web.Services.dll)
Syntax
Visual Basic
<AttributeUsageAttribute(AttributeTargets.Class)> _
Public NotInheritable Class SoapDocumentServiceAttribute _
	Inherits Attribute
C#
[AttributeUsageAttribute(AttributeTargets.Class)]
public sealed class SoapDocumentServiceAttribute : Attribute
Visual C++
[AttributeUsageAttribute(AttributeTargets::Class)]
public ref class SoapDocumentServiceAttribute sealed : public Attribute
F#
[<Sealed>]
[<AttributeUsageAttribute(AttributeTargets.Class)>]
type SoapDocumentServiceAttribute =  
    class
        inherit Attribute
    end

The SoapDocumentServiceAttribute type exposes the following members.

Constructors
  Name Description
Public method SoapDocumentServiceAttribute() Initializes a new instance of the SoapDocumentServiceAttribute class setting all properties to their default values.
Public method SoapDocumentServiceAttribute(SoapBindingUse) Initializes a new instance of the SoapDocumentServiceAttribute class setting the parameter formatting.
Public method SoapDocumentServiceAttribute(SoapBindingUse, SoapParameterStyle) Initializes a new instance of the SoapDocumentServiceAttribute class that sets the parameter formatting and sets whether parameters are encapsulated within a single XML element, under the Body element, in SOAP messages.
Top
Properties
  Name Description
Public property ParameterStyle Gets or sets the default setting that controls whether parameters are encapsulated within a single element following the <Body> element in the XML portion of a SOAP message for XML Web service methods of the XML Web service.
Public property RoutingStyle Gets or sets how SOAP messages are routed to the XML Web service.
Public property TypeId When implemented in a derived class, gets a unique identifier for this Attribute. (Inherited from Attribute.)
Public property Use Gets or sets the default parameter formatting for an XML Web service.
Top
Methods
  Name Description
Public method Equals Infrastructure. Returns a value that indicates whether this instance is equal to a specified object. (Inherited from Attribute.)
Protected method Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public method GetHashCode Returns the hash code for this instance. (Inherited from Attribute.)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Public method IsDefaultAttribute When overridden in a derived class, indicates whether the value of this instance is the default value for the derived class. (Inherited from Attribute.)
Public method Match When overridden in a derived class, returns a value that indicates whether this instance equals a specified object. (Inherited from Attribute.)
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Public method ToString Returns a string that represents the current object. (Inherited from Object.)
Top
Explicit Interface Implementations
  Name Description
Explicit interface implemetation Private method _Attribute.GetIDsOfNames Maps a set of names to a corresponding set of dispatch identifiers. (Inherited from Attribute.)
Explicit interface implemetation Private method _Attribute.GetTypeInfo Retrieves the type information for an object, which can be used to get the type information for an interface. (Inherited from Attribute.)
Explicit interface implemetation Private method _Attribute.GetTypeInfoCount Retrieves the number of type information interfaces that an object provides (either 0 or 1). (Inherited from Attribute.)
Explicit interface implemetation Private method _Attribute.Invoke Provides access to properties and methods exposed by an object. (Inherited from Attribute.)
Top
Remarks

The SoapDocumentServiceAttribute allows you to set the default formatting styles for XML Web service methods within an XML Web service. If an individual XML Web service method must change these defaults, apply a SoapDocumentMethodAttribute to that XML Web service method.

Web Services Description Language (WSDL) defines two styles for how an XML Web service method, which it calls an operation, can be formatted in a SOAP request or a SOAP response: RPC and Document. Exactly how the individual message parts is determined by the Use and ParameterStyle properties. The Use property determines whether parameters are formatted Encoded or Literal. The ParameterStyle determines whether the parameters are encapsulated within a single message part beneath the Body element, or whether each parameter is an individual message part.

To set the default method level formatting to RPC, apply a SoapRpcServiceAttribute to the class implementing the XML Web service.

For more details, see [<topic://cpconCustomizingSOAPInASPNETWebServicesWebServiceClients>].

This attribute can be applied to a class implementing an XML Web service.

Examples
Visual Basic

<%@ WebService Language="VB" Class="SumService" %>

Imports System
Imports System.Web.Services
Imports System.Web.Services.Protocols
Imports System.Web.Services.Description

	<SoapDocumentService(SoapBindingUse.Literal, _
                             SoapParameterStyle.Wrapped, _
                             RoutingStyle := SoapServiceRoutingStyle.SoapAction)> _
	Public Class SumService 
          Inherits System.Web.Services.WebService
	
		<WebMethod> _
		Public Function Add(a As Integer, b as Integer)
		   return a + b
		End Function
	End Class
C#

<%@ WebService Language="c#" Class="SumService" %>

using System;
using System.Web.Services;
using System.Web.Services.Protocols;
using System.Web.Services.Description;

	[SoapDocumentService(SoapBindingUse.Literal,
		                 SoapParameterStyle.Wrapped,
		                 RoutingStyle=SoapServiceRoutingStyle.SoapAction)]
	public class SumService : System.Web.Services.WebService
	{
		[WebMethod]
		public int Add(int a, int b)
		{
			return a + b;
		}
	}
Version Information

.NET Framework

Supported in: 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1
Platforms

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
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.
See Also

Reference

System.Web.Services.Protocols Namespace
SoapDocumentMethodAttribute
SoapRpcServiceAttribute

Other Resources

[<topic://cpconCustomizingSOAPInASPNETWebServicesWebServiceClients>]