SoapTypeAttribute Class

Definition

Namespace:

System.Runtime.Remoting.Metadata

Assembly:

mscorlib.dll

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

public ref class SoapTypeAttribute sealed : System::Runtime::Remoting::Metadata::SoapAttribute

[System.AttributeUsage(System.AttributeTargets.Class | System.AttributeTargets.Enum | System.AttributeTargets.Interface | System.AttributeTargets.Struct)]
[System.Runtime.InteropServices.ComVisible(true)]
public sealed class SoapTypeAttribute : System.Runtime.Remoting.Metadata.SoapAttribute

[<System.AttributeUsage(System.AttributeTargets.Class | System.AttributeTargets.Enum | System.AttributeTargets.Interface | System.AttributeTargets.Struct)>]
[<System.Runtime.InteropServices.ComVisible(true)>]
type SoapTypeAttribute = class
    inherit SoapAttribute

Public NotInheritable Class SoapTypeAttribute
Inherits SoapAttribute

Inheritance

Object

Attribute

SoapAttribute

SoapTypeAttribute

Attributes

AttributeUsageAttribute ComVisibleAttribute

Examples

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 ref class TestSimpleObject
{
public:
   int member1;

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

   String^ member3;
   double member4;

   // A field that is not serialized.

   [NonSerialized] String^ member5;

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

[Serializable()]
[SoapTypeAttribute(XmlNamespace="MyXmlNamespace")]
public class TestSimpleObject  {

    public int member1;

    [SoapFieldAttribute(XmlElementName="MyXmlElement")] public string member2;

    public string member3;
    public double member4;

    // A field that is not serialized.
    [NonSerialized()] public string member5;

    public TestSimpleObject() {

        member1 = 11;
        member2 = "hello";
        member3 = "hello";
        member4 = 3.14159265;
        member5 = "hello world!";
    }
}

<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

End Class

Remarks

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.

Constructors

SoapTypeAttribute()

Creates an instance of SoapTypeAttribute.

Fields

ProtXmlNamespace	The XML namespace to which the target of the current SOAP attribute is serialized. (Inherited from SoapAttribute)
ReflectInfo	A reflection object used by attribute classes derived from the SoapAttribute class to set XML serialization information. (Inherited from SoapAttribute)

Properties

Embedded	Gets or sets a value indicating whether the type must be nested during SOAP serialization. (Inherited from SoapAttribute)
SoapOptions	Gets or sets a SoapOption configuration value.
TypeId	When implemented in a derived class, gets a unique identifier for this Attribute. (Inherited from Attribute)
UseAttribute	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.
XmlElementName	Gets or sets the XML element name.
XmlFieldOrder	Gets or sets the XML field order for the target object type.
XmlNamespace	Gets or sets the XML namespace that is used during serialization of the target object type.
XmlTypeName	Gets or sets the XML type name for the target object type.
XmlTypeNamespace	Gets or sets the XML type namespace for the current object type.

Methods

Equals(Object)	Returns a value that indicates whether this instance is equal to a specified object. (Inherited from Attribute)
GetHashCode()	Returns the hash code for this instance. (Inherited from Attribute)
GetType()	Gets the Type of the current instance. (Inherited from Object)
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)
Match(Object)	When overridden in a derived class, returns a value that indicates whether this instance equals a specified object. (Inherited from Attribute)
MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object)
ToString()	Returns a string that represents the current object. (Inherited from Object)

Explicit Interface Implementations

_Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr)	Maps a set of names to a corresponding set of dispatch identifiers. (Inherited from Attribute)
_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)
_Attribute.GetTypeInfoCount(UInt32)	Retrieves the number of type information interfaces that an object provides (either 0 or 1). (Inherited from Attribute)
_Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr)	Provides access to properties and methods exposed by an object. (Inherited from Attribute)