Menu-Klasse
Aktualisiert: November 2007
Zeigt ein Menü auf einer ASP.NET-Webseite an.
Assembly: System.Web (in System.Web.dll)
[ControlValuePropertyAttribute("SelectedValue")] [AspNetHostingPermissionAttribute(SecurityAction.LinkDemand, Level = AspNetHostingPermissionLevel.Minimal)] [AspNetHostingPermissionAttribute(SecurityAction.InheritanceDemand, Level = AspNetHostingPermissionLevel.Minimal)] public class Menu : HierarchicalDataBoundControl, IPostBackEventHandler, INamingContainer
/** @attribute ControlValuePropertyAttribute("SelectedValue") */
/** @attribute AspNetHostingPermissionAttribute(SecurityAction.LinkDemand, Level = AspNetHostingPermissionLevel.Minimal) */
/** @attribute AspNetHostingPermissionAttribute(SecurityAction.InheritanceDemand, Level = AspNetHostingPermissionLevel.Minimal) */
public class Menu extends HierarchicalDataBoundControl implements IPostBackEventHandler,
INamingContainer
public class Menu extends HierarchicalDataBoundControl implements IPostBackEventHandler, INamingContainer
<asp:Menu />
Das Menu-Steuerelement wird verwendet, um ein Menü auf einer ASP.NET-Webseite anzuzeigen, und zwar häufig in Kombination mit einem SiteMapDataSource-Steuerelement zum Navigieren in einer Website. Das Menu-Steuerelement unterstützt die folgenden Features:
Datenbindung, die den Menüelementen des Steuerelements eine Bindung an hierarchische Datenquellen ermöglicht.
Sitenavigation durch eine Integration des SiteMapDataSource-Steuerelements.
Programmgesteuerter Zugriff auf das Menu-Objektmodell, um Menüs dynamisch zu erstellen, Menüelemente zu füllen, Eigenschaften festzulegen usw.
Benutzerdefinierbare Darstellung durch Designs, benutzerdefinierte Bilder, Formate und benutzerdefinierte Vorlagen.
Wenn der Benutzer auf ein Menüelement klickt, kann mit dem Menu-Steuerelement entweder zu einer verknüpften Webseite navigiert werden oder es erfolgt ein Postback an den Server. Wenn die NavigateUrl-Eigenschaft eines Menüelements festgelegt wurde, navigiert das Menu-Steuerelement zu der verknüpften Seite. Andernfalls sendet es die Seite zur Verarbeitung an den Server zurück. Standardmäßig wird eine verknüpfte Seite im gleichen Fenster oder Frame wie das Menu-Steuerelement angezeigt. Um die verknüpften Inhalte in einem anderen Fenster oder Frame anzuzeigen, verwenden Sie die Target-Eigenschaft des Menu-Steuerelements.
 Hinweis: |
|---|
Die Target-Eigenschaft hat Auswirkungen auf alle Menüelemente im Steuerelement. Um für ein einzelnes Menüelement ein Fenster oder einen Frame anzugeben, legen Sie die Target-Eigenschaft des MenuItem-Objekts direkt fest. |
Das Menu-Steuerelement zeigt zwei Menütypen an: ein statisches und ein dynamisches Menü. Das statische Menü wird immer in einem Menu-Steuerelement angezeigt. Standardmäßig werden die Menüelemente der Stammebene (Ebene 0) im statischen Menü angezeigt. Sie können zusätzliche Menüebenen (statische Untermenüs) innerhalb des statischen Menüs anzeigen, indem Sie die StaticDisplayLevels-Eigenschaft festlegen. Menüelemente, die sich ggf. auf höherer Ebene als der von der StaticDisplayLevels-Eigenschaft angegebene Wert befinden, werden in einem dynamischen Menü angezeigt. Ein dynamisches Menü wird nur angezeigt, wenn der Benutzer den Mauszeiger auf dem übergeordneten Menüelement positioniert, das ein dynamisches Untermenü enthält. Dynamische Menüs werden nach einer bestimmten Zeitspanne automatisch ausgeblendet. Mit der DisappearAfter-Eigenschaft können Sie die Zeitspanne angeben.
| Hinweis: |
|---|
Ein dynamisches Menü wird ebenfalls ausgeblendet, wenn der Benutzer auf Bereiche außerhalb des Menüs klickt. |
Sie können die Anzahl der Ebenen einschränken, die in einem dynamischen Menü angezeigt werden, indem Sie die MaximumDynamicDisplayLevels-Eigenschaft festlegen. Menüebenen, die diesen angegebenen Wert übersteigen, werden verworfen.
| Hinweis: |
|---|
Das Menu-Steuerelement ist nicht für die Verwendung in einem UpdatePanel-Steuerelement vorgesehen. Sie können das Menu-Steuerelement nur einer Seite außerhalb eines UpdatePanel-Steuerelements hinzufügen. UpdatePanel-Steuerelemente werden nicht zum Aktualisieren der gesamten Seite mittels Postback, sondern zum Aktualisieren ausgewählter Bereiche einer Seite verwendet. Weitere Informationen finden Sie unter Übersicht über das UpdatePanel-Steuerelement und Übersicht über das Teilrendering von Seiten. |
Menüelemente
Ein Menu-Steuerelement besteht aus einer Struktur von Menüelementen, die von MenuItem-Objekten dargestellt werden. Menüelemente auf der obersten Ebene (Ebene 0) werden als Stammmenüelemente bezeichnet. Ein Menüelement, das ein übergeordnetes Menüelement besitzt, wird als untergeordnetes Menüelement bezeichnet. Alle Stammmenüelemente werden in der Items-Auflistung gespeichert. Untergeordnete Menüelemente werden in der ChildItems-Auflistung eines übergeordneten Menüelements gespeichert.
Jedes Menüelement verfügt über eine Text-Eigenschaft und eine Value-Eigenschaft. Der Wert der Text-Eigenschaft wird im Menu-Steuerelement angezeigt. Die Value-Eigenschaft wird hingegen verwendet, um zusätzliche Daten zum Menüelement zu speichern (z. B. Daten, die an das dem Menüelement zugeordnete Postbackereignis übergeben werden). Wenn auf ein Menüelement geklickt wird, kann dieses zu einer anderen Website navigieren, die von der NavigateUrl-Eigenschaft angegeben wird.
| Hinweis: |
|---|
Wenn die NavigateUrl-Eigenschaft für ein Menüelement nicht festgelegt wurde, übermittelt das Menu-Steuerelement beim Klicken auf das Menüelement nur die Seite zur Verarbeitung an den Server. |
Optional können Sie auch ein Bild in einem Menüelement anzeigen, indem Sie die ImageUrl-Eigenschaft festlegen.
Weitere Informationen zu Menüelementen finden Sie unter MenuItem.
Statische Daten
Statische Menüelemente bilden das einfachste Datenmodell des Menu-Steuerelements. Um statische Menüelemente mithilfe deklarativer Syntax anzuzeigen, müssen zunächst die öffnenden und schließenden <Items>-Tags zwischen den öffnenden und schließenden Tags des Menu-Steuerelements geschachtelt werden. Danach erstellen Sie die Menüstruktur, indem Sie die <asp:MenuItem>-Elemente zwischen den öffnenden und schließenden <Items>-Tags schachteln. Jedes <asp:MenuItem>-Element stellt ein Menüelement im Steuerelement dar und ist einem MenuItem-Objekt zugeordnet. Sie können die Eigenschaften jedes einzelnen Menüelements festlegen, indem Sie die Attribute seines <asp:MenuItem>-Elements festlegen. Zum Erstellen von Untermenüelementen werden zusätzliche <asp:MenuItem>-Elemente zwischen den öffnenden und schließenden <asp:MenuItem>-Tags des übergeordneten Menüelements geschachtelt.
Binden an Daten
Das Menu-Steuerelement kann auch an Daten gebunden werden. Um das Menu-Steuerelement an den entsprechenden Datenquellentyp zu binden, können Sie eine der beiden folgenden Methoden verwenden:
Das Menu-Steuerelement kann jedes hierarchische Datenquellen-Steuerelement verwenden, z. B. ein XmlDataSource-Steuerelement oder ein SiteMapDataSource-Steuerelement. Für die Bindung an ein hierarchisches Datenquellen-Steuerelement legen Sie die DataSourceID-Eigenschaft des Menu-Steuerelements auf den ID-Wert des Datenquellen-Steuerelements fest. Das Menu-Steuerelement wird automatisch an das angegebene Datenquellen-Steuerelement gebunden. Dies ist die bevorzugte Methode für die Bindung an Daten.
Das Menu-Steuerelement kann auch an ein XmlDocument-Objekt gebunden werden. Zum Binden an diese Datenquelle legen Sie die DataSource-Eigenschaft des Menu-Steuerelements auf die Datenquelle fest. Rufen Sie anschließend die DataBind-Methode auf.
Beim Binden an eine Datenquelle, in der jedes Datenelement mehrere Eigenschaften enthält (z. B. ein XML-Element mit mehreren Attributen), wird der von der ToString-Methode des Datenelements zurückgegebene Wert standardmäßig von einem Menüelement angezeigt. Im Falle eines XML-Elements zeigt das Menüelement den Elementnamen an, der zwar die zugrunde liegende Struktur der Menüstruktur angibt, aber ansonsten wenig Informationen enthält. Sie können ein Menüelement an eine bestimmte Datenelementeigenschaft binden, indem Sie die DataBindings-Auflistung verwenden, um Menüelementbindungen anzugeben. Die DataBindings-Auflistung enthält MenuItemBinding-Objekte, die die Beziehung zwischen einem Datenelement und dem Menüelement, an das es gebunden werden soll, definieren. Sie können die Kriterien für die Bindung und die im Knoten anzuzeigende Datenelementeigenschaft angeben. Weitere Informationen zu Menüelementbindungen finden Sie unter MenuItemBinding.
Sie können durch Festlegen der Text-Eigenschaft oder der TextField-Eigenschaft auf eine leere Zeichenfolge ("") keine leeren Knoten in einem Menu-Steuerelement erstellen. Wenn diese Eigenschaften auf eine leere Zeichenfolge festgelegt werden, hat dies dieselbe Auswirkung, als wenn die Eigenschaften nicht festgelegt werden. In diesem Fall erstellt das Menu-Steuerelement mithilfe der DataSource-Eigenschaft eine Standardbindung. Weitere Informationen finden Sie unter Binden an Datenbanken.
Anpassen der Benutzeroberfläche
Es gibt viele Möglichkeiten, die Darstellung des Menu-Steuerelements benutzerdefiniert anzupassen. Zuerst können Sie durch Festlegen der Orientation-Eigenschaft angeben, ob das Menu-Steuerelement horizontal oder vertikal wiedergegeben werden soll. Außerdem können Sie jeweils andere Formate (z. B. Schriftgrad und Farbe) für die einzelnen Menüelementtypen angeben.
Wenn Sie Cascading Stylesheets (CSS) verwenden, um die Darstellung des Steuerelements anzupassen, sollten Sie Inlineformate oder eine separate CSS-Datei verwenden, aber nicht beides. Die Verwendung von Inlineformaten und einer separaten CSS-Datei kann zu unerwarteten Ergebnissen führen. Weitere Informationen über die Verwendung von Stylesheets mit Steuerelementen finden Sie unter ASP.NET-Webserversteuerelemente und CSS-Formatvorlagen.
In der folgenden Tabelle sind die verfügbaren Menüelementformate aufgelistet.
Formateigenschaft des Menüelements | Beschreibung |
|---|---|
Die Formateinstellungen für ein dynamisches Menüelement, wenn der Mauszeiger darauf positioniert wird. | |
Die Formateinstellungen für ein einzelnes dynamisches Menüelement. | |
Die Formateinstellungen für ein dynamisches Menü. | |
Die Formateinstellungen für das derzeit ausgewählte dynamische Menüelement. | |
Die Formateinstellungen für ein statisches Menüelement, wenn der Mauszeiger darauf positioniert wird. | |
Die Formateinstellungen für ein einzelnes statisches Menüelement. | |
Die Formateinstellungen für ein statisches Menü. | |
Die Formateinstellungen für das derzeit ausgewählte statische Menüelement. |
Anstatt die einzelnen Formateigenschaften festzulegen, können Sie auch Formate angeben, die entsprechend der Ebene des Menüelements auf dieses angewendet werden. Verwenden Sie dazu folgende Formatauflistungen.
Ebenenformatauflistungen | Beschreibung |
|---|---|
Eine Auflistung von MenuItemStyle-Objekten, die das Format der Menüelemente auf Grundlage der entsprechenden Ebene steuern. | |
Eine Auflistung von MenuItemStyle-Objekten, die das Format von ausgewählten Menüelementen auf Grundlage der entsprechenden Ebene steuern. | |
Eine Auflistung von MenuItemStyle-Objekten, die das Format der Untermenüelemente auf Grundlage der Ebene steuern. |
Das erste Format in der Auflistung stimmt mit dem Format der Menüelemente auf der ersten untergeordneten Ebene in der Menüstruktur überein. Das zweite Format in der Auflistung stimmt mit dem Format der Menüelemente auf der zweiten untergeordneten Ebene in der Menüstruktur überein. Auf diese Weise werden sehr häufig Navigationsmenüs in Form eines Inhaltsverzeichnisses generiert. Dabei weisen die Menüelemente einer bestimmten Ebene jeweils die gleiche Darstellung auf, unabhängig davon, ob sie über Untermenüs verfügen.
| Hinweis: |
|---|
Wenn Sie eine der in der vorigen Tabelle aufgelisteten Formatauflistungen verwenden, um das Format für das Menu-Steuerelement zu definieren, überschreiben diese Formateinstellungen die individuellen Formateigenschaften des Menüelements. |
Eine andere Möglichkeit zum Ändern der Darstellung des Steuerelements ist das benutzerdefinierte Anpassen der im Menu-Steuerelement angezeigten Bilder. Sie können ein eigenes, benutzerdefiniertes Bild für die verschiedenen Teile des Steuerelements angeben, indem Sie die in der folgenden Tabelle angegebenen Eigenschaften festlegen.
Bildeigenschaft | Beschreibung |
|---|---|
Ein optionales Bild, das am unteren Rand eines dynamischen Menüelements angezeigt wird, um dieses von anderen Menüelementen abzugrenzen. | |
Ein optionales Bild, das in einem dynamischen Menüelement angezeigt wird und angibt, dass dieses über ein Untermenü verfügt. | |
Ein optionales Bild, das am oberen Rand eines dynamischen Menüelements angezeigt wird, um dieses von anderen Menüelementen abzugrenzen. | |
Das Bild, das am unteren Rand eines Menüelements angezeigt wird und angibt, dass der Benutzer zum Anzeigen zusätzlicher Menüelemente einen Bildlauf nach unten durchführen kann. | |
Das Bild, das am oberen Rand eines Menüelements angezeigt wird und angibt, dass der Benutzer zum Anzeigen zusätzlicher Menüelemente einen Bildlauf nach oben durchführen kann. | |
Ein optionales Bild, das am unteren Rand eines statischen Menüelements angezeigt wird, um dieses von anderen Menüelementen abzugrenzen. | |
Ein optionales Bild, das in einem statischen Menüelement angezeigt wird und angibt, dass dieses über ein Untermenü verfügt. | |
Ein optionales Bild, das am oberen Rand eines statischen Menüelements angezeigt wird, um dieses von anderen Menüelementen abzugrenzen. |
Für eine vollständige Steuerung der Benutzeroberfläche (User Interface, UI) können Sie mithilfe der folgenden Vorlageneigenschaften eigene, benutzerdefinierte Vorlagen für das Menu-Steuerelement definieren.
Vorlageneigenschaft | Beschreibung |
|---|---|
Die Vorlage, die benutzerdefinierte Inhalte enthält, die in einem dynamischen Menüelement wiedergegeben werden sollen. | |
Die Vorlage, die benutzerdefinierte Inhalte enthält, die in einem statischen Menüelement wiedergegeben werden sollen. |
Sie können sowohl die vertikale als auch die horizontale Position eines dynamischen Menüs relativ zu seinem übergeordneten Menüelement steuern, indem Sie die DynamicVerticalOffset-Eigenschaft bzw. die DynamicHorizontalOffset-Eigenschaft festlegen. Um den Einzug der statischen Untermenüelemente in einem statischen Menü zu steuern, verwenden Sie die StaticSubMenuIndent-Eigenschaft.
Ereignisse
Das Menu-Steuerelement stellt mehrere Ereignisse bereit, die Sie für die Programmierung verwenden können. Dadurch können Sie bei jedem Auftreten eines Ereignisses eine benutzerdefinierte Routine ausführen. In der folgenden Tabelle sind die unterstützten Ereignisse aufgelistet.
Ereignis | Beschreibung |
|---|---|
Tritt ein, wenn auf ein Menüelement geklickt wird. Dieses Ereignis wird häufig verwendet, um ein Menu-Steuerelement mit einem anderen Steuerelement auf der Seite zu synchronisieren. | |
Tritt ein, wenn ein Menüelement an Daten gebunden wird. Dieses Ereignis wird häufig verwendet, um ein Menüelement zu ändern, bevor es in einem Menu-Steuerelement wiedergegeben wird. |
Eingabehilfen
Das für dieses Steuerelement standardmäßig wiedergegebene Markup entspricht eventuell nicht den Standards für die Eingabehilfen wie beispielsweise den Richtlinien der Web Content Accessibility Guidelines 1.0 (WCAG) mit der Priorität 1. Details über die Unterstützung von Eingabehilfen für dieses Steuerelement finden Sie unter Steuerelemente und Eingabehilfen von ASP.NET.
Die von dem Menu-Steuerelement bereitgestellte SkipLinkText-Eigenschaft ermöglicht, dass das gesamte Steuerelement von Bildschirmsprachausgaben übersprungen werden kann. Wenn die SkipLinkText-Eigenschaft festgelegt ist, wird ein unsichtbares Bild mit alternativem Text wiedergegeben. Benutzer haben dadurch die Möglichkeit, an das Ende des Steuerelements zu springen. Bildschirmsprachausgaben lesen den alternativen Text vor. Das Bild hingegen nimmt nur 1 Pixel Platz ein. Für die pixelgenaue Steuerung der Wiedergabe einer Seite legen Sie die SkipLinkText-Eigenschaft auf eine leere Zeichenfolge ("") fest. Stellen Sie außerdem Ihren eigenen Mechanismus zum Überspringen des Menüs bereit. Die SkipLinkText-Eigenschaft ist standardmäßig auf die leere Zeichenfolge festgelegt.
Im folgenden Codebeispiel wird veranschaulicht, wie ein Menu-Steuerelement unter Verwendung deklarativer Syntax mit statischen Menüelementen erstellt wird.
<%@ Page Language="C#" %> <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml" > <!-- For the hover styles of the Menu control to --> <!-- work correctly, you must include this head --> <!-- element. --> <head runat="server"> <title>Menu Declarative Example</title> </head> <body> <form id="form1" runat="server"> <h3>Menu Declarative Example</h3> <!-- Use declarative syntax to create the --> <!-- menu structure. Submenu items are --> <!-- created by nesting them in parent menu --> <!-- items. --> <asp:menu id="NavigationMenu" disappearafter="2000" staticdisplaylevels="2" staticsubmenuindent="10" orientation="Vertical" font-names="Arial" target="_blank" runat="server"> <staticmenuitemstyle backcolor="LightSteelBlue" forecolor="Black"/> <statichoverstyle backcolor="LightSkyBlue"/> <dynamicmenuitemstyle backcolor="Black" forecolor="Silver"/> <dynamichoverstyle backcolor="LightSkyBlue" forecolor="Black"/> <items> <asp:menuitem navigateurl="Home.aspx" text="Home" tooltip="Home"> <asp:menuitem navigateurl="Music.aspx" text="Music" tooltip="Music"> <asp:menuitem navigateurl="Classical.aspx" text="Classical" tooltip="Classical"/> <asp:menuitem navigateurl="Rock.aspx" text="Rock" tooltip="Rock"/> <asp:menuitem navigateurl="Jazz.aspx" text="Jazz" tooltip="Jazz"/> </asp:menuitem> <asp:menuitem navigateurl="Movies.aspx" text="Movies" tooltip="Movies"> <asp:menuitem navigateurl="Action.aspx" text="Action" tooltip="Action"/> <asp:menuitem navigateurl="Drama.aspx" text="Drama" tooltip="Drama"/> <asp:menuitem navigateurl="Musical.aspx" text="Musical" tooltip="Musical"/> </asp:menuitem> </asp:menuitem> </items> </asp:menu> </form> </body> </html>
Im folgenden Codebeispiel wird veranschaulicht, wie das Menu-Steuerelement an ein SiteMapDataSource-Steuerelement gebunden wird. Damit dieses Beispiel wie vorgesehen funktioniert, müssen Sie die nachfolgenden Beispiel-Siteübersichtsdaten in eine Datei mit dem Namen Web.sitemap kopieren.
<%@ Page Language="C#" %> <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml" > <!-- For the hover styles of the Menu control to --> <!-- work correctly, you must include this head --> <!-- element. --> <head runat="server"> <title>Menu DataBinding Example</title> </head> <body> <form id="form1" runat="server"> <h3>Menu DataBinding Example</h3> <!-- Bind the Menu control to a SiteMapDataSource control. --> <asp:menu id="NavigationMenu" disappearafter="2000" staticdisplaylevels="2" staticsubmenuindent="10" orientation="Vertical" font-names="Arial" target="_blank" datasourceid="MenuSource" runat="server"> <staticmenuitemstyle backcolor="LightSteelBlue" forecolor="Black"/> <statichoverstyle backcolor="LightSkyBlue"/> <dynamicmenuitemstyle backcolor="Black" forecolor="Silver"/> <dynamichoverstyle backcolor="LightSkyBlue" forecolor="Black"/> </asp:menu> <asp:SiteMapDataSource id="MenuSource" runat="server"/> </form> </body> </html>
Nachfolgend finden Sie ein Beispiel für die Siteübersichtsdaten für das vorherige Beispiel.
<siteMap>
<siteMapNode url="~\Home.aspx"
title="Home"
description="Home">
<siteMapNode url="~\Music.aspx"
title="Music"
description="Music">
<siteMapNode url="~\Classical.aspx"
title="Classical"
description="Classical"/>
<siteMapNode url="~\Rock.aspx"
title="Rock"
description="Rock"/>
<siteMapNode url="~\Jazz.aspx"
title="Jazz"
description="Jazz"/>
</siteMapNode>
<siteMapNode url="~\Movies.aspx"
title="Movies"
description="Movies">
<siteMapNode url="~\Action.aspx"
title="Action"
description="Action"/>
<siteMapNode url="~\Drama.aspx"
title="Drama"
description="Drama"/>
<siteMapNode url="~\Musical.aspx"
title="Musical"
description="Musical"/>
</siteMapNode>
</siteMapNode>
</siteMap>
- AspNetHostingPermission
für den Betrieb in einer Hostumgebung. Anforderungswert: LinkDemand; Berechtigungswert: Minimal.
- AspNetHostingPermission
für den Betrieb in einer Hostumgebung. Anforderungswert: InheritanceDemand; Berechtigungswert: Minimal.
Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98
.NET Framework und .NET Compact Framework unterstützen nicht alle Versionen sämtlicher Plattformen. Eine Liste der unterstützten Versionen finden Sie unter Systemanforderungen für .NET Framework.
Community-Beiträge
HINZUFÜGEN
Möchten Sie an der Umfrage teilnehmen?
