WebPart.HelpLink - Propriété
Remarque : cette API est désormais obsolète.
Obtient ou définit un chemin d'accès de système de fichier ou URL vers un fichier d'aide au format HTML.
Espace de noms : Microsoft.SharePoint.WebPartPages
Assembly : Microsoft.SharePoint (dans Microsoft.SharePoint.dll)
Syntaxe
'Déclaration
<WebPartStorageAttribute(Storage.Shared)> _
<HtmlDesignerAttribute("", HtmlEditorBuilderType := "file")> _
<ObsoleteAttribute("Use HelpUrl instead.")> _
Public Property HelpLink As String
Get
Set
'Utilisation
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; }
Valeur de propriété
Type : System.String
string qui spécifie une URL vers un fichier HTML qui peut être utilisé pour fournir des informations descriptives ou des instructions. La valeur par défaut est String.Empty.
Remarques
Utilisez cette propriété pour renvoyer le contenu qui aide les utilisateurs finaux interagissent avec un composant WebPart. Lorsque vous définissez cette propriété, l'infrastructure de composant WebPart ajoute une commande d'aide sur le menu composant WebPart lors du rendu. En cliquant sur la commande aide ouvre une nouvelle fenêtre de navigateur, qui accède à cette URL.
Cette propriété ne peut pas être personnalisée par des utilisateurs individuels. La valeur de sa WebPartStorageAttribute est Storage.Shared, qui spécifie que la propriété est enregistrée avec la même valeur pour tous les utilisateurs. Seuls les utilisateurs disposant du droit d'écrire des pages web peuvent définir cette propriété. Elle peut être définie par programme, ou elle peut être définie via le volet Office de composant WebPart dans l'affichage partagé de l'interface utilisateur basée sur le Web, ou à l'aide d'un SharePoint Foundation-éditeur HTML compatible avec, tel que SharePoint Designer.