SummaryLink.IsGroupHeader Property
Gets or sets a flag that determines whether this SummaryLink object is a group header that can be used to organize other SummaryLink objects.
Namespace: Microsoft.SharePoint.Publishing
Assembly: Microsoft.SharePoint.Publishing (in Microsoft.SharePoint.Publishing.dll)
Syntax
'Declaration
Public Property IsGroupHeader As Boolean
Get
Set
'Usage
Dim instance As SummaryLink
Dim value As Boolean
value = instance.IsGroupHeader
instance.IsGroupHeader = value
public bool IsGroupHeader { get; set; }
Property Value
Type: System.Boolean
A flag that determines whether or not this SummaryLink is a group header.
Remarks
A group header link that represents a grouping for other links. It does not have a link URL property.
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;
Note
This code example is part of a larger code example in the SummaryLink topic.