System.Runtime.Remoting.Metadata.SoapMethodAttribute Class

Assembly: Mscorlib.dll
Namespace: System.Runtime.Remoting.Metadata
Summary
Customizes SOAP generation and processing for a method. This class cannot be inherited.
C# Syntax:
[AttributeUsage(AttributeTargets.Method)]
public sealed class SoapMethodAttribute : SoapAttribute
Remarks
The target objects for the SoapMethodAttribute attribute are methods that can be remotely invoked. Apply the SoapMethodAttribute to customize SOAP generation and processing. Properties of this attribute allow the programmer to customize the SOAPAction HTTP header field to indicate the intent of the SOAP HTTP request.
See also:
System.Runtime.Remoting.Metadata Namespace

System.Runtime.Remoting.Metadata.SoapMethodAttribute 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.
ResponseXmlElementName Read-write

Gets or sets the XML element name to use for the method response to the target method.
ResponseXmlNamespace Read-write

Gets or sets the XML element namesapce used for method response to the target method.
ReturnXmlElementName Read-write

Gets or sets the XML element name used for the return value from the target method.
SoapAction Read-write

Gets or sets the SOAPAction header field used with HTTP requests sent with this method.
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 Read-write

Overridden:
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.
XmlNamespace Read-write

Overridden:
Gets or sets the XML namespace that is used during serialization of remote method calls of the target method.
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.
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.Runtime.Remoting.Metadata.SoapMethodAttribute Member Details

ctor #1
Summary:
Default constructor. This constructor is called by derived class constructors to initialize state in this type.
C# Syntax:
public SoapMethodAttribute();

Return to top


Field: 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.

Return to top


Field: 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.

Return to top


Property: Embedded (read-write)
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


Property: ResponseXmlElementName (read-write)
Summary
Gets or sets the XML element name to use for the method response to the target method.
C# Syntax:
public string ResponseXmlElementName {get; set;}
Remarks
The default value of this property is the string "Response" appended to the name of the method.

Return to top


Property: ResponseXmlNamespace (read-write)
Summary
Gets or sets the XML element namesapce used for method response to the target method.
C# Syntax:
public string ResponseXmlNamespace {get; set;}

Return to top


Property: ReturnXmlElementName (read-write)
Summary
Gets or sets the XML element name used for the return value from the target method.
C# Syntax:
public string ReturnXmlElementName {get; set;}
Remarks
The default value of this property is the "__return" string.

Return to top


Property: SoapAction (read-write)
Summary
Gets or sets the SOAPAction header field used with HTTP requests sent with this method.
C# Syntax:
public string SoapAction {get; set;}
Remarks
The SOAPAction HTTP request header field indicates the intent of the SOAP HTTP request. For more information on the SOAPAction field, see www.w3.org/tr/soap/#_Toc478383528.

Return to top


Property: TypeId (read-only)
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;}
Remarks
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


Overridden Property: UseAttribute (read-write)
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 override bool UseAttribute {get; set;}
Exceptions
Exception Type Condition
RemotingException An attempt was made to set the current property.
Remarks
The SoapTypeAttribute.UseAttribute property cannot be set on the SoapMethodAttribute attribute.

Return to top


Overridden Property: XmlNamespace (read-write)
Summary
Gets or sets the XML namespace that is used during serialization of remote method calls of the target method.
C# Syntax:
public override string XmlNamespace {get; set;}

Return to top


Method: Equals(
   object obj
)
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


Method: Finalize()
Inherited
See base class member description: System.Object.Finalize
C# Syntax:
~SoapMethodAttribute();

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

Return to top


Method: GetHashCode()
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


Method: GetType()
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


Method: IsDefaultAttribute()
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.
Remarks
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


Method: Match(
   object obj
)
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
);
Parameters:

obj

An Object to compare with this instance of Attribute.

Return Value:
true if this instance equals obj; otherwise, false.
Remarks
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


Method: MemberwiseClone()
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


Method: ToString()
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

Copyright (c) 2002 Microsoft Corporation. All rights reserved.