ConnectionsZone.InstructionTitle Propriedade

Referência

Definição

Namespace:: System.Web.UI.WebControls.WebParts

Assembly:: System.Web.dll

Importante

Algumas informações se referem a produtos de pré-lançamento que podem ser substancialmente modificados antes do lançamento. A Microsoft não oferece garantias, expressas ou implícitas, das informações aqui fornecidas.

Obtém ou define o texto usado para uma descrição geral da ação que pode ser executada no controle do consumidor ou do provedor, dentro da IU (interface do usuário) de conexão para gerenciar conexões existentes.

public:
 virtual property System::String ^ InstructionTitle { System::String ^ get(); void set(System::String ^ value); };

public virtual string InstructionTitle { get; set; }

member this.InstructionTitle : string with get, set

Public Overridable Property InstructionTitle As String

Valor da propriedade

String

Uma cadeia de caracteres que contém o título da instrução para a interface do usuário da conexão. O texto padrão é uma cadeia de caracteres específica à cultura fornecida pelo .NET Framework.

Exemplos

O exemplo de código a seguir demonstra o uso da InstructionTitle propriedade com um ConnectionsZone controle. O exemplo contém apenas o código para a página da Web que demonstra o uso da propriedade; para os outros dois arquivos de código necessários para executar o exemplo, consulte a seção Exemplo da visão geral da ConnectionsZone classe. O exemplo de código tem quatro partes:

Um controle de usuário que permite alternar os modos de exibição na página da Web. Obtenha esse código da visão geral da ConnectionsZone classe.
Um arquivo de origem que contém o código para uma interface de CEP e dois WebPart controles que atuam como o provedor e o consumidor de uma conexão. Obtenha esse código da visão geral da ConnectionsZone classe.
Uma página da Web que hospeda todos os controles, declara um <asp:connectionszone> elemento e mostra como usar a propriedade programaticamente.
Uma explicação de como o exemplo funciona em um navegador.

A página da Web declara um <asp:connectionszone> elemento e, no Page_PreRender método, o código atribui um valor à InstructionTitle propriedade.

<%@ Page Language="C#" %>
<%@ register tagprefix="uc1" 
    tagname="DisplayModeMenuCS"
    src="~/displaymodemenucs.ascx" %>
<%@ Register TagPrefix="aspSample" 
    Namespace="Samples.AspNet.CS.Controls" %>

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" 
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<script runat="server">

  protected void Page_PreRender(object sender, EventArgs e)
  {
     // Set properties on verbs.
     connectionsZone1.CancelVerb.Description = 
       "Terminates the connection process";
     connectionsZone1.CloseVerb.Description = 
       "Closes the connections UI";
     connectionsZone1.ConfigureVerb.Description =
       "Configure the transformer for the connection";
     connectionsZone1.ConnectVerb.Description =
       "Connect two WebPart controls";
     connectionsZone1.DisconnectVerb.Description =
       "End the connection between two controls";
    
     // Set properties for UI text strings.
     connectionsZone1.ConfigureConnectionTitle = 
       "Configure";
     connectionsZone1.ConnectToConsumerInstructionText = 
       "Choose a consumer connection point";
     connectionsZone1.ConnectToConsumerText = 
       "Select a consumer for the provider to connect with";
     connectionsZone1.ConnectToConsumerTitle = 
       "Send data to this consumer";
     connectionsZone1.ConnectToProviderInstructionText =
       "Choose a provider connection point";
     connectionsZone1.ConnectToProviderText =
       "Select a provider for the consumer to connect with";
     connectionsZone1.ConnectToProviderTitle =
       "Get data from this provider";
     connectionsZone1.ConsumersInstructionText = 
       "WebPart controls that receive data from providers";
     connectionsZone1.ConsumersTitle = "Consumer Controls";
     connectionsZone1.GetFromText = "Receive from";
     connectionsZone1.GetText = "Retrieve";
     connectionsZone1.HeaderText = 
      "Create and Manage Connections";
     connectionsZone1.InstructionText = 
      "Manage connections for the selected WebPart control";
     connectionsZone1.InstructionTitle = 
       "Manage connections for consumers or providers";
     connectionsZone1.NoExistingConnectionInstructionText = 
       "No connections exist. Click the above link to create "
       + "a connection.";
     connectionsZone1.NoExistingConnectionTitle = 
       "No current connections";
     connectionsZone1.ProvidersInstructionText =
       "WebPart controls that send data to consumers";
     connectionsZone1.ProvidersTitle = "Provider controls";
     
  }
</script>

<html xmlns="http://www.w3.org/1999/xhtml" >
<head runat="server">
    <title>Connection Zone Sample</title>
</head>
<body>
  <form id="form1" runat="server">
  <asp:webpartmanager runat="server" id="mgr">
    <staticconnections>
      <asp:webpartconnection id="connection1" 
        consumerconnectionpointid="ZipCodeConsumer"
        consumerid="zipConsumer"
        providerconnectionpointid="ZipCodeProvider" 
        providerid="zipProvider" />
    </staticconnections>
  </asp:webpartmanager>
  <uc1:displaymodemenucs id="menu1" runat="server" />
  <div>
  <asp:webpartzone id="WebPartZone1" runat="server">
    <zonetemplate>
      <aspsample:zipcodewebpart id="zipProvider" runat="server" 
        Title="Zip Code Provider"  />
      <aspsample:weatherwebpart id="zipConsumer" runat="server" 
        Title="Zip Code Consumer" />
    </zonetemplate>
  </asp:webpartzone>
  <asp:connectionszone id="connectionsZone1" runat="server" >
    <cancelverb text="Terminate" />
    <closeverb text="Close Zone" />
    <configureverb text="Configure" />
    <connectverb text="Connect Controls" />
    <disconnectverb text="End Connection" />
  </asp:connectionszone>
  </div>
  </form>
</body>
</html>

<%@ Page Language="VB" %>
<%@ register tagprefix="uc1" 
    tagname="DisplayModeMenuVB"
    src="~/displaymodemenuvb.ascx" %>
<%@ Register TagPrefix="aspSample" 
    Namespace="Samples.AspNet.VB.Controls" %>

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" 
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<script runat="server">

  Protected Sub Page_PreRender(ByVal sender As Object, _
    ByVal e As System.EventArgs)
    
    ' Set properties for verbs.
    connectionsZone1.CancelVerb.Description = _
      "Terminates the connection process"
    connectionsZone1.CloseVerb.Description = _
      "Closes the connections UI"
    connectionsZone1.ConfigureVerb.Description = _
      "Configure the transformer for the connection"
    connectionsZone1.ConnectVerb.Description = _
      "Connect two WebPart controls"
    connectionsZone1.DisconnectVerb.Description = _
      "End the connection between two controls"
    
    ' Set properties for UI text strings.
    connectionsZone1.ConfigureConnectionTitle = _
      "Configure a new connection"
    connectionsZone1.ConnectToConsumerInstructionText = _
      "Choose a consumer connection point"
    connectionsZone1.ConnectToConsumerText = _
      "Select a consumer for the provider to connect with"
    connectionsZone1.ConnectToConsumerTitle = _
      "Send data to this consumer"
    connectionsZone1.ConnectToProviderInstructionText = _
      "Choose a provider connection point"
    connectionsZone1.ConnectToProviderText = _
      "Select a provider for the consumer to connect with"
    connectionsZone1.ConnectToProviderTitle = _
      "Get data from this provider"
    connectionsZone1.ConsumersInstructionText = _
      "WebPart controls that receive data from providers"
    connectionsZone1.ConsumersTitle = "Consumer Controls"
    connectionsZone1.GetFromText = "Receive from"
    connectionsZone1.GetText = "Retrieve"
    connectionsZone1.HeaderText = _
      "Create and Manage Connections"
    connectionsZone1.InstructionText = _
      "Manage connections for the selected WebPart control"
    connectionsZone1.InstructionTitle = _
      "Manage connections for consumers or providers"
    connectionsZone1.NoExistingConnectionInstructionText = _
      "No connections exist. Click the above link to create " _
      & "a connection."
    connectionsZone1.NoExistingConnectionTitle = _
      "No current connections"
    connectionsZone1.ProvidersInstructionText = _
      "WebPart controls that send data to consumers"
    connectionsZone1.ProvidersTitle = "Provider controls"

  End Sub

</script>

<html xmlns="http://www.w3.org/1999/xhtml" >
<head runat="server">
    <title>Connection Zone Sample</title>
</head>
<body>
  <form id="form1" runat="server">
  <asp:webpartmanager runat="server" id="mgr">
    <staticconnections>
      <asp:webpartconnection id="connection1" 
        consumerconnectionpointid="ZipCodeConsumer"
        consumerid="zipConsumer"
        providerconnectionpointid="ZipCodeProvider" 
        providerid="zipProvider" />
    </staticconnections>
  </asp:webpartmanager>
  <uc1:displaymodemenuvb id="menu1" runat="server" />
  <div>
  <asp:webpartzone id="WebPartZone1" runat="server">
    <zonetemplate>
      <aspsample:zipcodewebpart id="zipProvider" runat="server" 
        Title="Zip Code Provider" />
      <aspsample:weatherwebpart id="zipConsumer" runat="server" 
        Title="Zip Code Consumer" />
    </zonetemplate>
  </asp:webpartzone>
  <asp:connectionszone id="connectionsZone1" runat="server" >
    <cancelverb text="Terminate" />
    <closeverb text="Close Zone" />
    <configureverb text="Configure" />
    <connectverb text="Connect Controls" />
    <disconnectverb text="End Connection" />
  </asp:connectionszone>
  </div>
  </form>
</body>
</html>

Carregue a página em um navegador. Alterne para o modo de conexão, usando o controle Modo de Exibição . Clique na seta do menu de verbos no controle consumidor do CEP e clique no verbo de conexão. Na exibição aberta para a conexão existente, observe que o título da instrução logo abaixo do texto do cabeçalho, próximo à parte superior da zona de conexões, é o valor atribuído à InstructionTitle propriedade no exemplo de código.

Comentários

O texto contido na InstructionTitle propriedade fica visível sempre que a interface do usuário da conexão é exibida e uma conexão já existe. O texto do título da instrução está logo abaixo do texto do cabeçalho (contido na HeaderText propriedade), que é encontrado na parte superior da interface do usuário da conexão. O título da instrução é uma descrição geral que informa aos usuários que tipo de ação pode ser executada no controle de consumidor ou provedor WebPart que está participando de uma conexão existente. Por padrão, o título da instrução começa com Gerenciar as conexões e termina com o nome do consumidor ou do controle de provedor que o usuário selecionou clicando no verbo de conexão em seu menu de verbos.

Observação

Ao atribuir um valor personalizado a essa propriedade, lembre-se de que não é possível saber no momento do design se o usuário selecionará um provedor ou controle de consumidor no qual gerenciar a conexão, portanto, o título de instrução personalizado deve ser geral o suficiente para se referir a um consumidor ou a um controle de provedor. Por outro lado, o valor padrão da propriedade é renderizado de forma que ela acrescenta dinamicamente o nome de qualquer consumidor ou controle de provedor selecionado pelo usuário. Se você quiser fornecer um valor personalizado para a propriedade que imita esse comportamento, você deve herdar da ConnectionsZone classe e substituir essa propriedade ou o RenderBody método.

Você pode definir o valor dessa propriedade declarativamente dentro da marca de abertura do elemento, adicionando <asp:connectionszone> um atributo nomeado InstructionTitle e atribuindo-lhe um valor. Você também pode definir o valor da propriedade programaticamente.

Aplica-se a

Confira também

InstructionText

Partilhar via