SiteMapPath Members
.NET Framework 3.0
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.
The following tables list the members exposed by the SiteMapPath type.
(see also
Protected Properties
)
Top
| Name | Description | |
|---|---|---|
| AccessKey | Gets or sets the access key that allows you to quickly navigate to the Web server control.(inherited from WebControl) |
| 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 | 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) |
| ClientID | Gets the server control identifier generated by ASP.NET.(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. |
| 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) |
| 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) |
| 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) |
| 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. |
| 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) |
| TabIndex | Gets or sets the tab index of the Web server control.(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) |
| 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 | |
|---|---|---|
| Adapter | Gets the browser-specific adapter for the control.(inherited from Control) |
| ChildControlsCreated | Gets a value that indicates whether the server control's child controls have been created.(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) |
| DesignMode | Gets a value indicating whether a control is being used on a design surface.(inherited from Control) |
| Events | Gets a list of event handler delegates for the control. This property is read-only.(inherited from Control) |
| HasChildViewState | Gets a value indicating whether the current server control's child controls have any saved view-state settings.(inherited from Control) |
| IdSeparator | 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) |
| 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) |
| 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) |
(see also
Protected Methods
)
Top
| Name | Description | |
|---|---|---|
| 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) |
| 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) |
| DataBind | Overloaded. Overridden. Binds a data source to the SiteMapPath control and all its child controls. |
| Dispose | Enables a server control to perform final clean up before it is released from memory. (inherited from Control) |
| Equals | Overloaded. Determines whether two Object instances are equal. (inherited from Object) |
| FindControl | Overloaded. Searches the current naming container for the specified server control. (inherited from Control) |
| Focus | Sets input focus to a control. (inherited from Control) |
| GetHashCode | Serves as a hash function for a particular type. (inherited from Object) |
| GetType | Gets the Type of the current instance. (inherited from Object) |
| HasControls | Determines if the server control contains any child controls. (inherited from Control) |
| 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) |
| ReferenceEquals | Determines whether the specified Object instances are the same instance. (inherited from Object) |
| RenderBeginTag | Renders the HTML opening tag of the control to the specified writer. This method is used primarily by control developers. (inherited from WebControl) |
| RenderControl | Overloaded. Outputs server control content and stores tracing information about the control if tracing is enabled. (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) |
| 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) |
| SetRenderMethodDelegate | 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) |
| 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) |
| BuildProfileTree | 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) |
| 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) |
| CreateChildControls | Overridden. Clears the current child controls collection, and rebuilds it by calling the CreateControlHierarchy method. |
| 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 | Overloaded. Binds a data source to the invoked server control and all its child controls. (inherited from Control) |
| DataBindChildren | Binds a data source to the server control's child controls. (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) |
| Finalize | Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (inherited from Object) |
| FindControl | Overloaded. Searches the current naming container for the specified server control. (inherited from Control) |
| GetDesignModeState | Gets design-time data for a control. (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 | 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 | Overridden. Restores view-state information from a previous request that was saved with the SaveViewState method. |
| 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) |
| OnBubbleEvent | Determines whether the event for the server control is passed up the page's UI server control hierarchy. (inherited from Control) |
| OnDataBinding | Overridden. Overrides the OnDataBinding method of the CompositeControl class and raises the DataBinding event. |
| 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 | Overridden. |
| 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 | Overridden. Renders the nodes in the SiteMapPath control. |
| RenderControl | Overloaded. Outputs server control content and stores tracing information about the control if tracing is enabled. (inherited from Control) |
| ResolveAdapter | Gets the control adapter responsible for rendering the specified control. (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 | Overridden. Saves changes to view state for the SiteMapPath control. |
| SetDesignModeState | Sets design-time data for a control. (inherited from Control) |
| TrackViewState | Overridden. Tracks changes to the SiteMapPath control's view state. |
| 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 | 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) |
Community Additions
ADD
Show: