Navigationssteuerelemente

Artikel
09/24/2014

Letzte Änderung: Montag, 1. November 2010

Gilt für: SharePoint Foundation 2010

Inhalt dieses Artikels
Breadcrumb-Leiste
Leiste für häufig verwendete Hyperlinks
Schnellstart
Strukturansicht

Das Chrom für eine Microsoft SharePoint Foundation-Website schließt eine Reihe von Steuerelementen ein, die Benutzern bei der Navigation auf der Website unterstützen sollen, um wichtige Inhalte einfacher zu finden, ihre aktuelle Position auf der Website zu kennen und rasch die Navigation zu einer früheren Position zurückverfolgen zu können.

Das Markup für diese Steuerelemente finden Sie auf der Gestaltungsvorlage der Homepage der Website. In SharePoint Foundation 2010 ist v4.master die primäre Gestaltungsvorlage sowohl für Inhalts- als auch Anwendungsseiten.

Hinweis
Weitere Informationen zu Standardgestaltungsvorlagen finden Sie unter Standardgestaltungsvorlagen in SharePoint Foundation.

Die vier wichtigsten Navigationshilfen sind in v4.master definiert:

Breadcrumb-Leiste
Leiste für häufig verwendete Hyperlinks
Schnellstartleiste
Strukturansicht

Die Breadcrumb-Leiste ist ein Navigationselement, das am Anfang von Inhaltsseiten in einer SharePoint Foundation-Website auf dem Menüband direkt rechts neben Websiteaktionen angezeigt wird. Sie ist durch ein Symbol gekennzeichnet, das wie ein Ordner mit einem darüber gelegten Pfeil nach oben aussieht. Wenn Sie mit der Maus auf das Symbol zeigen, wird die QuickInfo "Navigation nach oben" angezeigt. Wenn Sie auf das Symbol klicken, wird ein Popupmenü angezeigt. In diesem Menü wird Ihre aktuelle Position in der Websitehierarchie angezeigt. Durch Klicken auf einen der Links vor Ihrer aktuellen Position wird diese Position geöffnet; Sie können so rasch zu Ihrem Ausgangspunkt gelangen.

In v4.master wird die Breadcrumb-Leiste durch das folgende Markup definiert:

Hinweis
Zum einfacheren Lesen des Markups wurden die Ressourcenausdrücke ("$Resources:wss,resource_id") durch ihre lokalisierten Zeichenfolgenwerte ersetzt.

<asp:contentplaceholder id="PlaceHolderGlobalNavigation" runat="server">
    <SharePoint:PopoutMenu
        runat="server"
        ID="GlobalBreadCrumbNavPopout"
        IconUrl="/_layouts/images/fgimg.png"
        IconAlt="Navigate Up"
        IconOffsetX=0
        IconOffsetY=112
        IconWidth=16
        IconHeight=16
        AnchorCss="s4-breadcrumb-anchor"
        AnchorOpenCss="s4-breadcrumb-anchor-open"
        MenuCss="s4-breadcrumb-menu">
        <div class="s4-breadcrumb-top">
            <asp:Label 
                runat="server" 
                CssClass="s4-breadcrumb-header" 
                Text="This page location is:" />
        </div>
        <asp:ContentPlaceHolder id="PlaceHolderTitleBreadcrumb" runat="server">
            <SharePoint:ListSiteMapPath
                runat="server"
                SiteMapProviders="SPSiteMapProvider,SPContentMapProvider"
                RenderCurrentNodeAsLink="false"
                PathSeparator=""
                CssClass="s4-breadcrumb"
                NodeStyle-CssClass="s4-breadcrumbNode"
                CurrentNodeStyle-CssClass="s4-breadcrumbCurrentNode"
                RootNodeStyle-CssClass="s4-breadcrumbRootNode"
                NodeImageOffsetX=0
                NodeImageOffsetY=353
                NodeImageWidth=16
                NodeImageHeight=16
                NodeImageUrl="/_layouts/images/fgimg.png"
                RTLNodeImageOffsetX=0
                RTLNodeImageOffsetY=376
                RTLNodeImageWidth=16
                RTLNodeImageHeight=16
                RTLNodeImageUrl="/_layouts/images/fgimg.png"
                HideInteriorRootNodes="true"
                SkipLinkText="" />
            </asp:ContentPlaceHolder>
    </SharePoint:PopoutMenu>
    <div class="s4-die">
        <asp:ContentPlaceHolder id="PlaceHolderGlobalNavigationSiteMap" runat="server" Visible="false">
        </asp:ContentPlaceHolder>
    </div>
</asp:contentplaceholder>

Auffällig bei diesem Markup ist, dass die gesamte Breadcrumb-Leiste in ein ContentPlaceHolder-Steuerelement eingeschlossen ist (ID="PlaceHolderGlobalNavigation"). Das bedeutet, dass Sie die Option haben, eine Inhaltsseite zu erstellen und ein Content-Steuerelement hinzuzufügen, durch das das in der Gestaltungsvorlage definierte Standardverhalten außer Kraft gesetzt wird.

Der Großteil des Markups hängt mit der Definition des Popupmenüs zusammen. Wie aus dem Markup erkennbar ist, wird das Menü von einem PopoutMenu-Steuerelement gerendert. Dieses Steuerelement enthält ein Label-Steuerelement für die Kopfzeile des Menüs und ein ListSiteMapPath-Steuerelement für die Hyperlinks, die Benutzern die Navigation auf der Website ermöglichen. Das ListSiteMapPath-Steuerelement ist in einem anderen ContentPlaceholder-Steuerelement geschachtelt (ID="PlaceHolderTitleBreadcrumb"), sodass es ebenfalls in einer Inhaltsseite außer Kraft gesetzt werden kann.

Das ListSiteMapPath-Steuerelement erhält seine Navigationsdaten von einem Anbieterpaar, SPSiteMapProvider und SPContentMapProvider. Der erste Anbieter stellt Daten zu Websites in der Websitehierarchie bereit, während der zweite Daten zu Websiteinhalten wie Listen, Bibliotheken, Ordner und Websiteseiten bereitstellt. Beide Navigationsanbieter werden von der SiteMapProvider-Klasse abgeleitet, der Quelle für Siteübersichtsdaten auf ASP.NET-Standardwebsites.

Hinweis
Navigationsanbieter sind im <system.web>-Abschnitt der Datei web.config im Stammverzeichnis der Webanwendung unter dem Pfad Laufwerk:\inetpub\wwwroot\wss\VirtualDirectories\Portnummer\web.config deklariert.

Leiste für häufig verwendete Hyperlinks

Die Leiste für häufig verwendete Hyperlinks ist eine Leiste mit Registerkarten direkt unterhalb des Titels und der Beschreibung der Website. Der erste Link der Leiste für häufig verwendete Hyperlinks ist die Position "Homepage". Häufig zeigt dieser Link auf die Website, auf der die Leiste definiert ist, und die verbleibenden Links zeigen auf Websites, die sich in der Websitehierarchie weiter unten befinden. Dieser Standard wird jedoch nicht erzwungen. Es kann jede gültige URL für einen Link verwendet und die Links in beliebiger Reihenfolge angeordnet werden.

Eine Unterwebsite kann die Leiste für häufig verwendete Hyperlinks von der übergeordneten Website erben. In diesem Fall sorgt die Leiste für häufig verwendete Hyperlinks auf mehreren Websites für ein konsistentes Navigationserlebnis. Weitere Informationen finden Sie unter Gewusst wie: Freigeben der Leiste für häufig verwendete Hyperlinks zwischen Websites.

In v4.master wird die Leiste für häufig verwendete Hyperlinks durch das folgende Markup definiert:

<asp:ContentPlaceHolder id="PlaceHolderHorizontalNav" runat="server">
    <SharePoint:AspMenu
      ID="TopNavigationMenuV4"
      Runat="server"
      EnableViewState="false"
      DataSourceID="topSiteMap"
      AccessKey="1"
      UseSimpleRendering="true"
      UseSeparateCss="false"
      Orientation="Horizontal"
      StaticDisplayLevels="2"
      MaximumDynamicDisplayLevels="1"
      SkipLinkText=""
      CssClass="s4-tn"/>
    <SharePoint:DelegateControl 
        runat="server" 
        ControlId="TopNavigationDataSource" 
        Id="topNavigationDelegate">
        <Template_Controls>
            <asp:SiteMapDataSource
              ShowStartingNode="False"
              SiteMapProvider="SPNavigationProvider"
              id="topSiteMap"
              runat="server"
              StartingNodeUrl="sid:1002"/>
        </Template_Controls>
    </SharePoint:DelegateControl>
</asp:ContentPlaceHolder>

Wie das Markup für die Breadcrumb-Leiste ist das Markup, das die Leiste für häufig verwendete Hyperlinks definiert, in ein ContentPlaceHolder-Steuerelement eingeschlossen, das Entwicklern von Inhaltsseiten die Option gibt, Standardinhalte durch eigene Inhalte zu überschreiben.

Die Leiste für häufig verwendete Hyperlinks wird durch ein AspMenu-Steuerelement gerendert. Das Menü wird horizontal gerendert; diese Richtung wird durch das Markup für das Steuerelement durch Festlegen der Orientation-Eigenschaft auf "Horizontal" festgelegt. Die Einstellung für die StaticDisplayLevels-Eigenschaft ist "2". Normalerweise bedeutet diese Einstellung, dass ein Knoten im Menü, der über einen untergeordneten Knoten verfügt, eine Zeile unterhalb des übergeordneten Knotens angezeigt wird. In der Praxis werden untergeordnete Knoten jedoch rechts neben dem übergeordneten Knoten, auf derselben Ebene, angezeigt. Dies hängt mit der CSS-Klasse (Cascading Stylesheet) zusammen, die durch die Einstellung der CssClass-Eigenschaft an das Menü angefügt ist. Damit die Menüelemente einfacher mithilfe von CSS gesteuert werden können, wird die UseSimpleRendering-Eigenschaft durch das Markup des Steuerelements auf "true" festgelegt.

Wenn die Menüstruktur über zwei Ebenen hinausgeht, werden die Elemente auf der dritten Ebene in einem Flyoutmenü angezeigt; dies wird durch die Einstellung der MaximumDynamicDisplayLevels-Eigenschaft gesteuert. Da diese Einstellung "1" ist, zeigen Flyoutmenüs nur eine Ebene unterhalb der beiden Ebenen an, die im statischen Menü angezeigt werden. Alle weiteren Ebenen werden verworfen.

Die Datenquelle hinter dem Menü ist ein SiteMapDataSource-Steuerelement. Wie aus dem Markup erkennbar ist, bindet die SiteMapProvider-Eigenschaft das Datenquellen-Steuerelement an eine Instanz der SPNavigationProvider-Klasse, die von der SiteMapProvider-Klasse abgeleitet wird.

Beachten Sie, dass der Wert der ShowStartingNode-Eigenschaft False ist. Dies hängt mit der Tatsache zusammen, dass der tatsächliche Startknoten der Stamm der Knotenstruktur ist, die die Leiste für häufig verwendete Hyperlinks bildet; er dient als interne Funktion und soll nicht auf der Seite angezeigt werden. Der Wert der StartingNodeUrl-Eigenschaft ("sid:1002") ist keine richtige URL, sondern ein Ausdruck, der auf die SharePoint-ID für den Stammknoten der Leiste für häufig verwendet Hyperlinks zeigt.

Sie können den Stammknoten mithilfe der folgenden Codezeile abrufen:

SPNavigationNode toplinkbar = web.Navigation.GetNodeById(1002);

Dim toplinkbar as SPNavigationNode = web.Navigation.GetNodeById(1002)

Wenn Sie dieses Objekt untersuchen, werden Sie feststellen, dass seine Title-Eigenschaft "SharePoint-Navigationsleiste oben" und seine Url-Eigenschaft "/" zurückgibt.

Tipp
Sie erhalten vergleichbare Ergebnisse, wenn Sie v4.master in SharePoint Designer 2010 öffnen und den Wert von ShowStartingNode zu True ändern. Wenn Sie die Änderung speichern und die Homepage in Ihrem Browser anzeigen, sollte der erste Knoten der Leiste für häufig verwendete Hyperlinks den Text SharePoint-Navigationsleiste oben anzeigen.

Das SPNavigationNode-Objekt, das den Stamm der Knotenstruktur der Leiste für häufig verwendete Hyperlinks darstellt, weist eine Children-Eigenschaft auf, die eine Auflistung von SPNavigationNode-Objekten zurückgibt. Die Objekte in dieser Auflistung stellen die sichtbaren Knoten auf der Leiste der häufig verwendeten Hyperlinks dar. Die Auflistung ist aufzählbar, sodass Sie einfach die Einträge durchlaufen können, wie in der folgenden kurzen Konsolenanwendung dargestellt:

using System;
using Microsoft.SharePoint;
using Microsoft.SharePoint.Navigation;

namespace ConsoleApp
{
    class Program
    {
        static void Main(string[] args)
        {
            using (SPSite site = new SPSite("https://localhost"))
            {
                using (SPWeb web = site.OpenWeb())
                {
                    SPNavigationNode toplinkbar = web.Navigation.GetNodeById(1002);
                    if (toplinkbar != null)
                    {
                        foreach (SPNavigationNode node in toplinkbar.Children)
                        {
                            Console.Write("| {0} ", node.Title);
                        }
                        Console.WriteLine("|");
                    }
                }
            }
            Console.Write("\nPress ENTER to continue....");
            Console.ReadLine();
        }
    }
}

Imports System
Imports Microsoft.SharePoint
Imports Microsoft.SharePoint.Navigation

Module ConsoleApp

    Sub Main()

        Using site As New SPSite("https://localhost")

            Using web As SPWeb = site.OpenWeb()

                Dim toplinkbar As SPNavigationNode = web.Navigation.GetNodeById(1002)

                If toplinkbar IsNot Nothing Then

                    For Each node As SPNavigationNode In toplinkbar.Children
                        Console.Write("| {0} ", node.Title)
                    Next
                    Console.WriteLine("|")

                End If

            End Using

        End Using

        Console.Write(vbCrLf & "Press ENTER to continue....")
        Console.Read()
    End Sub

End Module

Schnellstart

Die Schnellstartleiste ist ein Menü bestehend aus Hyperlinks, das auf der linken Seite von Seiten auf einer Website angezeigt werden kann. Das Menü dient der Navigation auf einer Website und weist in der Regel Lnks zu Listen und Dokumentbibliotheken sowie sonstigen Websiteinhalten auf. Es kann auch über Links zu externen Inhalten verfügen.

Websitebesitzer können die Schnellstartleiste ein- oder ausblenden, indem sie auf die administrative Benutzeroberfläche im Menü Websiteaktionen zugreifen. Entwickler haben dieselbe Möglichkeit, indem sie Code schreiben. Weitere Informationen finden Sie unter Gewusst wie: Anzeigen oder Ausblenden der Schnellstartleiste.

In v4.master ist das Markup, das die Schnellstartleiste definiert, in einem ContentPlaceHolder-Steuerelement (ID="PlaceHolderLeftNavBar") geschachtelt, das auch Markup für das Steuerelement der Strukturansicht enthält. Folglich haben Seitendesigner die Option, beide Navigationssteuerelemente durch eigene Inhalte zu ersetzen. Die Inhaltsseiten, die bestimmten integrierten Webvorlagen zugeordnet sind, ersetzen andere Inhalte - die Vorlage Besprechungsarbeitsbereich ist ein Beispiel hierfür.

Das Markup für die Schnellstartleiste definiert zwei Versionen, jeweils in einem UIVersionedContent-Steuerelement. Beim einen UIVersionedContent-Steuerelement ist der Wert des UIVersion-Attributs "3", während er beim anderen "4" ist. Welche Version auf der Seite gerendert wird, hängt davon ab, ob Websitesammlungsadministratoren die neuere Benutzeroberfläche auf Websites in der Auflistung angewendet haben. Weitere Informationen finden Sie unter Visuelles Upgrade.

Hinweis
Sie können die Versionsnummer der Benutzeroberfläche programmseitig abfragen, indem Sie auf die SPWeb.UIVersion-Eigenschaft zugreifen.

Version 4 der Schnellstartleiste wird durch das folgende Markup definiert:

<SharePoint:AspMenu 
    id="V4QuickLaunchMenu" 
    runat="server" 
    EnableViewState="false" 
    DataSourceId="QuickLaunchSiteMap" 
    UseSimpleRendering="true" 
    UseSeparateCss="false" 
    Orientation="Vertical" 
    StaticDisplayLevels="2" 
    MaximumDynamicDisplayLevels="0" 
    SkipLinkText="" 
    CssClass="s4-ql" />

Die Schnellstartleiste wird als eine Folge von Überschriften angezeigt, denen eine oder mehrere Ebenen mit Menüelementen untergeordnet sind. Die Anzahl der tatsächlich auf der Seite gerenderten Menüebenen hängt von der Konfiguration des AspMenu-Steuerelements ab, das das Menü rendert.

Im vorigen Beispiel ist "2" der Wert der StaticDisplayLevels-Eigenschaft; das bedeutet, dass zwei Menüebenen angezeigt werden: eine Überschrift plus eine Ebene unter der Überschrift. Zusätzliche Ebenen können in einem dynamischen Flyoutmenü angezeigt werden. Die Anzahl der angezeigten Ebenen des Flyoutmenüs hängt von der Einstellung der MaximumDynamicDisplayLevels-Eigenschaft ab. In diesem Fall ist der Eigenschaftswert "0", somit sind Flyoutmenüs deaktiviert. Wenn die Schnellstartleiste also mehr als zwei Ebenen aufweist, werden diese nicht angezeigt.

Die DataSourceID-Eigenschaft im Markup für das AspMenu-Steuerelement zeigt auf ein SiteMapDataSource-Steuerelement, das durch das folgende Markup konfiguriert wird:

<asp:SiteMapDataSource 
    SiteMapProvider="SPNavigationProvider" 
    ShowStartingNode="False" 
    id="QuickLaunchSiteMap" 
    StartingNodeUrl="sid:1025" 
    runat="server" />

Wie bei der Datenquelle der Leiste für häufig verwendete Hyperlinks ist die ShowStartingNode-Eigenschaft der Datenquelle für die Schnellstartleiste auf False festgelegt. Der Stammknoten verfügt über Informationen über die Schnellstartleiste und ist nicht zur Anzeige vorgesehen. Alle anderen Knoten (Links) im Menü sind untergeordnete Elemente dieses Knotens. Der Wert der StartingNodeUrl-Eigenschaft ("sid:10252") gibt die SharePoint-ID für den Stammknoten der Schnellstartleiste an.

Sie können den Stammknoten mithilfe der folgenden Codezeile abrufen:

SPNavigationNode quicklaunch = web.Navigation.GetNodeById(1025);

Dim quicklaunch as SPNavigationNode = web.Navigation.GetNodeById(1025)

Wenn Sie dieses Objekt untersuchen, werden Sie feststellen, dass seine Title-Eigenschaft "Schnellstart" und seine Url-Eigenschaft "/" zurückgibt.

Das SPNavigationNode-Objekt des Stamms der Knotenstruktur verfügt über eine Children-Eigenschaft, die eine Auflistung von SPNavigationNode-Objekten zurückgibt, die die erste Ebene der Menüelemente, die Überschriften, darstellt. Jede Überschrift kann wiederum untergeordnete Knoten aufweisen, die die zweite Ebene der Menüelemente darstellen. Knoten auf der zweiten Ebene können ebenfalls untergeordnete Knoten haben und die Struktur abwärts fortsetzen usw.

In der folgenden Konsolenanwendung wird veranschaulicht, wie die Schnellstartleiste abwärts durchlaufen und die Elemente aufgelistet werden können. Die Anwendung druckt den Anzeigetext für jede Überschrift in der Schnellstartleiste und ruft dann eine rekursive Methode auf, um den Anzeigetext für alle Menüebenen unterhalb jeder Überschrift zu drucken.

using System;
using Microsoft.SharePoint;
using Microsoft.SharePoint.Navigation;

namespace ConsoleApp
{
    class Program
    {
        static void Main(string[] args)
        {
            using (SPSite site = new SPSite("https://localhost"))
            {
                using (SPWeb web = site.OpenWeb())
                {
                    SPNavigationNode quicklaunch = web.Navigation.GetNodeById(1025);
                    if (quicklaunch != null)
                    {
                        foreach (SPNavigationNode heading in quicklaunch.Children)
                        {
                            PrintNode(heading);
                            Console.WriteLine(new String('-', 10));
                        }
                    }
                }
            }
            Console.Write("\nPress ENTER to continue....");
            Console.ReadLine();
        }

        static void PrintNode(SPNavigationNode node)
        {
            Console.WriteLine(node.Title);
            foreach (SPNavigationNode item in node.Children)
                 PrintNode(item);
        }
    }
}

Imports System
Imports Microsoft.SharePoint
Imports Microsoft.SharePoint.Navigation

Module ConsoleApp

    Sub Main()

        Using site As New SPSite("https://localhost")

            Using web As SPWeb = site.OpenWeb()

                Dim quicklaunch As SPNavigationNode = web.Navigation.GetNodeById(1025)

                If quicklaunch IsNot Nothing Then

                    For Each heading As SPNavigationNode In quicklaunch.Children

                        PrintNode(heading)
                        Console.WriteLine(New String("-", 10))

                    Next

                End If

            End Using

        End Using

        Console.Write(vbCrLf & "Press ENTER to continue....")
        Console.Read()
    End Sub

    Sub PrintNode(ByRef node As SPNavigationNode)

        Console.WriteLine(node.Title)
        For Each item As SPNavigationNode In node.Children
            PrintNode(item)
        Next

    End Sub

End Module

Strukturansicht

Die Strukturansicht ist ein Navigationselement mit dem Zweck, eine hierarchische Ansicht aller Websiteinhalte anzuzeigen. Die Strukturansicht ist standardmäßig deaktiviert. Wenn sie aktiviert wird, wird sie im linken Navigationsbereich der Seite angezeigt. Wenn Schnellstart aktiviert ist, wird die Strukturansicht darunter angezeigt.

Ein Administrator der Website kann die Strukturansicht aktivieren, indem er auf der administrativen Benutzeroberfläche zur Seite Tree View wechselt. Zum Anzeigen der Seite Strukturansicht klicken Sie auf Websiteaktionen und dann auf Websiteeinstellungen. Klicken Sie unter Aussehen und Verhalten auf Strukturansicht.

Sie können die Strukturansicht im Code aktivieren, indem Sie die SPWeb.TreeViewEnabled-Eigenschaft auf true festlegen.

Wie Schnellstart verfügt die Strukturansicht über zwei Versionen. In v4.master werden beide Versionen von einem SPTreeView-Steuerelement gerendert, das in einem SPRememberScroll-Steuerelement geschachtelt ist. Das SPTreeView-Steuerelement erhält seine Daten von einer Instanz der SPHierarchyDataSourceControl-Klasse.

In v4.master wird die Version 4 der Strukturansicht durch das folgende Markup definiert:

<SharePoint:DelegateControl runat="server" ControlId="TreeViewAndDataSource">
  <Template_Controls>
    <SharePoint:SPHierarchyDataSourceControl 
        runat="server" 
        id="TreeViewDataSourceV4" 
        RootContextObject="Web" 
        IncludeDiscussionFolders="true" />
    <SharePoint:SPRememberScroll 
        runat="server" 
        id="TreeViewRememberScrollV4" 
        onscroll="javascript:_spRecordScrollPositions(this);" 
        style="overflow: auto;height: 400px;width: 155px; ">
        <SharePoint:SPTreeView 
            id="WebTreeViewV4" 
            runat="server" 
            ShowLines="false" 
            DataSourceId="TreeViewDataSourceV4" 
            ExpandDepth="0" 
            SelectedNodeStyle-CssClass="ms-tvselected" 
            NodeStyle-CssClass="ms-navitem" 
            SkipLinkText="" 
            NodeIndent="12" 
            ExpandImageUrl="/_layouts/images/tvclosed.png" 
            ExpandImageUrlRtl="/_layouts/images/tvclosedrtl.png" 
            CollapseImageUrl="/_layouts/images/tvopen.png" 
            CollapseImageUrlRtl="/_layouts/images/tvopenrtl.png" 
            NoExpandImageUrl="/_layouts/images/tvblank.gif">
        </SharePoint:SPTreeView>
    </SharePoint:SPRememberScroll>
  </Template_Controls>
</SharePoint:DelegateControl>

Die Datenquelle für das Steuerelement der Strukturansicht ist ein SPHierarchyDataSourceControl-Objekt, und die RootContextObject-Eigenschaft des Objekts ist auf "Web" festgelegt. Dadurch wird der Kontext für den Stamm der Struktur festgelegt. Folglich rendert die Strukturansicht Links zu allen Unterwebsites der aktuellen Website, gefolgt von Dokumentbibliotheken und Listen.