Share via


SummaryLink.LinkUrl property

Gets or sets the URL of the link item to which this SummaryLink object links.

Namespace:  Microsoft.SharePoint.Publishing
Assembly:  Microsoft.SharePoint.Publishing (in Microsoft.SharePoint.Publishing.dll)

Syntax

'Declaration
Public Property LinkUrl As String
    Get
    Set
'Usage
Dim instance As SummaryLink
Dim value As String

value = instance.LinkUrl

instance.LinkUrl = value
public string LinkUrl { get; set; }

Property value

Type: System.String
URL of the link item to which this SummaryLink object links.

Exceptions

Exception Condition
ArgumentException

Invalid property value. The value cannot exceed 2047 characters.

ArgumentException

URL is not valid.

Remarks

The LinkUrl property can be empty. If the LinkUrl property contains a string that is not empty, the string must be a URL that is either server-relative or fully qualified. Server-relative URLs start with a single backslash character. A fully qualified LinkUrl must have one of the following allowed protocols:

  • http:

  • https:

  • file:

  • ftp:

  • mailto:

  • msn:

  • news:

  • nntp:

  • pnm:

  • mms:

  • outlook:

If the URL starts with "//" or "\\" it is considered to be a file: protocol and the beginning two slashes are replaced with file://. When setting the value, the input is first stripped of leading and trailing whitespace before being applied. If the absolute URL refers to an item in the current site collection, it is turned into a server-relative URL prior to being applied. This value is available in the XSL rendering through the @LinkUrl parameter.

Examples

// Add Groups and links.
            // The link style set here must correspond to one of the template names in the XSL Item style
            // This is not verified by the OM, but an incorrect template name results in the
            // link not rendering.
            
            // GroupA

            summaryLink = summaryLinks.Add("GroupA");
            summaryLink.IsGroupHeader = true;

            summaryLink = summaryLinks.Add("Link1");
            summaryLink.Description = "Description1";
            summaryLink.Style = "Default";
            summaryLink.ImageUrl = "http://www.live.com/live/1.100.7.337/img/wl_jewel.gif";
            summaryLink.LinkUrl = "http://www.example.com/link1";

            summaryLink = summaryLinks.Add("Link2");
            summaryLink.Description = "Description2";
            summaryLink.Style = "Default";
            summaryLink.ImageUrl = "http://www.live.com/live/1.100.7.337/img/wl_jewel.gif";
            summaryLink.LinkUrl = "http://www.example.com/link2";

            // GroupB

            summaryLink = summaryLinks.Add("GroupB");
            summaryLink.IsGroupHeader = true;

            summaryLink = summaryLinks.Add("Link3");
            summaryLink.Description = "Description3";
            summaryLink.Style = "Default";
            summaryLink.ImageUrl = "http://www.live.com/live/1.100.7.337/img/wl_jewel.gif";
            summaryLink.LinkUrl = "http://www.example.com/link3";
            summaryLink.LinkToolTip = "Tooltip for link3";

            return summaryLinkValue;
' Add Groups and links.
' The link style set here must correspond to one of the template names in the XSL Item style
' This is not verified by the OM, but an incorrect template name results in the
' link not rendering.

' GroupA

summaryLink = summaryLinks.Add("GroupA")
summaryLink.IsGroupHeader = True

summaryLink = summaryLinks.Add("Link1")
summaryLink.Description = "Description1"
summaryLink.Style = "Default"
summaryLink.ImageUrl = "http://www.live.com/live/1.100.7.337/img/wl_jewel.gif"
summaryLink.LinkUrl = "http://www.example.com/link1"

summaryLink = summaryLinks.Add("Link2")
summaryLink.Description = "Description2"
summaryLink.Style = "Default"
summaryLink.ImageUrl = "http://www.live.com/live/1.100.7.337/img/wl_jewel.gif"
summaryLink.LinkUrl = "http://www.example.com/link2"

' GroupB

summaryLink = summaryLinks.Add("GroupB")
summaryLink.IsGroupHeader = True

summaryLink = summaryLinks.Add("Link3")
summaryLink.Description = "Description3"
summaryLink.Style = "Default"
summaryLink.ImageUrl = "http://www.live.com/live/1.100.7.337/img/wl_jewel.gif"
summaryLink.LinkUrl = "http://www.example.com/link3"
summaryLink.LinkToolTip = "Tooltip for link3"

Return summaryLinkValue

Note

This code example is part of a larger code example in the SummaryLink topic.

See also

Reference

SummaryLink class

SummaryLink members

Microsoft.SharePoint.Publishing namespace

IsPeopleLink

LinkToolTip

LoginName