ServiceDebugBehavior.HttpHelpPageEnabled Propiedad

Definición

Espacio de nombres:

System.ServiceModel.Description

Ensamblado:

System.ServiceModel.dll

Obtiene o establece un valor que controla si Windows Communication Foundation (WCF) publica una página de ayuda HTML en la dirección controlada por la propiedad HttpHelpPageUrl.

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

public bool HttpHelpPageEnabled { get; set; }

member this.HttpHelpPageEnabled : bool with get, set

Public Property HttpHelpPageEnabled As Boolean

Valor de propiedad

Boolean

true si WCF publica una página de ayuda HTML; de lo contrario, false. De manera predeterminada, es true.

Ejemplos

El ejemplo de código siguiente muestra cómo utilizar un archivo de configuración para habilitar la característica de página de ayuda HTML y devolver información de excepción dentro de un error SOAP al cliente para la depuración. Este archivo de configuración muestra los siguientes pasos básicos para agregar compatibilidad con las características de ServiceDebugBehavior:

• Dado que el ServiceDebugBehavior tipo es una System.ServiceModel.Description.IServiceBehavior implementación, el <elemento de servicio> que representa el tipo de servicio tiene un identificador de configuración de comportamiento de behaviorConfiguration="metadataAndDebug".

• De nuevo, dado que el ServiceDebugBehavior tipo es una System.ServiceModel.Description.IServiceBehavior implementación, se agrega un <elemento de comportamiento> a una <sección serviceBehaviors> . Atributo name del <elemento de comportamiento> del que es el identificador del behaviorConfiguration atributo del <elemento de servicio> . En este caso, el valor es metadataAndDebug.

• Agregue un <elemento serviceDebug> con los distintos atributos establecidos en la configuración deseada. En este caso, los valores de atributo httpHelpPageEnabled y includeExceptionDetailInFaults se establecen en true.

<configuration>
  <system.serviceModel>
    <services>
      <!-- 
        Step 1. Add a behaviorConfiguration attribute
        in the <service> element.
      -->
      <service 
        name="Microsoft.WCF.Documentation.SampleService"
        behaviorConfiguration="metadataAndDebug">
        <host>
          <baseAddresses>
            <add baseAddress="http://localhost:8080/SampleService" />
          </baseAddresses>
        </host>
        <endpoint
          address=""
          binding="wsHttpBinding"
          contract="Microsoft.WCF.Documentation.ISampleService"
        />
        <endpoint
           address="mex"
           binding="mexHttpBinding"
           contract="IMetadataExchange"
        />
      </service>
    </services>
    <behaviors>
      <serviceBehaviors>
        <!-- 
          Step 2. Inside a <serviceBehaviors> section, add 
          a name attribute in the <behaviors> element that 
          matches the behaviorConfiguration attribute in the
          <service> element above.
        -->
        <behavior name="metadataAndDebug">
          <serviceMetadata 
            httpGetEnabled="true" 
            httpGetUrl=""
          />
          <!-- 
            Step 3. Add a <serviceDebug> element and 
            modify the various attributes that suit your 
            scenario.
          -->
          <serviceDebug 
            httpHelpPageEnabled="true" 
            includeExceptionDetailInFaults="true"
          />
        </behavior>
      </serviceBehaviors>
    </behaviors>
  </system.serviceModel>
</configuration>

Comentarios

Establezca la propiedad HttpHelpPageEnabled como false para deshabilitar la publicación de una página de ayuda HTML visible en exploradores HTML.

Para asegurarse de que la página de ayuda HTML se publica en la ubicación controlada por la propiedad HttpsHelpPageUrl, debe establecer esta propiedad como true y, a continuación, una de las condiciones siguientes también debe ser verdad:

• La propiedad HttpsHelpPageUrl es una dirección absoluta que admite el esquema del protocolo HTTP.

• Hay una dirección base para el servicio que admite el esquema del protocolo HTTP.

Aunque se inicie una excepción si una dirección absoluta que no admite el esquema del protocolo HTTP está asignada a la propiedad HttpsHelpPageUrl, cualquier otro escenario en el que ninguno de los criterios anteriores se cumpla no tiene como resultado ninguna excepción ni ninguna página de ayuda HTML.