ServiceDebugBehavior.HttpHelpPageEnabled Property

 

Gets or sets a value that controls whether Windows Communication Foundation (WCF) publishes an HTML help page at the address controlled by the HttpHelpPageUrl property.

Namespace:   System.ServiceModel.Description
Assembly:  System.ServiceModel (in System.ServiceModel.dll)

public bool HttpHelpPageEnabled { get; set; }

Property Value

Type: System.Boolean

true if WCF publishes an HTML help page; otherwise, false. The default is true.

Set the HttpHelpPageEnabled property to false to disable the publication of an HTML help page visible to HTML browsers.

To ensure the HTML help page is published at the location controlled by the HttpsHelpPageUrl property, you must set this property to true and then one of the following conditions must also be true:

  • The HttpsHelpPageUrl property is an absolute address that supports the HTTP protocol scheme.

  • There is a base address for the service that supports the HTTP protocol scheme.

Although an exception is thrown if an absolute address that does not support the HTTP protocol scheme is assigned to the HttpsHelpPageUrl property, any other scenario in which neither of the preceding criteria is met results in no exception and no HTML help page.

The following code example shows how to use a configuration file to enable the HTML help page feature and return exception information inside a SOAP fault back to the client for debugging purposes. This configuration file shows the following basic steps to adding support for the ServiceDebugBehavior features:

.NET Framework
Available since 3.0
Return to top
Show: