SoapFieldAttribute Class

 

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

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

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

[AttributeUsageAttribute(AttributeTargets.Field)]
[ComVisibleAttribute(true)]
public sealed class SoapFieldAttribute : SoapAttribute

NameDescription
System_CAPS_pubmethodSoapFieldAttribute()

Creates an instance of SoapFieldAttribute class.

NameDescription
System_CAPS_pubpropertyEmbedded

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

System_CAPS_pubpropertyOrder

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.

System_CAPS_pubpropertyTypeId

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

System_CAPS_pubpropertyUseAttribute

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.)

System_CAPS_pubpropertyXmlElementName

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

System_CAPS_pubpropertyXmlNamespace

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

NameDescription
System_CAPS_pubmethodEquals(Object)

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.)

System_CAPS_pubmethodGetHashCode()

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

System_CAPS_pubmethodGetType()

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

System_CAPS_pubmethodIsDefaultAttribute()

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

System_CAPS_pubmethodIsInteropXmlElement()

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

System_CAPS_pubmethodMatch(Object)

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

System_CAPS_pubmethodToString()

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

NameDescription
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.)

System_CAPS_pubinterfaceSystem_CAPS_privmethod_Attribute.GetTypeInfoCount(UInt32)

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 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
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
Show: