NavBar element (Site)

Article
06/29/2022

Applies to: SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013

Contains the definition of the navigation area for either the top links of all pages within a site or for the Quick Launch area of the home page.

<NavBar
  Body = "Text"
  ID = "Integer"
  Name = "Text"
  Prefix = "Text"
  Separator = "Text"
  Suffix = "Text"
  Url = "Text">
</NavBar>

Elements and attributes

The following sections describe attributes, child elements, and parent elements.

Attributes

Attribute	Description
Body	Required Text. Contains the body of the definition for the navigation bar.
ID	Required Integer. Specifies the ID of the navigation bar.
Name	Required Text. Contains the name of the navigation bar.
Prefix	Optional Text. Contains the opening tag for the table that contains the navigation bar.
Separator	Optional Text. Specifies the separator to use between items in the navigation bar.
Suffix	Optional Text. Contains the closing tag for the table that contains the navigation bar.
Url	Optional Text.

Child elements

Parent elements

NavBars

Occurrences

Minimum: 0
Maximum: Unbounded

Example

The following example defines the top navigation area of a home page.

<NavBar Name="SharePoint Top Navbar" Separator="&amp;nbsp;&amp;nbsp;&amp;nbsp;"
   Body="<a ID='onettopnavbar#LABEL_ID#' href='#URL#'
      accesskey='J'>#LABEL#</a>" ID="1002">
   <NavBarLink Name="Documents and Lists"
      Url="_layouts/[%=System.Threading.Thread.CurrentThread.
      CurrentUICulture.LCID%]/viewlsts.aspx" />
   <NavBarLink Name="Create"
      Url="_layouts/[%=System.Threading.Thread.CurrentThread.
         CurrentUICulture.LCID%]/create.aspx" />
   <NavBarLink Name="Site Settings"
      Url="_layouts/[%=System.Threading.Thread.CurrentThread.
         CurrentUICulture.LCID%]/settings.aspx" />
   <NavBarLink Name="Help"
      Url="javascript:HelpWindowKey("helphome")" />
</NavBar>

Share via