Click here to Skip to main content
12,404,895 members (69,749 online)
Click here to Skip to main content
Add your own
alternative version

Stats

172.8K views
853 downloads
55 bookmarked
Posted

Navigation Custom Control for Microsoft Office SharePoint Server (MOSS)

, 13 May 2010 CPOL
Rate this:
Please Sign up or sign in to vote.
Renders navigational nodes using list tags

Introduction

For use in Microsoft Office SharePoint Server (MOSS) 2007, this web control is an alternative to the out-of-the-box "Current Navigation" a.k.a. AspMenu. It renders navigational nodes using list tags, like:

Description

The web control uses a PortalSiteMapProvider to render a vertical navigation. Unlike the out-of-the-box AspMenu, it does not emit table tags, but list tags customizable using CSS classes. The navigation expands the root nodes and sibling nodes to the current node and its parent nodes. A node can be a sub-site or a page.

It has several public properties:

  • SiteMapProvider - A site map provider of type PortalSiteMapProvider. Default is CurrentNavSiteMapProvider.
  • StartNodeKey - Server relative URL for a starting sub-site. For example: /PressReleases/2006. Default is the root site.
  • IncludeSubSites - Include sub-sites? Allowed values are True, False, or PerWeb. Default is PerWeb, i.e., a per sub-site setting, configurable in the Modify Navigation Site Actions menu.
  • IncludePages - Include pages? Allowed values are True, False, or PerWeb. Default is PerWeb, i.e., a per sub-site setting, configurable in the Modify Navigation Site Actions menu.
  • IncludeHeadings - Include headings? Allowed values are True, False.
  • IncludeAuthoredLinks - Include authored links? Allowed values are True, False.
  • MaxLevels - Maximum number of node levels. Default is 0, i.e., no limit.
  • CompactMode - If set to True, the navigation expands the root nodes and all parent nodes to the current node. In the example below, nodes Child1, Child2, and Child3 are the root nodes:
  • Child1
    Child2
        Child21
            Child211 (Current Node)
                Child2111
    Child3
    

    If set to False, sibling nodes to the current node and its parent nodes will also be shown. For example:

    Child1
    Child2
        Child21
            Child211 (Current Node)
                Child2111
            Child212
        Child22
        Child23
    Child3
    

    Default is False.

  • ListCssClass - CSS class name for the outermost <ul> tag.
  • NodeCssClass - CSS class name for regular hyperlinked nodes.
  • CurrentNodeCssClass - CSS class name for a selected node.
  • CurrentNodeParentCssClass - CSS class name for the lowest level node under which there is a selected node.
  • NoUrlNodeCssClass - CSS class name for nodes with no URL, like headings.

The control also uses a resource file to store all messages and property attribute UI strings. It demonstrates how to develop a custom class that inherits CategoryAttribute or DescriptionAttribute and returns a localized string from your own Resource Manager.

The sample Visual Studio 2008 solution includes all the support files you need to build and deploy this web control, minus strong name key files (*.snk). It contains two projects: Deployment and SharePoint.Publishing. The SharePoint.Publishing project contains source codes for the web control. The Deployment project contains a Solution directory where a WSP file is generated and deployed by a post-build script.

Notes

The web control does not fully support site hierarchy containing navigational "headings" because they cannot be clicked to open up child nodes. The navigation will, however, show parent headings if one of the child nodes is a current node.

Installation

Using stsadm, install solution file QuestechNavigation.wsp in \Deployments\Solution\:

stsadm -o addsolution -filename QuestechNavigation.wsp

Go to SharePoint Central Administration/Operations/Global Configuration-Solution Management. Deploy the installed solution to the selected web applications. To insert the web control to a publishing page, modify the appropriate master page or page layout as follows:

...
<%@ Register Tagprefix="QuestechPublishingWebControls"
    Namespace="QuestechSystems.SharePoint.Publishing.WebControls"
    Assembly="QuestechSystems.SharePoint.Publishing.Navigation, Version=1.0.0.0, 
              Culture=neutral, PublicKeyToken=57d955ce9c425b79" %>
...
...
<QuestechPublishingWebControls:Navigation CompactMode="False" runat="server" />
...

History

  • V1.4 - 2010.05.12
    • Removed empty ul tags for expandable nodes that are not expanded
  • V1.3 - 2009.05.22
    • Converted Visual Studio solution projects to version 2008
    • New SharePoint Solution QuestechNavigation.wsp and assembly QuestechSystems.SharePoint.Publishing.Navigation.dll. This allows my other sample solutions in CodeProject to co-exist with this web control.
    • Renamed class from VerticalNavigation to Navigation
  • V1.2 - 2008.04.21
    • Added new property CompactMode
    • Included sample Visual Studio 2005 solution for compiling and deploying the web control
    • Updated installation instructions
  • V1.1 - 2007.09.18
    • Added new properties SiteMapProvider, IncludeSubSites, and IncludePages
    • Added rendering of sibling nodes if current node is a page or a sub-site with default page only
    • Added resource file for property attribute UI strings and error messages
  • V1.0 - 2006.12.07 - Base

License

This article, along with any associated source code and files, is licensed under The Code Project Open License (CPOL)

Share

About the Author

Stephen Huen
Software Developer (Senior)
Canada Canada
A Microsoft Certified Professional Developer and Technology Specialist.

Experience and expertise in SharePoint 2013 / 2010 / 2007.

Role ranges from a developer in a multi-person team to a solution consultant with expert-level skills, leading a project to completion status.

Proven experience working effectively in a team environment and a self-managed environment.

You may also be interested in...

Comments and Discussions

 
SuggestionShow All Children Nodes from anywhere Pin
Member 1039661426-Feb-14 6:02
memberMember 1039661426-Feb-14 6:02 
GeneralMy vote of 5 Pin
vchatakondu7-May-12 7:28
membervchatakondu7-May-12 7:28 
GeneralSharePoint Server 2010 version ... Pin
Stephen Huen27-Jul-10 12:36
memberStephen Huen27-Jul-10 12:36 
Questionhow to eliminate empty ULs Pin
Andreas Boehmer1-Oct-09 14:31
memberAndreas Boehmer1-Oct-09 14:31 
GeneralHaving difficulty using Pin
vynsane2-Sep-09 8:40
membervynsane2-Sep-09 8:40 
GeneralHi Pin
Chinmoyee12-May-09 23:10
memberChinmoyee12-May-09 23:10 
QuestionHow to get current navigation for the startnodekey Pin
nareshveeragoni26-Mar-09 10:36
membernareshveeragoni26-Mar-09 10:36 
QuestionRe: How to get current navigation for the startnodekey Pin
Andreas Boehmer7-Sep-09 13:26
memberAndreas Boehmer7-Sep-09 13:26 
AnswerRe: How to get current navigation for the startnodekey Pin
Andreas Boehmer1-Oct-09 15:00
memberAndreas Boehmer1-Oct-09 15:00 
Questionchange the top level site node background to tabbed clors Pin
nareshveeragoni26-Mar-09 10:17
membernareshveeragoni26-Mar-09 10:17 

General General    News News    Suggestion Suggestion    Question Question    Bug Bug    Answer Answer    Joke Joke    Praise Praise    Rant Rant    Admin Admin   

Use Ctrl+Left/Right to switch messages, Ctrl+Up/Down to switch threads, Ctrl+Shift+Left/Right to switch pages.

| Advertise | Privacy | Terms of Use | Mobile
Web02 | 2.8.160721.1 | Last Updated 13 May 2010
Article Copyright 2006 by Stephen Huen
Everything else Copyright © CodeProject, 1999-2016
Layout: fixed | fluid