SiteMapPath Class
.NET Framework 4
Displays a set of text or image hyperlinks that enable users to more easily navigate a Web site, while taking a minimal amount of page space.
System.Object
System.Web.UI.Control
System.Web.UI.WebControls.WebControl
System.Web.UI.WebControls.CompositeControl
System.Web.UI.WebControls.SiteMapPath
System.Web.UI.Control
System.Web.UI.WebControls.WebControl
System.Web.UI.WebControls.CompositeControl
System.Web.UI.WebControls.SiteMapPath
Assembly: System.Web (in System.Web.dll)
The SiteMapPath type exposes the following members.
| Name | Description | |
|---|---|---|
|
AccessKey | Gets or sets the access key that allows you to quickly navigate to the Web server control. (Inherited from WebControl.) |
|
Adapter | Gets the browser-specific adapter for the control. (Inherited from Control.) |
|
|
AppRelativeTemplateSourceDirectory | Gets or sets the application-relative virtual directory of the Page or UserControl object that contains this control. (Inherited from Control.) |
|
|
Attributes | Gets the collection of arbitrary attributes (for rendering only) that do not correspond to properties on the control. (Inherited from WebControl.) |
|
|
BackColor | Gets or sets the background color of the Web server control. (Inherited from WebControl.) |
|
|
BindingContainer | Infrastructure. Gets the control that contains this control's data binding. (Inherited from Control.) |
|
|
BorderColor | Gets or sets the border color of the Web control. (Inherited from WebControl.) |
|
|
BorderStyle | Gets or sets the border style of the Web server control. (Inherited from WebControl.) |
|
|
BorderWidth | Gets or sets the border width of the Web server control. (Inherited from WebControl.) |
|
|
ChildControlsCreated | Gets a value that indicates whether the server control's child controls have been created. (Inherited from Control.) |
|
|
ClientID | Gets the control ID for HTML markup that is generated by ASP.NET. (Inherited from Control.) |
|
|
ClientIDMode | Gets or sets the algorithm that is used to generate the value of the ClientID property. (Inherited from Control.) |
|
|
ClientIDSeparator | Gets a character value representing the separator character used in the ClientID property. (Inherited from Control.) |
|
|
Context | Gets the HttpContext object associated with the server control for the current Web request. (Inherited from Control.) |
|
|
Controls | Gets a ControlCollection object that represents the child controls in a CompositeControl. (Inherited from CompositeControl.) |
|
|
ControlStyle | Gets the style of the Web server control. This property is used primarily by control developers. (Inherited from WebControl.) |
|
|
ControlStyleCreated | Gets a value indicating whether a Style object has been created for the ControlStyle property. This property is primarily used by control developers. (Inherited from WebControl.) |
|
|
CssClass | Gets or sets the Cascading Style Sheet (CSS) class rendered by the Web server control on the client. (Inherited from WebControl.) |
|
|
CurrentNodeStyle | Gets the style used for the display text for the current node. |
|
|
CurrentNodeTemplate | Gets or sets a control template to use for the node of a site navigation path that represents the currently displayed page. |
|
|
DataItemContainer | Gets a reference to the naming container if the naming container implements IDataItemContainer. (Inherited from Control.) |
|
|
DataKeysContainer | Gets a reference to the naming container if the naming container implements IDataKeysControl. (Inherited from Control.) |
|
|
DesignMode | Gets a value indicating whether a control is being used on a design surface. (Inherited from Control.) |
|
|
Enabled | Gets or sets a value indicating whether the Web server control is enabled. (Inherited from WebControl.) |
|
|
EnableTheming | Gets or sets a value indicating whether themes apply to this control. (Inherited from WebControl.) |
|
|
EnableViewState | Gets or sets a value indicating whether the server control persists its view state, and the view state of any child controls it contains, to the requesting client. (Inherited from Control.) |
|
|
Events | Gets a list of event handler delegates for the control. This property is read-only. (Inherited from Control.) |
|
|
Font | Gets the font properties associated with the Web server control. (Inherited from WebControl.) |
|
|
ForeColor | Gets or sets the foreground color (typically the color of the text) of the Web server control. (Inherited from WebControl.) |
|
|
HasAttributes | Gets a value indicating whether the control has attributes set. (Inherited from WebControl.) |
|
|
HasChildViewState | Gets a value indicating whether the current server control's child controls have any saved view-state settings. (Inherited from Control.) |
|
|
Height | Gets or sets the height of the Web server control. (Inherited from WebControl.) |
|
|
ID | Gets or sets the programmatic identifier assigned to the server control. (Inherited from Control.) |
|
|
IdSeparator | Infrastructure. Gets the character used to separate control identifiers. (Inherited from Control.) |
|
|
IsChildControlStateCleared | Gets a value indicating whether controls contained within this control have control state. (Inherited from Control.) |
|
|
IsEnabled | Gets a value indicating whether the control is enabled. (Inherited from WebControl.) |
|
|
IsTrackingViewState | Gets a value that indicates whether the server control is saving changes to its view state. (Inherited from Control.) |
|
|
IsViewStateEnabled | Gets a value indicating whether view state is enabled for this control. (Inherited from Control.) |
|
|
LoadViewStateByID | Gets a value indicating whether the control participates in loading its view state by ID instead of index. (Inherited from Control.) |
|
|
NamingContainer | Gets a reference to the server control's naming container, which creates a unique namespace for differentiating between server controls with the same Control.ID property value. (Inherited from Control.) |
|
|
NodeStyle | Gets the style used for the display text for all nodes in the site navigation path. |
|
|
NodeTemplate | Gets or sets a control template to use for all functional nodes of a site navigation path. |
|
|
Page | Gets a reference to the Page instance that contains the server control. (Inherited from Control.) |
|
|
Parent | Gets a reference to the server control's parent control in the page control hierarchy. (Inherited from Control.) |
|
|
ParentLevelsDisplayed | Gets or sets the number of levels of parent nodes the control displays, relative to the currently displayed node. |
|
|
PathDirection | Gets or sets the order that the navigation path nodes are rendered in. |
|
|
PathSeparator | Gets or sets the string that delimits SiteMapPath nodes in the rendered navigation path. |
|
|
PathSeparatorStyle | Gets the style used for the PathSeparator string. |
|
|
PathSeparatorTemplate | Gets or sets a control template to use for the path delimiter of a site navigation path. |
|
|
Provider | Gets or sets a SiteMapProvider that is associated with the Web server control. |
|
|
RenderCurrentNodeAsLink | Indicates whether the site navigation node that represents the currently displayed page is rendered as a hyperlink. |
|
|
RenderingCompatibility | Gets a value that specifies the ASP.NET version that rendered HTML will be compatible with. (Inherited from Control.) |
|
|
RootNodeStyle | Gets the style for the root node display text. |
|
|
RootNodeTemplate | Gets or sets a control template to use for the root node of a site navigation path. |
|
|
ShowToolTips | Gets or sets a value indicating whether the SiteMapPath control writes an additional hyperlink attribute for hyperlinked navigation nodes. Depending on client support, when a mouse hovers over a hyperlink that has the additional attribute set, a ToolTip is displayed. |
|
|
Site | Gets information about the container that hosts the current control when rendered on a design surface. (Inherited from Control.) |
|
|
SiteMapProvider | Gets or sets the name of the SiteMapProvider used to render the site navigation control. |
|
|
SkinID | Gets or sets the skin to apply to the control. (Inherited from WebControl.) |
|
|
SkipLinkText | Gets or sets a value that is used to render alternate text for screen readers to skip the control's content. |
|
|
Style | Gets a collection of text attributes that will be rendered as a style attribute on the outer tag of the Web server control. (Inherited from WebControl.) |
|
|
SupportsDisabledAttribute | Gets a value that indicates whether the control should set the disabled attribute of the rendered HTML element to "disabled" when the control's IsEnabled property is false. (Inherited from CompositeControl.) |
|
|
TabIndex | Gets or sets the tab index of the Web server control. (Inherited from WebControl.) |
|
|
TagKey | Gets the HtmlTextWriterTag value that corresponds to this Web server control. This property is used primarily by control developers. (Inherited from WebControl.) |
|
|
TagName | Gets the name of the control tag. This property is used primarily by control developers. (Inherited from WebControl.) |
|
|
TemplateControl | Gets or sets a reference to the template that contains this control. (Inherited from Control.) |
|
|
TemplateSourceDirectory | Gets the virtual directory of the Page or UserControl that contains the current server control. (Inherited from Control.) |
|
|
ToolTip | Gets or sets the text displayed when the mouse pointer hovers over the Web server control. (Inherited from WebControl.) |
|
|
UniqueID | Gets the unique, hierarchically qualified identifier for the server control. (Inherited from Control.) |
|
|
ViewState | Gets a dictionary of state information that allows you to save and restore the view state of a server control across multiple requests for the same page. (Inherited from Control.) |
|
|
ViewStateIgnoresCase | Gets a value that indicates whether the StateBag object is case-insensitive. (Inherited from Control.) |
|
|
ViewStateMode | Gets or sets the view-state mode of this control. (Inherited from Control.) |
|
|
Visible | Gets or sets a value that indicates whether a server control is rendered as UI on the page. (Inherited from Control.) |
|
|
Width | Gets or sets the width of the Web server control. (Inherited from WebControl.) |
| Name | Description | |
|---|---|---|
|
AddAttributesToRender | Adds HTML attributes and styles that need to be rendered to the specified HtmlTextWriterTag. This method is used primarily by control developers. (Inherited from WebControl.) |
|
|
AddedControl | Called after a child control is added to the Controls collection of the Control object. (Inherited from Control.) |
|
|
AddParsedSubObject | Notifies the server control that an element, either XML or HTML, was parsed, and adds the element to the server control's ControlCollection object. (Inherited from Control.) |
|
ApplyStyle | Copies any nonblank elements of the specified style to the Web control, overwriting any existing style elements of the control. This method is primarily used by control developers. (Inherited from WebControl.) |
|
|
ApplyStyleSheetSkin | Applies the style properties defined in the page style sheet to the control. (Inherited from Control.) |
|
|
BuildProfileTree | Infrastructure. Gathers information about the server control and delivers it to the Trace property to be displayed when tracing is enabled for the page. (Inherited from Control.) |
|
|
ClearCachedClientID | Infrastructure. Sets the cached ClientID value to null. (Inherited from Control.) |
|
|
ClearChildControlState | Deletes the control-state information for the server control's child controls. (Inherited from Control.) |
|
|
ClearChildState | Deletes the view-state and control-state information for all the server control's child controls. (Inherited from Control.) |
|
|
ClearChildViewState | Deletes the view-state information for all the server control's child controls. (Inherited from Control.) |
|
|
ClearEffectiveClientIDMode | Infrastructure. Sets the ClientIDMode property of the current control instance and of any child controls to Inherit. (Inherited from Control.) |
|
|
CopyBaseAttributes | Copies the properties not encapsulated by the Style object from the specified Web server control to the Web server control that this method is called from. This method is used primarily by control developers. (Inherited from WebControl.) |
|
|
CreateChildControls | Infrastructure. Clears the current child controls collection, and rebuilds it by calling the CreateControlHierarchy method. (Overrides Control.CreateChildControls().) |
|
|
CreateControlCollection | Creates a new ControlCollection object to hold the child controls (both literal and server) of the server control. (Inherited from Control.) |
|
|
CreateControlHierarchy | Examines the site map structure provided by the SiteMapProvider and builds a child controls collection based on the styles and templates defined for the functional nodes. |
|
|
CreateControlStyle | Creates the style object that is used internally by the WebControl class to implement all style related properties. This method is used primarily by control developers. (Inherited from WebControl.) |
|
|
DataBind() | Infrastructure. Binds a data source to the SiteMapPath control and its child controls. (Overrides CompositeControl.DataBind().) |
|
|
DataBind(Boolean) | Binds a data source to the invoked server control and all its child controls with an option to raise the DataBinding event. (Inherited from Control.) |
|
|
DataBindChildren | Binds a data source to the server control's child controls. (Inherited from Control.) |
|
|
Dispose | Enables a server control to perform final clean up before it is released from memory. (Inherited from Control.) |
|
|
EnsureChildControls | Determines whether the server control contains child controls. If it does not, it creates child controls. (Inherited from Control.) |
|
|
EnsureID | Creates an identifier for controls that do not have an identifier assigned. (Inherited from Control.) |
|
|
Equals(Object) | Determines whether the specified Object is equal to the current Object. (Inherited from Object.) |
|
|
Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
|
|
FindControl(String) | Searches the current naming container for a server control with the specified id parameter. (Inherited from Control.) |
|
|
FindControl(String, Int32) | Infrastructure. Searches the current naming container for a server control with the specified id and an integer, specified in the pathOffset parameter, which aids in the search. You should not override this version of the FindControl method. (Inherited from Control.) |
|
|
Focus | Sets input focus to a control. (Inherited from Control.) |
|
|
GetDesignModeState | Infrastructure. Gets design-time data for a control. (Inherited from Control.) |
|
|
GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) |
|
|
GetRouteUrl(Object) | Gets the URL that corresponds to a set of route parameters. (Inherited from Control.) |
|
|
GetRouteUrl(RouteValueDictionary) | Gets the URL that corresponds to a set of route parameters. (Inherited from Control.) |
|
|
GetRouteUrl(String, Object) | Gets the URL that corresponds to a set of route parameters and a route name. (Inherited from Control.) |
|
|
GetRouteUrl(String, RouteValueDictionary) | Gets the URL that corresponds to a set of route parameters and a route name. (Inherited from Control.) |
|
|
GetType | Gets the Type of the current instance. (Inherited from Object.) |
|
|
GetUniqueIDRelativeTo | Returns the prefixed portion of the UniqueID property of the specified control. (Inherited from Control.) |
|
|
HasControls | Determines if the server control contains any child controls. (Inherited from Control.) |
|
|
HasEvents | Returns a value indicating whether events are registered for the control or any child controls. (Inherited from Control.) |
|
|
InitializeItem | Populates a SiteMapNodeItem, which is a Web server control that represents a SiteMapNode, with a set of child controls based on the node's function and the specified templates and styles for the node. |
|
|
IsLiteralContent | Infrastructure. Determines if the server control holds only literal content. (Inherited from Control.) |
|
|
LoadControlState | Restores control-state information from a previous page request that was saved by the SaveControlState method. (Inherited from Control.) |
|
|
LoadViewState | Restores view-state information from a previous request that was saved with the SaveViewState method. (Overrides WebControl.LoadViewState(Object).) |
|
|
MapPathSecure | Retrieves the physical path that a virtual path, either absolute or relative, maps to. (Inherited from Control.) |
|
|
MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
|
|
MergeStyle | Copies any nonblank elements of the specified style to the Web control, but will not overwrite any existing style elements of the control. This method is used primarily by control developers. (Inherited from WebControl.) |
|
|
OnBubbleEvent | Determines whether the event for the server control is passed up the page's UI server control hierarchy. (Inherited from Control.) |
|
|
OnDataBinding | Infrastructure. Overrides the OnDataBinding method of the CompositeControl class and raises the DataBinding event. (Overrides Control.OnDataBinding(EventArgs).) |
|
|
OnInit | Raises the Init event. (Inherited from Control.) |
|
|
OnItemCreated | Raises the ItemCreated event of the SiteMapPath control. |
|
|
OnItemDataBound | Raises the ItemDataBound event of the SiteMapPath control. |
|
|
OnLoad | Raises the Load event. (Inherited from Control.) |
|
|
OnPreRender | Raises the PreRender event. (Inherited from Control.) |
|
|
OnUnload | Raises the Unload event. (Inherited from Control.) |
|
|
OpenFile | Gets a Stream used to read a file. (Inherited from Control.) |
|
|
RaiseBubbleEvent | Assigns any sources of the event and its information to the control's parent. (Inherited from Control.) |
|
|
RecreateChildControls | Recreates the child controls in a control derived from CompositeControl. (Inherited from CompositeControl.) |
|
|
RemovedControl | Called after a child control is removed from the Controls collection of the Control object. (Inherited from Control.) |
|
|
Render | Writes the CompositeControl content to the specified HtmlTextWriter object, for display on the client. (Overrides CompositeControl.Render(HtmlTextWriter).) |
|
|
RenderBeginTag | Renders the HTML opening tag of the control to the specified writer. This method is used primarily by control developers. (Inherited from WebControl.) |
|
|
RenderChildren | Outputs the content of a server control's children to a provided HtmlTextWriter object, which writes the content to be rendered on the client. (Inherited from Control.) |
|
|
RenderContents | Renders the nodes in the SiteMapPath control. (Overrides WebControl.RenderContents(HtmlTextWriter).) |
|
|
RenderControl(HtmlTextWriter) | Outputs server control content to a provided HtmlTextWriter object and stores tracing information about the control if tracing is enabled. (Inherited from Control.) |
|
|
RenderControl(HtmlTextWriter, ControlAdapter) | Outputs server control content to a provided HtmlTextWriter object using a provided ControlAdapter object. (Inherited from Control.) |
|
|
RenderEndTag | Renders the HTML closing tag of the control into the specified writer. This method is used primarily by control developers. (Inherited from WebControl.) |
|
|
ResolveAdapter | Gets the control adapter responsible for rendering the specified control. (Inherited from Control.) |
|
|
ResolveClientUrl | Gets a URL that can be used by the browser. (Inherited from Control.) |
|
|
ResolveUrl | Converts a URL into one that is usable on the requesting client. (Inherited from Control.) |
|
|
SaveControlState | Saves any server control state changes that have occurred since the time the page was posted back to the server. (Inherited from Control.) |
|
|
SaveViewState | Infrastructure. Saves changes to view state for the SiteMapPath control. (Overrides WebControl.SaveViewState().) |
|
|
SetDesignModeState | Sets design-time data for a control. (Inherited from Control.) |
|
|
SetRenderMethodDelegate | Infrastructure. Assigns an event handler delegate to render the server control and its content into its parent control. (Inherited from Control.) |
|
|
ToString | Returns a string that represents the current object. (Inherited from Object.) |
|
|
TrackViewState | Infrastructure. Tracks changes to the SiteMapPath control's view state. (Overrides WebControl.TrackViewState().) |
| Name | Description | |
|---|---|---|
|
DataBinding | Occurs when the server control binds to a data source. (Inherited from Control.) |
|
|
Disposed | Occurs when a server control is released from memory, which is the last stage of the server control lifecycle when an ASP.NET page is requested. (Inherited from Control.) |
|
|
Init | Occurs when the server control is initialized, which is the first step in its lifecycle. (Inherited from Control.) |
|
|
ItemCreated | Occurs when a SiteMapNodeItem is created by the SiteMapPath and is associated with its corresponding SiteMapNode. This event is raised by the OnItemCreated method. |
|
|
ItemDataBound | Infrastructure. Occurs after a SiteMapNodeItem has been bound to its underlying SiteMapNode data by the SiteMapPath. This event is raised by the OnItemDataBound method. |
|
|
Load | Occurs when the server control is loaded into the Page object. (Inherited from Control.) |
|
|
PreRender | Occurs after the Control object is loaded but prior to rendering. (Inherited from Control.) |
|
|
Unload | Occurs when the server control is unloaded from memory. (Inherited from Control.) |
| Name | Description | |
|---|---|---|
|
FindDataSourceControl | Returns the data source that is associated with the data control for the specified control. (Defined by DynamicDataExtensions.) |
|
|
FindFieldTemplate | Returns the field template for the specified column in the specified control's naming container. (Defined by DynamicDataExtensions.) |
|
|
FindMetaTable | Returns the metatable object for the containing data control. (Defined by DynamicDataExtensions.) |
| Name | Description | |
|---|---|---|
|
IAttributeAccessor.GetAttribute | Infrastructure. Gets an attribute of the Web control with the specified name. (Inherited from WebControl.) |
|
|
IAttributeAccessor.SetAttribute | Sets an attribute of the Web control to the specified name and value. (Inherited from WebControl.) |
|
|
ICompositeControlDesignerAccessor.RecreateChildControls | Enables a designer to recreate the composite control's collection of child controls in the design-time environment. (Inherited from CompositeControl.) |
|
IControlBuilderAccessor.ControlBuilder | For a description of this member, see IControlBuilderAccessor.ControlBuilder. (Inherited from Control.) |
|
|
IControlDesignerAccessor.GetDesignModeState | For a description of this member, see IControlDesignerAccessor.GetDesignModeState. (Inherited from Control.) |
|
|
IControlDesignerAccessor.SetDesignModeState | For a description of this member, see IControlDesignerAccessor.SetDesignModeState. (Inherited from Control.) |
|
|
IControlDesignerAccessor.SetOwnerControl | Infrastructure. For a description of this member, see IControlDesignerAccessor.SetOwnerControl. (Inherited from Control.) |
|
|
IControlDesignerAccessor.UserData | For a description of this member, see IControlDesignerAccessor.UserData. (Inherited from Control.) |
|
|
IDataBindingsAccessor.DataBindings | For a description of this member, see IDataBindingsAccessor.DataBindings. (Inherited from Control.) |
|
|
IDataBindingsAccessor.HasDataBindings | For a description of this member, see IDataBindingsAccessor.HasDataBindings. (Inherited from Control.) |
|
|
IExpressionsAccessor.Expressions | For a description of this member, see IExpressionsAccessor.Expressions. (Inherited from Control.) |
|
|
IExpressionsAccessor.HasExpressions | For a description of this member, see IExpressionsAccessor.HasExpressions. (Inherited from Control.) |
|
|
IParserAccessor.AddParsedSubObject | For a description of this member, see IParserAccessor.AddParsedSubObject. (Inherited from Control.) |
In this topic:
Introduction
The SiteMapPath control is a site navigation control that reflects data provided by the SiteMap object. It provides a space-saving way to easily navigate a site and serves as a point of reference for where the currently displayed page is within a site. This type of control is commonly called a breadcrumb, or eyebrow, because it displays a hierarchical path of hyperlinked page names that provides an escape up the hierarchy of pages from the current location. SiteMapDataSource. The SiteMapPath is useful for sites that have deep hierarchical page structures, but where a TreeView or Menu might require too much space on a page.
The SiteMapPath control works directly with your Web site's site map data. If you use it on a page that is not represented in your site map, it will not be displayed. For more information about site maps, see ASP.NET Site Navigation.
Nodes
The SiteMapPath is made up of nodes. Each element in the path is called a node and is represented by a SiteMapNodeItem object. The node that anchors the path and represents the base of the hierarchical tree is called the root node. The node that represents the currently displayed page is the current node. Any other node between the current node and root node is a parent node. The following table describes the three different node types.
|
Node type |
Description |
|---|---|
|
root |
A node that anchors a hierarchical set of nodes. |
|
parent |
A node that has one or more child nodes, but is not the current node. |
|
current |
A node that represents the currently displayed page. |
Node Appearance
Each node displayed by a SiteMapPath is a HyperLink or Literal control that you can apply a template or style to. The templates and styles are applied to nodes according to two rules of precedence:
-
If a template is defined for a node, it overrides any style defined for the node.
-
Templates and styles that are specific to types of nodes override general templates and styles defined for all nodes.
The NodeStyle and NodeTemplate properties are applied to all nodes, regardless of their node type. If both these properties are defined, the NodeTemplate takes precedence.
The CurrentNodeTemplate and CurrentNodeStyle properties are applied to nodes that represent the currently displayed page. If a NodeTemplate is defined in addition to the CurrentNodeTemplate, it is ignored. If a NodeStyle is defined in addition to the CurrentNodeStyle, it is merged with the CurrentNodeStyle to create a merged style. This merged style uses all the elements of the CurrentNodeStyle, plus any additional elements of the NodeStyle that do not conflict with the CurrentNodeStyle.
The RootNodeTemplate and RootNodeStyle properties are applied to the node that represents the root of the site navigation hierarchy. If a NodeTemplate is defined in addition to the RootNodeTemplate, it is ignored. If a NodeStyle is defined in addition to the RootNodeStyle, it is merged with the RootNodeStyle to create a merged style. This merged style uses all the elements of the RootNodeStyle, plus any additional elements of the NodeStyle that did not conflict with the CurrentNodeStyle. Finally, if the currently displayed page is the root page of the site, the RootNodeTemplate and RootNodeStyle are used instead of the CurrentNodeTemplate or CurrentNodeStyle.
The SiteMapPath control uses the site map provider identified by the SiteMapProvider property as its data source for site navigation information. If no provider is specified, it uses the default provider for the site, identified in the SiteMap.Provider property. Typically, this is an instance of the default site map provider for ASP.NET, the XmlSiteMapProvider. If the SiteMapPath control is used within a site but no site map provider is configured, the control throws an HttpException exception.
Events
The SiteMapPath control also provides events that you can program against. This allows you to run a custom routine whenever an event occurs. The following table lists the events supported by the SiteMapPath control.
|
Event |
Description |
|---|---|
|
Occurs when the SiteMapPath control first creates a SiteMapNodeItem and associates it with a SiteMapNode. |
|
|
Occurs when a SiteMapNodeItem is bound to site map data contained by the SiteMapNode. |
Customizing the SiteMapPath Control
Classes that derive from SiteMapPath override the InitializeItem method to customize the SiteMapNodeItem controls contained by the navigation control. For complete control over the way SiteMapNodeItem objects are created and added to the SiteMapPath, derived classes override the CreateControlHierarchy method.
Accessibility
For information about how to configure this control so that it generates markup that conforms to accessibility standards, see Accessibility in Visual Studio and ASP.NET and ASP.NET Controls and Accessibility.
Declarative Syntax
<asp:SiteMapPath
AccessKey="string"
BackColor="color name|#dddddd"
BorderColor="color name|#dddddd"
BorderStyle="NotSet|None|Dotted|Dashed|Solid|Double|Groove|Ridge|
Inset|Outset"
BorderWidth="size"
CssClass="string"
Enabled="True|False"
EnableTheming="True|False"
EnableViewState="True|False"
Font-Bold="True|False"
Font-Italic="True|False"
Font-Names="string"
Font-Overline="True|False"
Font-Size="string|Smaller|Larger|XX-Small|X-Small|Small|Medium|
Large|X-Large|XX-Large"
Font-Strikeout="True|False"
Font-Underline="True|False"
ForeColor="color name|#dddddd"
Height="size"
ID="string"
OnDataBinding="DataBinding event handler"
OnDisposed="Disposed event handler"
OnInit="Init event handler"
OnItemCreated="ItemCreated event handler"
OnItemDataBound="ItemDataBound event handler"
OnLoad="Load event handler"
OnPreRender="PreRender event handler"
OnUnload="Unload event handler"
ParentLevelsDisplayed="integer"
PathDirection="RootToCurrent|CurrentToRoot"
PathSeparator="string"
RenderCurrentNodeAsLink="True|False"
runat="server"
ShowToolTips="True|False"
SiteMapProvider="string"
SkinID="string"
SkipLinkText="string"
Style="string"
TabIndex="integer"
ToolTip="string"
Visible="True|False"
Width="size"
>
<CurrentNodeStyle />
<CurrentNodeTemplate>
<!-- child controls -->
</CurrentNodeTemplate>
<NodeStyle />
<NodeTemplate>
<!-- child controls -->
</NodeTemplate>
<PathSeparatorStyle />
<PathSeparatorTemplate>
<!-- child controls -->
</PathSeparatorTemplate>
<RootNodeStyle />
<RootNodeTemplate>
<!-- child controls -->
</RootNodeTemplate>
</asp:SiteMapPath>
The following code example uses a SiteMapPath control declaratively in a Web Forms page. This example demonstrates some of the rules of precedence that govern the order with which templates and styles are applied to SiteMapPath nodes.
<%@ Page Language="C#" %> <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <script runat="server"> </script> <html xmlns="http://www.w3.org/1999/xhtml" > <head runat="server"> <title>ASP.NET Example</title> </head> <body> <form id="form1" runat="server"> <!-- The following example demonstrates some of the orders of precedence when applying styles and templates to functional nodes of a SiteMapPath. The NodeStyle and RootNodeStyle define the same attributes, but are different and conflict with each other: the RootNodeStyle supersedes NodeStyle, and is the style rendered. Notice, however, that the underline style defined by NodeStyle is still applied. Both a CurrentNodeStyle and a CurrentNodeTemplate are defined. A template supersedes a style for a node type, so CurrentNodeTemplate is displayed and CurrentNodeStyle is ignored. --> <asp:SiteMapPath ID="SiteMapPath1" runat="server" RenderCurrentNodeAsLink="true" NodeStyle-Font-Names="Franklin Gothic Medium" NodeStyle-Font-Underline="true" NodeStyle-Font-Bold="true" RootNodeStyle-Font-Names="Symbol" RootNodeStyle-Font-Bold="false" CurrentNodeStyle-Font-Names="Verdana" CurrentNodeStyle-Font-Size="10pt" CurrentNodeStyle-Font-Bold="true" CurrentNodeStyle-ForeColor="red" CurrentNodeStyle-Font-Underline="false"> <CURRENTNODETEMPLATE> <asp:Image id="Image1" runat="server" ImageUrl="WebForm2.jpg" AlternateText="WebForm2"/> </CURRENTNODETEMPLATE> </asp:SiteMapPath> </form> </body> </html>
The previous example uses the default site map provider and a Web.sitemap file with the following structure.
<siteMap>
<siteMapNode title="WebForm1" description="WebForm1" url="WebForm1.aspx" >
<siteMapNode title="WebForm2" description="WebForm2" url="WebForm2.aspx"/>
</siteMapNode>
</siteMap>
The following code example demonstrates extends the SiteMapPath control and adds new functionality to it by overriding the InitializeItem method. The DropDownSiteMapPath control adds a DropDownList after the current node, to enable easy navigation to pages that are child nodes of the current page. This example demonstrates how to work with SiteMapNodeItem objects, including checking their SiteMapNodeItemType and calling the OnItemCreated method after the items are created.
using System; using System.Collections; using System.ComponentModel; using System.Security.Permissions; using System.Web; using System.Web.UI; using System.Web.UI.WebControls; // The DropDownNavigationPath is a class that extends the SiteMapPath // control and renders a DropDownList after the CurrentNode. The // DropDownList displays a list of pages found further down the site map // hierarchy from the current one. Selecting an item in the DropDownList // redirects to that page. // // For simplicity, the DropDownNavigationPath assumes the // RootToCurrent PathDirection, and does not apply styles // or templates the current node. // [AspNetHostingPermission(SecurityAction.Demand, Level=AspNetHostingPermissionLevel.Minimal)] public class DropDownNavigationPath : SiteMapPath { // Override the InitializeItem method to add a PathSeparator // and DropDownList to the current node. protected override void InitializeItem(SiteMapNodeItem item) { // The only node that must be handled is the CurrentNode. if (item.ItemType == SiteMapNodeItemType.Current) { HyperLink hLink = new HyperLink(); // No Theming for the HyperLink. hLink.EnableTheming = false; // Enable the link of the SiteMapPath is enabled. hLink.Enabled = this.Enabled; // Set the properties of the HyperLink to // match those of the corresponding SiteMapNode. hLink.NavigateUrl = item.SiteMapNode.Url; hLink.Text = item.SiteMapNode.Title; if (ShowToolTips) { hLink.ToolTip = item.SiteMapNode.Description; } // Apply styles or templates to the HyperLink here. // ... // ... // Add the item to the Controls collection. item.Controls.Add(hLink); AddDropDownListAfterCurrentNode(item); } else { base.InitializeItem(item); } } private void AddDropDownListAfterCurrentNode(SiteMapNodeItem item) { SiteMapNodeCollection childNodes = item.SiteMapNode.ChildNodes; // Only do this work if there are child nodes. if (childNodes != null) { // Add another PathSeparator after the CurrentNode. SiteMapNodeItem finalSeparator = new SiteMapNodeItem(item.ItemIndex, SiteMapNodeItemType.PathSeparator); SiteMapNodeItemEventArgs eventArgs = new SiteMapNodeItemEventArgs(finalSeparator); InitializeItem(finalSeparator); // Call OnItemCreated every time a SiteMapNodeItem is // created and initialized. OnItemCreated(eventArgs); // The pathSeparator does not bind to any SiteMapNode, so // do not call DataBind on the SiteMapNodeItem. item.Controls.Add(finalSeparator); // Create a DropDownList and populate it with the children of the // CurrentNode. There are no styles or templates that are applied // to the DropDownList control. If OnSelectedIndexChanged is raised, // the event handler redirects to the page selected. // The CurrentNode has child nodes. DropDownList ddList = new DropDownList(); ddList.AutoPostBack = true; ddList.SelectedIndexChanged += new EventHandler(this.DropDownNavPathEventHandler); // Add a ListItem to the DropDownList for every node in the // SiteMapNodes collection. foreach (SiteMapNode node in childNodes) { ddList.Items.Add(new ListItem(node.Title, node.Url)); } item.Controls.Add(ddList); } } // The sender is the DropDownList. private void DropDownNavPathEventHandler(object sender,EventArgs e) { DropDownList ddL = sender as DropDownList; // Redirect to the page the user chose. if (Context != null) Context.Response.Redirect(ddL.SelectedValue); } }
Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2
The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
