Share via

<wsdlHelpGenerator> Element

  • Article

This topic is specific to a legacy technology. XML Web services and XML Web service clients should now be created using Windows Communication Foundation.

Specifies the Web service Help page (an .aspx file) that is displayed to a browser when the browser navigates directly to an ASMX Web services page.

Schema Hierarchy

<configuration>
  <system.web>
    <webServices> Element
      <wsdlHelpGenerator> Element

Syntax

<wsdlHelpGenerator href="path.aspx"/>

Attributes and Elements

The following sections describe attributes, child elements, and parent elements.

Attributes

Attribute Description

href

Required attribute.

The file path to the Help page.

Child Elements

None.

Parent Elements

Element Description

configuration

The root element in every configuration file used by the common language runtime and .NET Framework applications.

system.web

Specifies the root element for the ASP.NET configuration section.

webServices

Controls the settings of Web services deployed using ASP.NET and of Web service clients running on the .NET Framework.

Remarks

You can create your own Help page containing images and text for your Web service application. The following code example is an excerpt from a Web.config file that sets the Help page to a custom MyServiceHelpPage.aspx file in the docs folder beneath the folder containing the main application files and the Web.config file.

The value of href is a file path, not a URL. The file path can be relative or absolute. If it is relative, it is relative to the location of the configuration file.

Example

<configuration>
   <system.web>
      <webServices>
         <wsdlHelpGenerator href="docs/MyServiceHelpPage.aspx"/>
      </webServices>
   </system.web>
</configuration>

See Also

Reference

<webServices> Element

Other Resources

ASP.NET Settings Schema
XML Web Services Created Using ASP.NET and XML Web Service Clients