Edit

ServiceDebugElement.HttpsHelpPageEnabled Property

  • Reference

Definition

Namespace:
System.ServiceModel.Configuration
Assembly:
System.ServiceModel.dll

Gets or sets a value that specifies whether Windows Communication Foundation (WCF) returns an HTML help file over HTTPS at the address specified by the HttpsHelpPageUrl property.

public:
 property bool HttpsHelpPageEnabled { bool get(); void set(bool value); };
[System.Configuration.ConfigurationProperty("httpsHelpPageEnabled", DefaultValue=true)]
public bool HttpsHelpPageEnabled { get; set; }
[<System.Configuration.ConfigurationProperty("httpsHelpPageEnabled", DefaultValue=true)>]
member this.HttpsHelpPageEnabled : bool with get, set
Public Property HttpsHelpPageEnabled As Boolean

Property Value

Boolean

true if an HTML help file is returned to clients making an HTTPS/GET request, for example, from an HTML browser; 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 HttpsHelpPageUrl property, you must set this property to true. In addition, one of the following conditions must also be met:

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

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

  • Although an exception is thrown if an absolute address that does not support the HTTPS 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.

Applies to