WebPart.HelpLink property
NOTE: This API is now obsolete.
Obtém ou define um caminho de URL ou arquivo do sistema para um arquivo de Ajuda em formato HTML.
Namespace: Microsoft.SharePoint.WebPartPages
Assembly: Microsoft.SharePoint (in Microsoft.SharePoint.dll)
Syntax
'Declaração
<WebPartStorageAttribute(Storage.Shared)> _
<HtmlDesignerAttribute("", HtmlEditorBuilderType := "file")> _
<ObsoleteAttribute("Use HelpUrl instead.")> _
Public Property HelpLink As String
Get
Set
'Uso
Dim instance As WebPart
Dim value As String
value = instance.HelpLink
instance.HelpLink = value
[WebPartStorageAttribute(Storage.Shared)]
[HtmlDesignerAttribute("", HtmlEditorBuilderType = "file")]
[ObsoleteAttribute("Use HelpUrl instead.")]
public string HelpLink { get; set; }
Property value
Type: System.String
Um string que especifica uma URL para um arquivo HTML que pode ser usado para fornecer informações descritivas ou instruções. O valor padrão é String.Empty.
Comentários
Use essa propriedade para retornar o conteúdo que irão ajudar o usuário final interagir com uma Web Part. Quando você define essa propriedade, a infra-estrutura de Web Part adiciona um comando de Ajuda para o menu Web Part durante a renderização. Clicar no comando Ajuda abre uma nova janela de navegador, navega para essa URL.
Essa propriedade não pode ser personalizada por usuários individuais. O valor de sua WebPartStorageAttribute é Storage.Shared, que especifica que a propriedade é armazenada com o mesmo valor para todos os usuários. Somente os usuários com o direito de gravar páginas da web podem definir essa propriedade. Ela pode ser definida de forma programática ou ela pode ser definida por meio do painel de tarefas de Web Part na exibição compartilhada da interface do usuário baseado na Web, ou usando um SharePoint Foundation-compatível editor de HTML, como SharePoint Designer.