This documentation is archived and is not being maintained.

SoapTypeAttribute Class

Customizes SOAP generation and processing for target types. This class cannot be inherited.

Namespace:  System.Runtime.Remoting.Metadata
Assembly:  mscorlib (in mscorlib.dll)

'Declaration
<ComVisibleAttribute(True)> _
<AttributeUsageAttribute(AttributeTargets.Class Or AttributeTargets.Struct Or AttributeTargets.Enum Or AttributeTargets.Interface)> _
Public NotInheritable Class SoapTypeAttribute _
	Inherits SoapAttribute
'Usage
Dim instance As SoapTypeAttribute

The SoapTypeAttribute attribute is a custom attribute that can be applied to objects, value types, and interface objects. This attribute is used to specify information on an object type that controls how SOAP will generate the SOAP XML wire format.

The following code example demonstrates customization of SOAP generated for a class with the SoapTypeAttribute. The SOAP can be produced by the code shown in the SerializableAttribute class example.

<Serializable(), SoapTypeAttribute(XmlNamespace := "MyXmlNamespace")> Public Class TestSimpleObject

   Public member1 As Integer

   <SoapFieldAttribute(XmlElementName := "MyXmlElement")> Public member2 As String 

   Public member3 As String 
   Public member4 As Double 

   ' A field that is not serialized.
   <NonSerialized()> Public member5 As String   


   Public Sub New()
      member1 = 11
      member2 = "hello"
      member3 = "hello"
      member4 = 3.14159265
      member5 = "hello world!" 
   End Sub 'New 

End Class 'TestSimpleObject
[Serializable] 
[SoapTypeAttribute(XmlNamespace=S"MyXmlNamespace")]
public __gc class TestSimpleObject 
{
public:
	int member1;

	[SoapFieldAttribute(XmlElementName=S"MyXmlElement")]
	String* member2;

	String* member3;
	double member4;

	// A field that is not serialized.
	[NonSerialized]
	String* member5; 

public:
	TestSimpleObject() 
	{
		member1 = 11;
		member2 = S"hello";
		member3 = S"hello";
		member4 = 3.14159265;
		member5 = S"hello world!";
	}
};

System.Object
  System.Attribute
    System.Runtime.Remoting.Metadata.SoapAttribute
      System.Runtime.Remoting.Metadata.SoapTypeAttribute

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

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

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

.NET Framework

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