mcs/class/System.Web.Services/Documentation/en/System.Web.Services/WebServiceAttribute.xml

   1 <?xml version="1.0" encoding="utf-8"?>
   2 <Type Name="WebServiceAttribute" FullName="System.Web.Services.WebServiceAttribute">
   3   <TypeSignature Language="C#" Maintainer="auto" Value="public sealed class WebServiceAttribute : Attribute" />
   4   <AssemblyInfo>
   5     <AssemblyName>System.Web.Services</AssemblyName>
   6     <AssemblyPublicKey>
   7     </AssemblyPublicKey>
   8     <AssemblyVersion>1.0.5000.0</AssemblyVersion>
   9     <AssemblyVersion>2.0.0.0</AssemblyVersion>
  10   </AssemblyInfo>
  11   <ThreadSafetyStatement>Gtk# is thread aware, but not thread safe; See the &lt;link location="node:gtk-sharp/programming/threads"&gt;Gtk# Thread Programming&lt;/link&gt; for details.</ThreadSafetyStatement>
  12   <Base>
  13     <BaseTypeName>System.Attribute</BaseTypeName>
  14   </Base>
  15   <Interfaces />
  16   <Attributes>
  17     <Attribute>
  18       <AttributeName>System.AttributeUsage(System.AttributeTargets.Class | System.AttributeTargets.Interface, Inherited=true)</AttributeName>
  19     </Attribute>
  20   </Attributes>
  21   <Docs>
  22     <remarks>
  23       <attribution license="cc4" from="Microsoft" modified="false" />
  24       <para>The <see cref="T:System.Web.Services.WebServiceAttribute" /> is not required for an XML Web service to be published and executed. You can use the WebServiceAttribute to specify a name for the XML Web service that is not restricted by the rules for a common language runtime identifier, which is used in the service description and the Service help page for the XML Web service.</para>
  25       <para>An XML Web service should change its default XML namespace before it is made public. Each XML Web service needs a unique XML namespace to identify it so that client applications can distinguish it from other services on the Web. http://tempuri.org/ is available for XML Web services that are under development, but published XML Web services should use a more permanent namespace.</para>
  26       <para>Your XML Web service should be identified by a XML namespace that you control. For example, you could use your company's Internet domain name as part of the XML namespace. Although many XML Web service XML namespaces look like URLs, they need not point to an actual resource on the Web. (XML Web service XML namespaces are URIs.) For XML Web services created using ASP.NET, the default XML namespace can be changed using <see cref="P:System.Web.Services.WebServiceAttribute.Namespace" /> property.</para>
  27       <para>For more information about using attributes, see <format type="text/html"><a href="30386922-1E00-4602-9EBF-526B271A8B87">[&lt;topic://cpconExtendingMetadataUsingAttributes&gt;]</a></format>.</para>
  28     </remarks>
  29     <summary>
  30       <attribution license="cc4" from="Microsoft" modified="false" />
  31       <para>Used to add additional information to an XML Web service, such as a string describing its functionality.</para>
  32     </summary>
  33   </Docs>
  34   <Members>
  35     <Member MemberName=".ctor">
  36       <MemberSignature Language="C#" Value="public WebServiceAttribute ();" />
  37       <MemberType>Constructor</MemberType>
  38       <ReturnValue />
  39       <Parameters />
  40       <Docs>
  41         <remarks>To be added</remarks>
  42         <summary>
  43           <attribution license="cc4" from="Microsoft" modified="false" />
  44           <para>Initializes a new instance of the <see cref="T:System.Web.Services.WebServiceAttribute" /> class.</para>
  45         </summary>
  46       </Docs>
  47       <AssemblyInfo>
  48         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
  49         <AssemblyVersion>2.0.0.0</AssemblyVersion>
  50       </AssemblyInfo>
  51     </Member>
  52     <Member MemberName="DefaultNamespace">
  53       <MemberSignature Language="C#" Value="public const string DefaultNamespace;" />
  54       <MemberType>Field</MemberType>
  55       <ReturnValue>
  56         <ReturnType>System.String</ReturnType>
  57       </ReturnValue>
  58       <Parameters />
  59       <Docs>
  60         <remarks>To be added</remarks>
  61         <summary>
  62           <attribution license="cc4" from="Microsoft" modified="false" />
  63           <para>The default value for the <see cref="P:System.Web.Services.WebServiceAttribute.Namespace" /> property. This field is constant.</para>
  64         </summary>
  65       </Docs>
  66       <AssemblyInfo>
  67         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
  68         <AssemblyVersion>2.0.0.0</AssemblyVersion>
  69       </AssemblyInfo>
  70     </Member>
  71     <Member MemberName="Description">
  72       <MemberSignature Language="C#" Value="public string Description { set; get; }" />
  73       <MemberType>Property</MemberType>
  74       <ReturnValue>
  75         <ReturnType>System.String</ReturnType>
  76       </ReturnValue>
  77       <Parameters />
  78       <Docs>
  79         <value>To be added: an object of type 'string'</value>
  80         <remarks>
  81           <attribution license="cc4" from="Microsoft" modified="false" />
  82           <para>The descriptive message is displayed to prospective consumers of the XML Web service when description documents for the XML Web service are generated, such as the Service Description and the Service help page.</para>
  83         </remarks>
  84         <summary>
  85           <attribution license="cc4" from="Microsoft" modified="false" />
  86           <para>A descriptive message for the XML Web service.</para>
  87         </summary>
  88       </Docs>
  89       <AssemblyInfo>
  90         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
  91         <AssemblyVersion>2.0.0.0</AssemblyVersion>
  92       </AssemblyInfo>
  93     </Member>
  94     <Member MemberName="Name">
  95       <MemberSignature Language="C#" Value="public string Name { set; get; }" />
  96       <MemberType>Property</MemberType>
  97       <ReturnValue>
  98         <ReturnType>System.String</ReturnType>
  99       </ReturnValue>
 100       <Parameters />
 101       <Docs>
 102         <value>To be added: an object of type 'string'</value>
 103         <remarks>
 104           <attribution license="cc4" from="Microsoft" modified="false" />
 105           <para>The Service Description is generated when a user navigates to the URL for the XML Web service and supplies a query string of ?WSDL. Within the Service Description, the <see cref="P:System.Web.Services.WebServiceAttribute.Name" /> property identifies the local part of the XML qualified name for the XML Web service. The Name property is also used to display the name of the XML Web service on the Service help page. The Service help page is displayed when a prospective consumer navigates to the.asmx page for the XML Web service without specifying an XML Web service method name and its parameters.</para>
 106           <para>An XML qualified name is used to disambiguate elements with the same name with an XML document. An XML qualified name consists of the following two parts separated by a colon: namespace or a prefix associated with a namespace and local part. The namespace consists of a URI reference and for the purposes of the Service Description, is the value of the <see cref="P:System.Web.Services.WebServiceAttribute.Namespace" /> property. In general, a prefix, which acts like an alias to an URI, is associated with the namespace, so that all subsequent XML qualified names using the namespace can use the shortened prefix. The local part is a string beginning with a letter or underscore containing no spaces. Therefore, the XML qualified name identifying a XML Web service in the Service Description is in the following format: </para>
 107           <para>
 108             <see cref="P:System.Web.Services.WebServiceAttribute.Namespace" /> : <see cref="P:System.Web.Services.WebServiceAttribute.Name" /> </para>
 109           <para>For more information on XML qualified names, see http://www.w3.org/TR/REC-xml-names/.</para>
 110         </remarks>
 111         <summary>
 112           <attribution license="cc4" from="Microsoft" modified="false" />
 113           <para>Gets or sets the name of the XML Web service.</para>
 114         </summary>
 115       </Docs>
 116       <AssemblyInfo>
 117         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 118         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 119       </AssemblyInfo>
 120     </Member>
 121     <Member MemberName="Namespace">
 122       <MemberSignature Language="C#" Value="public string Namespace { set; get; }" />
 123       <MemberType>Property</MemberType>
 124       <ReturnValue>
 125         <ReturnType>System.String</ReturnType>
 126       </ReturnValue>
 127       <Parameters />
 128       <Docs>
 129         <value>To be added: an object of type 'string'</value>
 130         <remarks>
 131           <attribution license="cc4" from="Microsoft" modified="false" />
 132           <para>XML namespaces offer a way to create names in an XML document that are identified by a Uniform Resource Identifier (URI). By using XML namespaces you can uniquely identify elements or attributes in a XML document. The service description for a XML Web service is defined in XML, specifically in Web Services Description Language (WSDL).</para>
 133           <para>Within the Service Description for an XML Web service, <see cref="P:System.Web.Services.WebServiceAttribute.Namespace" /> is used as the default namespace for XML elements directly pertaining to the XML Web service. For example, the name of the XML Web service and its XML Web service methods pertain to the namespace specified in the Namespace property. Elements that are specific to WSDL pertain to the http://schemas.xmlsoap.org/wsdl/ namespace.</para>
 134           <para>For XML Web service clients using SOAP to call an XML Web service, you can optionally add the <see cref="T:System.Web.Services.Protocols.SoapDocumentMethodAttribute" /> or <see cref="T:System.Web.Services.Protocols.SoapRpcMethodAttribute" /> to call an XML Web service method. If the client is calling an XML Web service created using ASP.NET, the <see cref="P:System.Web.Services.Protocols.SoapDocumentMethodAttribute.RequestNamespace" />, <see cref="P:System.Web.Services.Protocols.SoapDocumentMethodAttribute.ResponseNamespace" /> and <see cref="P:System.Web.Services.Protocols.SoapDocumentMethodAttribute.Action" /> properties are all derived from the <see cref="P:System.Web.Services.WebServiceAttribute.Namespace" /> property by default. For instance, given an XML Web service method name of Time and a Namespace property of http://www.contoso.com/, the Action property is http://www.contoso.com/Time by default. To change the default settings for RequestNamespace, ResponseNamespace, and Action for an XML Web service method, you can add a <see cref="T:System.Web.Services.Protocols.SoapDocumentMethodAttribute" /> to the XML Web service method.</para>
 135           <block subset="none" type="note">
 136             <para>An XML namespace is different from the namespace the class resides in, in terms of the winsdklong. To specify the namespace for the class, see <format type="text/html"><a href="091a66eb-b10d-4f54-9102-5ac0d4bdb84b">Namespaces (C# Programmer's Reference)</a></format> if you writing in C#.</para>
 137           </block>
 138         </remarks>
 139         <summary>
 140           <attribution license="cc4" from="Microsoft" modified="false" />
 141           <para>Gets or sets the default XML namespace to use for the XML Web service.</para>
 142         </summary>
 143       </Docs>
 144       <AssemblyInfo>
 145         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 146         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 147       </AssemblyInfo>
 148     </Member>
 149   </Members>
 150 </Type>