System.Runtime.Remoting.Metadata.SoapFieldAttribute Class

Summary

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

C# Syntax:

[AttributeUsage(AttributeTargets.Field)] public sealed class SoapFieldAttribute : SoapAttribute

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

    

System.Runtime.Remoting.Metadata Namespace

System.Runtime.Remoting.Metadata.SoapFieldAttribute Member List:

Public Constructors

ctor #1

Default constructor. This constructor is called by derived class constructors to initialize state in this type.

Public Properties

Embedded (inherited from System.Runtime.Remoting.Metadata.SoapAttribute)	Read-write See base class member description: System.Runtime.Remoting.Metadata.SoapAttribute.Embedded Gets or sets a value indicating whether the type must be nested during SOAP serialization.
Order	Read-write Public reserved, to be <internalonly/>.
TypeId (inherited from System.Attribute)	Read-only See base class member description: System.Attribute.TypeId When implemented in a derived class, gets a unique identifier for this Attribute.
UseAttribute (inherited from System.Runtime.Remoting.Metadata.SoapAttribute)	Read-write See base class member description: System.Runtime.Remoting.Metadata.SoapAttribute.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	Read-write Gets or sets the XML element name of the field contained in the SoapFieldAttribute attribute.
XmlNamespace (inherited from System.Runtime.Remoting.Metadata.SoapAttribute)	Read-write See base class member description: System.Runtime.Remoting.Metadata.SoapAttribute.XmlNamespace Gets or sets the XML namespace name.

Public Methods

Equals (inherited from System.Object)	See base class member description: System.Object.Equals Derived from System.Object, the primary base class for all objects.
GetHashCode (inherited from System.Attribute)	See base class member description: System.Attribute.GetHashCode Returns the hash code for this instance.
GetType (inherited from System.Object)	See base class member description: System.Object.GetType Derived from System.Object, the primary base class for all objects.
IsDefaultAttribute (inherited from System.Attribute)	See base class member description: System.Attribute.IsDefaultAttribute When overridden in a derived class, returns an indication whether the value of this instance is the default value for the derived class.
IsInteropXmlElement	Returns a value indicating whether the current attribute contains interop XML element values.
Match (inherited from System.Attribute)	See base class member description: System.Attribute.Match When overridden in a derived class, returns a value indicating whether this instance equals a specified object.
ToString (inherited from System.Object)	See base class member description: System.Object.ToString Derived from System.Object, the primary base class for all objects.

Protected Fields

ProtXmlNamespace  (inherited)	This member is inherited from a type or implements a member of an interface which internally supports the .NET Framework infrastructure and is not intended to be used directly from your code.
ReflectInfo  (inherited)	This member is inherited from a type or implements a member of an interface which internally supports the .NET Framework infrastructure and is not intended to be used directly from your code.

Protected Methods

Finalize (inherited from System.Object)	See base class member description: System.Object.Finalize Derived from System.Object, the primary base class for all objects.
MemberwiseClone (inherited from System.Object)	See base class member description: System.Object.MemberwiseClone Derived from System.Object, the primary base class for all objects.

Hierarchy:

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

System.Runtime.Remoting.Metadata.SoapFieldAttribute Member Details

Summary:

Default constructor. This constructor is called by derived class constructors to initialize state in this type.

C# Syntax:

public SoapFieldAttribute();

Return to top

Inherited
This member is inherited from a type or implements a member of an interface which internally supports the .NET Framework infrastructure and is not intended to be used directly from your code.

Return to top

Inherited
This member is inherited from a type or implements a member of an interface which internally supports the .NET Framework infrastructure and is not intended to be used directly from your code.

Return to top

Inherited
See base class member description: System.Runtime.Remoting.Metadata.SoapAttribute.Embedded

Summary

Gets or sets a value indicating whether the type must be nested during SOAP serialization.

C# Syntax:

public virtual bool Embedded {get; set;}

Return to top

Summary

Public reserved, to be <internalonly/>.

This type supports the Shared Source CLI infrastructure and is not intended to be used directly from your code.

C# Syntax:

public int Order {get; set;}

Return to top

Inherited
See base class member description: System.Attribute.TypeId

Summary

When implemented in a derived class, gets a unique identifier for this Attribute.

C# Syntax:

public virtual object TypeId {get;}

As implemented, this identifier is merely the Type of the attribute. However, it is intended that the unique identifier be used to identify two attributes of the same type.

Return to top

Inherited
See base class member description: System.Runtime.Remoting.Metadata.SoapAttribute.UseAttribute

Summary

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.

C# Syntax:

public virtual bool UseAttribute {get; set;}

For example, if a field FieldA of an object ObjectB is qualified with the SoapFieldAttribute(UseAttribute=true) attribute, FieldA will be serialized as <ObjectB><FieldA>5</FieldA></ObjectB> . If the SoapAttribute.UseAttribute property is set to false, FieldA will be serialized as <ObjectB FieldA="5"></ObjectB> .

Return to top

Summary

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

C# Syntax:

public string XmlElementName {get; set;}

Return to top

Inherited
See base class member description: System.Runtime.Remoting.Metadata.SoapAttribute.XmlNamespace

Summary

Gets or sets the XML namespace name.

C# Syntax:

public virtual string XmlNamespace {get; set;}

If the current property returns null, then the namespace is not qualified.

Return to top

Inherited
See base class member description: System.Object.Equals

C# Syntax:

public virtual bool Equals(    object obj );

For more information on members inherited from System.Object click on the link above.

Return to top

Inherited
See base class member description: System.Object.Finalize

C# Syntax:

~SoapFieldAttribute();

For more information on members inherited from System.Object click on the link above.

Return to top

Inherited
See base class member description: System.Attribute.GetHashCode

Summary

Returns the hash code for this instance.

C# Syntax:

public override int GetHashCode();

Return Value:

A 32-bit signed integer hash code.

Return to top

Inherited
See base class member description: System.Object.GetType

C# Syntax:

public Type GetType();

For more information on members inherited from System.Object click on the link above.

Return to top

Inherited
See base class member description: System.Attribute.IsDefaultAttribute

Summary

When overridden in a derived class, returns an indication whether the value of this instance is the default value for the derived class.

C# Syntax:

public virtual bool IsDefaultAttribute();

Return Value:

true if this instance is the default attribute for the class; otherwise, false.

The default implementation of this class returns false, and must be implemented in the derived class to be useful to that class.

The implementation of this method in a derived class compares the value of this instance to a standard, default value obtained by some means, then returns a Boolean value that indicates whether the value of this instance is equal to the standard. The standard value is typically coded as a constant in the implementation, or stored programmatically in a field used by the implementation.

Return to top

Summary

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

C# Syntax:

public bool IsInteropXmlElement();

Return Value:

true if the current attribute contains interop XML element values; otherwise, false.

Return to top

Inherited
See base class member description: System.Attribute.Match

Summary

When overridden in a derived class, returns a value indicating whether this instance equals a specified object.

C# Syntax:

public virtual bool Match(    object obj );

obj

An Object to compare with this instance of Attribute.

Return Value:

true if this instance equals obj; otherwise, false.

This method determines if one Attribute equals another. Its default implementation is the same as Attribute.Equals, which performs a value and reference comparison. Override this method to implement support for attribute values, such as flags or bitfields, that consist of components that are meaningful in themselves. For example, consider an attribute whose value is a binary field divided into a bitfield of flags. Two instances of this attribute have one flag in set in common while all the other flags differ. The Equal method cannot determine that the two instances have the same flag set, but the Match method can.

Return to top

Inherited
See base class member description: System.Object.MemberwiseClone

C# Syntax:

protected object MemberwiseClone();

For more information on members inherited from System.Object click on the link above.

Return to top

Inherited
See base class member description: System.Object.ToString

C# Syntax:

public virtual string ToString();

For more information on members inherited from System.Object click on the link above.

Return to top

Top of page