This documentation is archived and is not being maintained.

SoapTypeAttribute Class

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

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

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

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

The SoapTypeAttribute type exposes the following members.

  NameDescription
Public methodSoapTypeAttributeCreates an instance of SoapTypeAttribute.
Top

  NameDescription
Public propertyEmbeddedGets or sets a value indicating whether the type must be nested during SOAP serialization. (Inherited from SoapAttribute.)
Public propertySoapOptionsGets or sets a SoapOption configuration value.
Public propertyTypeIdWhen implemented in a derived class, gets a unique identifier for this Attribute. (Inherited from Attribute.)
Public propertyUseAttributeGets or sets a value indicating whether the target of the current attribute will be serialized as an XML attribute instead of an XML field. (Overrides SoapAttribute.UseAttribute.)
Public propertyXmlElementNameGets or sets the XML element name.
Public propertyXmlFieldOrderInfrastructure. You should not use this property; it is not used by the .NET Framework remoting infrastructure.
Public propertyXmlNamespaceGets or sets the XML namespace that is used during serialization of the target object type. (Overrides SoapAttribute.XmlNamespace.)
Public propertyXmlTypeNameGets or sets the XML type name for the target object type.
Public propertyXmlTypeNamespaceGets or sets the XML type namespace for the current object type.
Top

  NameDescription
Public methodEqualsInfrastructure. Returns a value that indicates whether this instance is equal to a specified object. (Inherited from Attribute.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetHashCodeReturns the hash code for this instance. (Inherited from Attribute.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodIsDefaultAttributeWhen overridden in a derived class, indicates whether the value of this instance is the default value for the derived class. (Inherited from Attribute.)
Public methodMatchWhen overridden in a derived class, returns a value that indicates whether this instance equals a specified object. (Inherited from Attribute.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Top

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

  NameDescription
Explicit interface implemetationPrivate method_Attribute.GetIDsOfNamesMaps a set of names to a corresponding set of dispatch identifiers. (Inherited from Attribute.)
Explicit interface implemetationPrivate method_Attribute.GetTypeInfoRetrieves the type information for an object, which can be used to get the type information for an interface. (Inherited from Attribute.)
Explicit interface implemetationPrivate method_Attribute.GetTypeInfoCountRetrieves the number of type information interfaces that an object provides (either 0 or 1). (Inherited from Attribute.)
Explicit interface implemetationPrivate method_Attribute.InvokeProvides access to properties and methods exposed by an object. (Inherited from Attribute.)
Top

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


.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

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.

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