.NET Framework Class Library
SoapExtensionAttribute Class

When overridden in a derived class, specifies a SOAP extension should run with an XML Web service method.

Inheritance Hierarchy
SystemObject
   SystemAttribute
    System.Web.Services.ProtocolsSoapExtensionAttribute

Namespace:   System.Web.Services.Protocols
Assembly:  System.Web.Services (in System.Web.Services.dll)
Syntax
Public MustInherit Class SoapExtensionAttribute _
	Inherits [%$TOPIC/zdbe27hd_en-us_VS_110_2_0_0_0_0%]
public abstract class SoapExtensionAttribute : [%$TOPIC/zdbe27hd_en-us_VS_110_2_0_1_0_0%]
public ref class SoapExtensionAttribute abstract : public [%$TOPIC/zdbe27hd_en-us_VS_110_2_0_2_0_0%]
[<[%$TOPIC/zdbe27hd_en-us_VS_110_2_0_3_0_0%]>]
type SoapExtensionAttribute =  
    class 
        inherit [%$TOPIC/zdbe27hd_en-us_VS_110_2_0_3_0_1%] 
    end
public abstract class SoapExtensionAttribute extends [%$TOPIC/zdbe27hd_en-us_VS_110_2_0_4_0_0%]

The SoapExtensionAttribute type exposes the following members.

Constructors
  NameDescription
Protected method SoapExtensionAttributeInitializes a new instance of the SoapExtensionAttribute class.
Top
Properties
  NameDescription
Public property ExtensionTypeWhen overridden in a derived class, gets the Type of the SOAP extension.
Public property PriorityWhen overridden in a derived class, gets or set the priority of the SOAP extension.
Public property TypeIdWhen implemented in a derived class, gets a unique identifier for this Attribute. (Inherited from Attribute.)
Top
Methods
  NameDescription
Public method EqualsInfrastructure. Returns a value that indicates whether this instance is equal to a specified object. (Inherited from Attribute.)
Protected method FinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public method GetHashCodeReturns the hash code for this instance. (Inherited from Attribute.)
Public method GetTypeGets the Type of the current instance. (Inherited from Object.)
Public method IsDefaultAttributeWhen overridden in a derived class, indicates whether the value of this instance is the default value for the derived class. (Inherited from Attribute.)
Public method MatchWhen overridden in a derived class, returns a value that indicates whether this instance equals a specified object. (Inherited from Attribute.)
Protected method MemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public method ToStringReturns a string that represents the current object. (Inherited from Object.)
Top
Explicit Interface Implementations
  NameDescription
Explicit interface implemetation Private method _AttributeGetIDsOfNamesMaps a set of names to a corresponding set of dispatch identifiers. (Inherited from Attribute.)
Explicit interface implemetation Private method _AttributeGetTypeInfoRetrieves the type information for an object, which can be used to get the type information for an interface. (Inherited from Attribute.)
Explicit interface implemetation Private method _AttributeGetTypeInfoCountRetrieves the number of type information interfaces that an object provides (either 0 or 1). (Inherited from Attribute.)
Explicit interface implemetation Private method _AttributeInvokeProvides access to properties and methods exposed by an object. (Inherited from Attribute.)
Top
Remarks

XML Web service methods created using ASP.NET can be configured to run with a SOAP extension by applying an attribute to the XML Web service method. When a custom extension attribute is added to an XML Web service method or a method on a client proxy class, ASP.NET invokes the associated extension at the appropriate time. An extension attribute is a custom attribute class deriving from SoapExtensionAttribute. Derived attributes must override the ExtensionType property to return the type of extension that is associated with the attribute.

Examples

The following TraceExtensionAttribute class derives from SoapExtensionAttribute to support applying the attribute to an XML Web service method or a method in an XML Web service client proxy class. When applied to either, the TraceExtension SOAP extension runs with the method.

' Create a SoapExtensionAttribute for a SOAP extension that can be 
' applied to an XML Web service method.
<AttributeUsage(AttributeTargets.Method)> _
Public Class TraceExtensionAttribute
    Inherits SoapExtensionAttribute

    Private m_filename As String = "c:\log.txt" 
    Private m_priority As Integer 

   ' Return the type of 'TraceExtension' class. 
    Public Overrides ReadOnly Property ExtensionType() As Type
        Get 
            Return GetType(TraceExtension)
        End Get 
    End Property 

   ' User can set priority of the 'TraceExtension'. 
    Public Overrides Property Priority() As Integer 
        Get 
            Return m_priority
        End Get 
        Set(ByVal Value As Integer)
            m_priority = value
        End Set 
    End Property 

    Public Property Filename() As String 
        Get 
            Return m_filename
        End Get 
        Set(ByVal Value As String)
            m_filename = value
        End Set 
    End Property 
End Class
// Create a SoapExtensionAttribute for a SOAP extension that can be 
  // applied to an XML Web service method.
  [AttributeUsage(AttributeTargets.Method)]
  public class TraceExtensionAttribute : SoapExtensionAttribute {

	  private string myFilename;
	  private int myPriority;


	  // Set the name of the log file were SOAP messages will be stored. 
	  public TraceExtensionAttribute() : base()
	  {
		  myFilename = "C:\\logClient.txt";
	  }

	  // Return the type of 'TraceExtension' class. 
	  public override Type ExtensionType
	  {
		  get
		  {
			  return typeof(TraceExtension);
		  }
	  }

	  // User can set priority of the 'SoapExtension'. 
	  public override int Priority 
	  {
		  get 
		  {
			  return myPriority;
		  }
		  set 
		  { 
			  myPriority = value;
		  }
	  }

	  public string Filename 
	  {
		  get
		  {
			  return myFilename;
		  }
		  set
		  {
			  myFilename = value;
		  }
	  }
  }
// Create a SoapExtensionAttribute for a SOAP extension that can be 
// applied to an XML Web service method.

[AttributeUsage(AttributeTargets::Method)]
public ref class TraceExtensionAttribute: public SoapExtensionAttribute
{
private:
   String^ myFilename;
   int myPriority;

public:

   // Set the name of the log file were SOAP messages will be stored.
   TraceExtensionAttribute()
      : SoapExtensionAttribute()
   {
      myFilename = "C:\\logClient.txt";
   }

   property Type^ ExtensionType 
   {
      // Return the type of 'TraceExtension' class. 
      virtual Type^ get() override
      {
         return TraceExtension::typeid;
      }
   }

   property int Priority 
   {
      // User can set priority of the 'SoapExtension'. 
      virtual int get() override
      {
         return myPriority;
      }

      virtual void set( int value ) override
      {
         myPriority = value;
      }
   }

   property String^ Filename 
   {
      String^ get()
      {
         return myFilename;
      }

      void set( String^ value )
      {
         myFilename = value;
      }
   }
};
Version Information

.NET Framework

Supported in: 4.6, 4.5, 4, 3.5, 3.0, 2.0, 1.1

.NET Framework Client Profile

Supported in: 4, 3.5 SP1
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.