Export (0) Print
Expand All

SoapExtensionAttribute Class

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

Namespace:  System.Web.Services.Protocols
Assembly:  System.Web.Services (in System.Web.Services.dll)

public abstract class SoapExtensionAttribute : Attribute

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.

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 : 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 __gc class TraceExtensionAttribute : public SoapExtensionAttribute {

private:
   String* myFilename;
   int myPriority;

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

   // Return the type of 'TraceExtension' class.
   __property Type* get_ExtensionType()
   {
      return __typeof(TraceExtension);
   }

   // User can set priority of the 'SoapExtension'.
   __property int get_Priority() 
   {
      return myPriority;
   }

   __property void set_Priority( int value ) 
   { 
      myPriority = value;
   }

   __property String* get_Filename()
   {
      return myFilename;
   }

   __property void set_Filename( String* value )
   {
      myFilename = value;
   }

};

System.Object
  System.Attribute
    System.Web.Services.Protocols.SoapExtensionAttribute

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

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98, Windows CE, Windows Mobile for Smartphone, Windows Mobile for Pocket PC

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

.NET Framework

Supported in: 3.5, 3.0, 2.0, 1.1, 1.0

.NET Compact Framework

Supported in: 3.5, 2.0, 1.0

Community Additions

ADD
Show:
© 2014 Microsoft