This documentation is archived and is not being maintained.

ServiceDebugElement.HttpsHelpPageEnabled Property

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.

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

[ConfigurationPropertyAttribute("httpsHelpPageEnabled", DefaultValue = true)]
public bool HttpsHelpPageEnabled { get; set; }

Property Value

Type: System.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.

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.

Windows 7, Windows Vista, Windows XP SP2, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

.NET Framework

Supported in: 3.5, 3.0