SoapDocumentMethodAttribute.RequestElementName Property

Reference

Definition

Namespace:: System.Web.Services.Protocols

Assembly:: System.Web.Services.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Gets or sets the XML element associated with the SOAP request for an XML Web service method, which is defined in a service description as an operation.

public:
 property System::String ^ RequestElementName { System::String ^ get(); void set(System::String ^ value); };

public string RequestElementName { get; set; }

member this.RequestElementName : string with get, set

Public Property RequestElementName As String

Property Value

String

The XML element associated with the SOAP request for an XML Web service method, which is defined in an service description as an operation. The default value is the name of the XML Web service method.

Examples

The following code example sets the name of the XML element associated with the XML Web service method in the SOAP request to MyCustomElement.

<%@ WebService Language="C#" Class="SoapDocumentMethodSample" %>
    
using System.Web.Services;
using System.Web.Services.Protocols;

public class SoapDocumentMethodSample
{
   [WebMethod]
   [SoapDocumentMethod(RequestNamespace="http://www.contoso.com",RequestElementName="MyCustomElement")]
   public int[] RequestDocument(int numentries)
   {
    int[] intarray = new int[numentries];
        for (int i=0;i<numentries;i++)
        {
       intarray[i] = i;
        }
        return intarray;
   }
}

<%@ WebService Language="VB" Class="SoapDocumentMethodSample" %>
    
Imports System.Web.Services
Imports System.Web.Services.Protocols

Public Class SoapDocumentMethodSample

   <WebMethod(),SoapDocumentMethod(RequestNamespace :="http://www.contoso.com",RequestElementName := "MyCustomRequestElement")> _
   Public Function  RequestDocument(numentries as Integer) As Integer()
    Dim intarray(numentries - 1) as Integer
        Dim i as Integer
        For i = 0 To numentries - 1
           intarray(i) = i
        Next
        Return intarray
   End Function
End Class

Remarks

The RequestElementName defines the XML element used to wrap the parameters beneath the Body element of the SOAP request when ParameterStyle is Wrapped. This is reflected in the XSD schema representing the SOAP request to the XML Web service method within the service description for an XML Web service.

Applies to

Jaa