WebPart.HelpLink-Eigenschaft
HINWEIS: Diese API ist veraltet.
Dient zum Abrufen oder Festlegen einer URL oder den Dateisystempfad zu einer Hilfedatei im HTML-Format.
Namespace: Microsoft.SharePoint.WebPartPages
Assembly: Microsoft.SharePoint (in Microsoft.SharePoint.dll)
Syntax
'Declaration
<WebPartStorageAttribute(Storage.Shared)> _
<HtmlDesignerAttribute("", HtmlEditorBuilderType := "file")> _
<ObsoleteAttribute("Use HelpUrl instead.")> _
Public Property HelpLink As String
Get
Set
'Usage
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; }
Eigenschaftswert
Typ: System.String
Ein string , der eine URL zu einer HTML-Datei, die verwendet werden können angibt, um beschreibende Informationen oder Anweisungen. Der Standardwert ist String.Empty.
Hinweise
Verwenden Sie diese Eigenschaft, um Inhalt zurückzugeben, die der Endbenutzer interagieren mit einem Webpart helfen. Wenn Sie diese Eigenschaft festlegen, hinzugefügt der Webpartinfrastruktur ein Hilfe-Befehls im Webpartmenü beim Rendern. Durch Klicken auf den Befehl Hilfe öffnet ein neues Browserfenster, die zu dieser URL navigiert.
Diese Eigenschaft kann nicht durch einzelne Benutzer personalisiert werden. Der Wert von dessen WebPartStorageAttribute ist Storage.Shared, der angibt, dass die Eigenschaft mit demselben Wert für alle Benutzer gespeichert wird. Nur Benutzer mit dem Recht Webseiten schreiben können diese Eigenschaft festlegen. Programmgesteuert festgelegt werden kann, oder festgelegt werden, durch den Webpart-Aufgabenbereich in die freigegebene Ansicht der webbasierte Benutzeroberfläche oder mit einer SharePoint Foundation-kompatiblen HTML-Editor wie beispielsweise SharePoint Designer.