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.

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

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

public abstract class SoapExtensionAttribute : Attribute

The SoapExtensionAttribute type exposes the following members.

  NameDescription
Protected methodSoapExtensionAttributeInitializes a new instance of the SoapExtensionAttribute class.
Top

  NameDescription
Public propertyExtensionTypeWhen overridden in a derived class, gets the Type of the SOAP extension.
Public propertyPriorityWhen overridden in a derived class, gets or set the priority of the SOAP extension.
Public propertyTypeIdWhen implemented in a derived class, gets a unique identifier for this Attribute. (Inherited from Attribute.)
Top

  NameDescription
Public methodEqualsInfrastructure. Returns a value that indicates whether this instance is equal to a specified object. (Inherited from Attribute.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetHashCodeReturns the hash code for this instance. (Inherited from Attribute.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodIsDefaultAttributeWhen overridden in a derived class, indicates whether the value of this instance is the default value for the derived class. (Inherited from Attribute.)
Public methodMatchWhen overridden in a derived class, returns a value that indicates whether this instance equals a specified object. (Inherited from Attribute.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Top

  NameDescription
Explicit interface implemetationPrivate method_Attribute.GetIDsOfNamesMaps a set of names to a corresponding set of dispatch identifiers. (Inherited from Attribute.)
Explicit interface implemetationPrivate method_Attribute.GetTypeInfoRetrieves the type information for an object, which can be used to get the type information for an interface. (Inherited from Attribute.)
Explicit interface implemetationPrivate method_Attribute.GetTypeInfoCountRetrieves the number of type information interfaces that an object provides (either 0 or 1). (Inherited from Attribute.)
Explicit interface implemetationPrivate method_Attribute.InvokeProvides access to properties and methods exposed by an object. (Inherited from Attribute.)
Top

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


.NET Framework

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

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

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

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

Community Additions

ADD
Show:
© 2014 Microsoft