This topic has not yet been rated - Rate this topic

SoapTypeAttribute Class

.NET Framework 2.0

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

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

[AttributeUsageAttribute(AttributeTargets::Class|AttributeTargets::Struct|AttributeTargets::Enum|AttributeTargets::Interface)] 
[ComVisibleAttribute(true)] 
public ref class SoapTypeAttribute sealed : public SoapAttribute

/** @attribute AttributeUsageAttribute(AttributeTargets.Class|AttributeTargets.Struct|AttributeTargets.Enum|AttributeTargets.Interface) */ 
/** @attribute ComVisibleAttribute(true) */ 
public final class SoapTypeAttribute extends SoapAttribute

JScript

AttributeUsageAttribute(AttributeTargets.Class|AttributeTargets.Struct|AttributeTargets.Enum|AttributeTargets.Interface) 
ComVisibleAttribute(true) 
public final class SoapTypeAttribute extends SoapAttribute

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.

Example

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.

C++

[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!";
   }
};

/** @attribute Serializable()
 */
/** @attribute SoapTypeAttribute(XmlNamespace = "MyXmlNamespace")
 */
public class TestSimpleObject
{
    public int member1;

    /** @attribute SoapFieldAttribute(XmlElementName = "MyXmlElement")
     */
    public String member2;
    public String member3;
    public double member4;

    // A field that is not serialized.
    /** @attribute NonSerialized()
     */
    public String member5;

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

Inheritance Hierarchy

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

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.

Platforms

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

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

Version Information

.NET Framework

Supported in: 2.0, 1.1, 1.0

Reference

SoapTypeAttribute Members
System.Runtime.Remoting.Metadata Namespace

Did you find this helpful? Yes No

Not accurate

Not enough depth

Need more code examples

(1500 characters remaining)

Community Additions

ADD