ServiceDebugElement.HttpHelpPageEnabled Property

Definition

Namespace:

System.ServiceModel.Configuration

Assembly:

System.ServiceModel.dll

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

public:
 property bool HttpHelpPageEnabled { bool get(); void set(bool value); };

[System.Configuration.ConfigurationProperty("httpHelpPageEnabled", DefaultValue=true)]
public bool HttpHelpPageEnabled { get; set; }

[<System.Configuration.ConfigurationProperty("httpHelpPageEnabled", DefaultValue=true)>]
member this.HttpHelpPageEnabled : bool with get, set

Public Property HttpHelpPageEnabled As Boolean

Property Value

Boolean

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

Attributes

ConfigurationPropertyAttribute

Remarks

You can set this 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 HttpHelpPageUrl property, you must set this property to true. In addition, one of the following conditions must also be met:

• The HttpHelpPageUrl 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 HttpHelpPageUrl property, any other scenario in which neither of the preceding criteria is met results in no exception and no HTML help page.