WebPart.DetailLink Property
NOTE: This API is now obsolete.
Gets or sets a URL to an HTML document that contains supplemental information.
Namespace: Microsoft.SharePoint.WebPartPages
Assembly: Microsoft.SharePoint (in Microsoft.SharePoint.dll)
Available in Sandboxed Solutions: No
Syntax
'Declaration
<HtmlDesignerAttribute("", HtmlEditorBuilderType := "file")> _
<ObsoleteAttribute("Use TitleUrl instead.")> _
<WebPartStorageAttribute(Storage.Shared)> _
Public Property DetailLink As String
Get
Set
'Usage
Dim instance As WebPart
Dim value As String
value = instance.DetailLink
instance.DetailLink = value
[HtmlDesignerAttribute("", HtmlEditorBuilderType = "file")]
[ObsoleteAttribute("Use TitleUrl instead.")]
[WebPartStorageAttribute(Storage.Shared)]
public string DetailLink { get; set; }
Property Value
Type: System.String
A string that specifies the URL of a page. The default value is String.Empty.
Remarks
Use the DetailLink property to link to more information about a Web Part. If you set the DetailLink property, clicking the title of the Web Part navigates to the URL you provide.
No target attribute is set on the hyperlink. The target document opens in the same window that hosts the Web Part Page. To return to the Web Part Page, you can provide a redirector to the page.
For example, you can use this property to create a Web Part that exposes top news headlines. You can provide navigation to the news site's home page to display all news headlines. A Web Part that displays stock quotes can provide a link to the site's main home page that offers many other financial services.
This property cannot be personalized by individual users. The value of its WebPartStorageAttribute is Storage.Shared, which specifies that the property is stored with the same value for all users. Only users with the Write web pages right can set this property. It can be set programmatically, or it can be set through the Web Part task pane in the shared view of the Web-based user interface, or by using a SharePoint Foundation–compatible HTML editor, such as SharePoint Designer.