ServiceDebugBehavior.HttpHelpPageEnabled Propriedade

Definição

Namespace:

System.ServiceModel.Description

Assembly:

System.ServiceModel.dll

Obtém ou define um valor que controla se o WCF (Windows Communication Foundation) publica uma página de ajuda HTML no endereço controlado pela propriedade 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 da propriedade

Boolean

true se o WCF publicar uma página de ajuda HTML; caso contrário, false. O padrão é true.

Exemplos

O exemplo de código a seguir mostra como usar um arquivo de configuração para habilitar o recurso de página de ajuda HTML e retornar informações de exceção dentro de uma falha SOAP de volta ao cliente para fins de depuração. Este arquivo de configuração mostra as seguintes etapas básicas para adicionar suporte aos ServiceDebugBehavior recursos:

• Como o ServiceDebugBehavior tipo é uma System.ServiceModel.Description.IServiceBehavior implementação, o <elemento de serviço> que representa o tipo de serviço tem um identificador de configuração de comportamento de behaviorConfiguration="metadataAndDebug".

• Novamente, como o ServiceDebugBehavior tipo é uma System.ServiceModel.Description.IServiceBehavior implementação, um <elemento de comportamento> é adicionado a uma <seção serviceBehaviors> . O name atributo do <elemento de comportamento> do qual o valor é o identificador do behaviorConfiguration atributo do <elemento de serviço> . Nesse caso, o valor é metadataAndDebug.

• Adicione um <elemento serviceDebug> com os vários atributos definidos para a configuração desejada. Nesse caso, os valores e includeExceptionDetailInFaults o httpHelpPageEnabled atributo são definidos como 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>

Comentários

Defina a HttpHelpPageEnabled propriedade para false desabilitar a publicação de uma página de ajuda HTML visível para navegadores HTML.

Para garantir que a página de ajuda HTML seja publicada no local controlado pela HttpsHelpPageUrl propriedade, você deve definir essa propriedade true e, em seguida, uma das seguintes condições também deve ser verdadeira:

• A HttpsHelpPageUrl propriedade é um endereço absoluto que dá suporte ao esquema de protocolo HTTP.

• Há um endereço base para o serviço que dá suporte ao esquema de protocolo HTTP.

Embora uma exceção seja gerada se um endereço absoluto que não dá suporte ao esquema de protocolo HTTP for atribuído à HttpsHelpPageUrl propriedade, qualquer outro cenário no qual nenhum dos critérios anteriores é atendido resulta em nenhuma exceção e nenhuma página de ajuda HTML.