This documentation is archived and is not being maintained.

SoapDocumentMethodAttribute.RequestElementName Property

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.

[Visual Basic]
Public Property RequestElementName As String
[C#]
public string RequestElementName {get; set;}
[C++]
public: __property String* get_RequestElementName();
public: __property void set_RequestElementName(String*);
[JScript]
public function get RequestElementName() : String;
public function set RequestElementName(String);

Property Value

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.

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.

Example

[Visual Basic, C#] The following code example sets the name of the XML element associated with the XML Web service method in the SOAP request to MyCustomElement.

[Visual Basic] 
<%@ 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

[C#] 
<%@ 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;
   }
}

[C++, JScript] No example is available for C++ or JScript. To view a Visual Basic or C# example, click the Language Filter button Language Filter in the upper-left corner of the page.

Requirements

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

See Also

SoapDocumentMethodAttribute Class | SoapDocumentMethodAttribute Members | System.Web.Services.Protocols Namespace

Show: