ImportCatalogPart.BrowseHelpText Propriedade

Definição

Namespace:

System.Web.UI.WebControls.WebParts

Assembly:

System.Web.dll

Obtém ou define uma mensagem de texto que instrui os usuários a navegar até o local de um arquivo de descrição.

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

public string BrowseHelpText { get; set; }

member this.BrowseHelpText : string with get, set

Public Property BrowseHelpText As String

Valor da propriedade

String

Uma cadeia de caracteres que contém o texto da mensagem. O valor padrão é uma mensagem específica da cultura fornecida pelo .NET Framework.

Exemplos

O exemplo de código a seguir demonstra como usar a BrowseHelpText propriedade declarativamente e programaticamente. Para obter o código completo e as instruções necessárias para executar o exemplo, consulte a seção Exemplo da visão geral da ImportCatalogPart classe.

Na seção de código a seguir, observe que o valor da BrowseHelpText propriedade é definido declarativamente para o controle.

<asp:CatalogZone ID="CatalogZone1" runat="server">
  <ZoneTemplate>
    <asp:ImportCatalogPart ID="ImportCatalogPart1" 
      runat="server" 
      Title="My ImportCatalogPart" 
      OnPreRender="ImportCatalogPart1_PreRender"
      BrowseHelpText="Type a path or browse to find a control's 
        description file." 
      UploadButtonText="Upload Description File" 
      UploadHelpText="Click the button to upload the description 
        file."
      ImportedPartLabelText="My User Information WebPart" 
      PartImportErrorLabelText="An error occurred while trying 
        to import a description file."  />
  </ZoneTemplate>
</asp:CatalogZone>

<asp:CatalogZone ID="CatalogZone1" runat="server">
  <ZoneTemplate>
    <asp:ImportCatalogPart ID="ImportCatalogPart1" 
      runat="server" 
      Title="My ImportCatalogPart" 
      OnPreRender="ImportCatalogPart1_PreRender"
      BrowseHelpText="Type a path or browse to find a control's 
        description file." 
      UploadButtonText="Upload Description File" 
      UploadHelpText="Click the button to upload the description 
        file."
      ImportedPartLabelText="My User Information WebPart" 
      PartImportErrorLabelText="An error occurred while trying 
        to import a description file."  />
  </ZoneTemplate>
</asp:CatalogZone>

Nesta seção de código, o valor da BrowseHelpText propriedade é atribuído programaticamente.

protected void Button1_Click(object sender, EventArgs e)
{
  ImportCatalogPart1.Title = "Import Server Controls";
  ImportCatalogPart1.BrowseHelpText = "Enter the path to a "
    + "description file.";
  ImportCatalogPart1.UploadButtonText = "Upload Description";
  ImportCatalogPart1.UploadHelpText = "Upload a description file.";
  ImportCatalogPart1.ImportedPartLabelText = "Imported Controls";
  ImportCatalogPart1.PartImportErrorLabelText = "An error occurred " 
    + "during the import process.";

}

Protected Sub Button1_Click(ByVal sender As Object, _
  ByVal e As EventArgs)
    ImportCatalogPart1.Title = "Import Server Controls"
    ImportCatalogPart1.BrowseHelpText = "Enter the path to a " _
      & "description file."
    ImportCatalogPart1.UploadButtonText = "Upload Description"
    ImportCatalogPart1.UploadHelpText = "Upload a description file."
    ImportCatalogPart1.ImportedPartLabelText = "Imported Controls"
    ImportCatalogPart1.PartImportErrorLabelText = "An error occurred " _
      & "during the import process."
End Sub

Ao carregar a página em um navegador, você pode usar o controle de lista suspensa Modo de Exibição para selecionar o Modo de Catálogo e alternar a página para o modo de catálogo. Com a página no modo de catálogo e o arquivo de descrição carregado, observe as várias cadeias de caracteres de texto exibidas na interface do usuário para o ImportCatalogPart controle. Se você clicar no botão Carregar Arquivo de Descrição , o texto de várias das propriedades na interface do usuário será alterado, incluindo o texto da BrowseHelpText propriedade.

Comentários

A BrowseHelpText propriedade fornece aos usuários uma visão geral simples da primeira coisa que eles devem fazer no processo de adicionar um controle importado: fornecer o local de um arquivo de descrição, digitando em um caminho ou navegando até o arquivo. Um motivo típico para fornecer um valor personalizado para essa propriedade é se você tiver instruções especiais para os usuários, como um compartilhamento de rede específico para o qual eles devem procurar para localizar um arquivo de descrição.

Confira também

• controles de Web Parts ASP.NET