Edit

Share via


WebHttpBehavior.HelpEnabled Property

Definition

Gets or sets a value that determines if the WCF Help page is enabled.

public:
 virtual property bool HelpEnabled { bool get(); void set(bool value); };
public virtual bool HelpEnabled { get; set; }
member this.HelpEnabled : bool with get, set
Public Overridable Property HelpEnabled As Boolean

Property Value

true if the WCFHelp page is enabled; otherwise false.

Remarks

For more information about the WCF REST Help page, see WCF Web HTTP Service Help Page.

To enable the helpEnabled attribute in a configuration file:

<system.serviceModel>
    <behaviors>
        <endpointBehaviors>
            <behavior name="MyEndpointBehavior">
                <webHttp helpEnabled="true" />
            </behavior>
    </endpointBehaviors>
</system.serviceModel>

To programmatically enable the HelpEnabled property:

WebHttpBehavior helpBehavior = new WebHttpBehavior();
helpBehavior.HelpEnabled = true;
host.Description.Endpoints[0].Behaviors.Add(helpBehavior);

Applies to