SoapFieldAttribute Class


The .NET API Reference documentation has a new home. Visit the .NET API Browser on to see the new experience.

Customizes SOAP generation and processing for a field. This class cannot be inherited.

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


Public NotInheritable Class SoapFieldAttribute
	Inherits SoapAttribute


Creates an instance of SoapFieldAttribute class.


Gets or sets a value indicating whether the type must be nested during SOAP serialization.(Inherited from SoapAttribute.)


This API supports the product infrastructure and is not intended to be used directly from your code. Gets or sets the order of the current field attribute.


When implemented in a derived class, gets a unique identifier for this Attribute.(Inherited from Attribute.)


Gets or sets a value indicating whether the target of the current attribute will be serialized as an XML attribute instead of an XML field.(Inherited from SoapAttribute.)


Gets or sets the XML element name of the field contained in the SoapFieldAttribute attribute.


Gets or sets the XML namespace name.(Inherited from SoapAttribute.)


This API supports the product infrastructure and is not intended to be used directly from your code. Returns a value that indicates whether this instance is equal to a specified object.(Inherited from Attribute.)


Returns the hash code for this instance.(Inherited from Attribute.)


Gets the Type of the current instance.(Inherited from Object.)


When overridden in a derived class, indicates whether the value of this instance is the default value for the derived class.(Inherited from Attribute.)


Returns a value indicating whether the current attribute contains interop XML element values.


When overridden in a derived class, returns a value that indicates whether this instance equals a specified object.(Inherited from Attribute.)


Returns a string that represents the current object.(Inherited from Object.)

System_CAPS_pubinterfaceSystem_CAPS_privmethod_Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr)

Maps a set of names to a corresponding set of dispatch identifiers.(Inherited from Attribute.)

System_CAPS_pubinterfaceSystem_CAPS_privmethod_Attribute.GetTypeInfo(UInt32, UInt32, IntPtr)

Retrieves the type information for an object, which can be used to get the type information for an interface.(Inherited from Attribute.)


Retrieves the number of type information interfaces that an object provides (either 0 or 1).(Inherited from Attribute.)

System_CAPS_pubinterfaceSystem_CAPS_privmethod_Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr)

Provides access to properties and methods exposed by an object.(Inherited from Attribute.)

The target objects for the SoapFieldAttribute attribute are object fields. The SoapFieldAttribute attribute is used to specify information that controls how the .NET Framework generates the SOAP XML wire format for target fields.

The following code example demonstrates customization of SOAP generated for a field of a class with the SoapFieldAttribute. 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 'NewNew

End Class 'TestSimpleObject

.NET Framework
Available since 1.1

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

Return to top