SoapExtensionAttribute Class
When overridden in a derived class, specifies a SOAP extension should run with an XML Web service method.
For a list of all members of this type, see SoapExtensionAttribute Members.
System.Object
System.Attribute
System.Web.Services.Protocols.SoapExtensionAttribute
[Visual Basic] MustInherit Public Class SoapExtensionAttribute Inherits Attribute [C#] public abstract class SoapExtensionAttribute : Attribute [C++] public __gc __abstract class SoapExtensionAttribute : public Attribute [JScript] public abstract class SoapExtensionAttribute extends Attribute
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.
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.
Example
[Visual Basic, C#, C++] 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.
[Visual Basic] ' 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 [C#] // 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; } } } [C++] // 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; } };
[JScript] No example is available for JScript. To view a Visual Basic, C#, or C++ example, click the Language Filter button
in the upper-left corner of the page.
Requirements
Namespace: System.Web.Services.Protocols
Platforms: Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 family, .NET Compact Framework
Assembly: System.Web.Services (in System.Web.Services.dll)
See Also
SoapExtensionAttribute Members | System.Web.Services.Protocols Namespace | SoapExtension | SoapMessage