Share via


SummaryLink.Style Property

Gets or sets the style in which to render this SummaryLink object.

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

Syntax

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

value = instance.Style

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

Property Value

Type: System.String
The style in which to render this SummaryLink object.

Remarks

Summary Links are displayed through the SummaryLinkWebPart and SummaryLinkFieldControl objects. These controls have associated XSL style sheets that contain XSL templates that are used to render the links. The template that is applied for rendering this link is the template with a name matching this Style name. This value is available in the XSL rendering through the @Style 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