System.Web.SiteMapNode Members

The members of System.Web.SiteMapNode are listed below.

See Also: Inherited members from System.Object

Public Constructors

Initializes a new instance of the System.Web.SiteMapNode class, using the specified key to identify the page that the node represents and the site map provider that manages the node.

Initializes a new instance of the System.Web.SiteMapNode class using the specified URL, a key to identify the page that the node represents, and the site map provider that manages the node.

Initializes a new instance of the System.Web.SiteMapNode class using the specified URL, a key to identify the page that the node represents, a title, and the site map provider that manages the node.

Initializes a new instance of the System.Web.SiteMapNode class using the specified URL, a key to identify the page that the node represents, a title and description, and the site map provider that manages the node.

Initializes a new instance of the System.Web.SiteMapNode class using the specified site map provider that manages the node, URL, title, description, roles, additional attributes, and explicit and implicit resource keys for localization.

Public Properties

ChildNodesSiteMapNodeCollection.

Gets or sets all the child nodes of the current System.Web.SiteMapNode object from the associated System.Web.SiteMapProvider provider.

Descriptionstring.

Gets or sets a description for the System.Web.SiteMapNode.

[read-only]
HasChildNodesbool.

Gets a value indicating whether the current System.Web.SiteMapNode has any child nodes.

default property
Item(string)string. Documentation for this section has not yet been entered.
[read-only]
Keystring.

Gets a string representing a lookup key for a site map node.

[read-only]
NextSiblingSiteMapNode.

Gets the next System.Web.SiteMapNode node on the same hierarchical level as the current one, relative to the SiteMapNode.ParentNode property (if one exists).

ParentNodeSiteMapNode.

Gets or sets the System.Web.SiteMapNode object that is the parent of the current node.

[read-only]
PreviousSiblingSiteMapNode.

Gets the previous System.Web.SiteMapNode object on the same level as the current one, relative to the SiteMapNode.ParentNode object (if one exists).

[read-only]
ProviderSiteMapProvider.

Gets the System.Web.SiteMapProvider provider that the System.Web.SiteMapNode object is tracked by.

ReadOnlybool.

Gets or sets a value indicating whether the site map node can be modified.

ResourceKeystring.

Gets or sets the resource key that is used to localize the System.Web.SiteMapNode.

RolesIList.

Gets or sets a collection of roles that are associated with the System.Web.SiteMapNode object, used during security trimming.

[read-only]
RootNodeSiteMapNode.

Gets the root node of the root provider in a site map provider hierarchy. If no provider hierarchy exists, the SiteMapNode.RootNode property gets the root node of the current provider.

Titlestring.

Gets or sets the title of the System.Web.SiteMapNode object.

Urlstring.

Gets or sets the URL of the page that the System.Web.SiteMapNode object represents.

Protected Properties

AttributesSystem.Collections.Specialized.NameValueCollection.

Gets or sets a collection of additional attributes beyond the strongly typed properties that are defined for the System.Web.SiteMapNode class.

Public Methods

Clone() : SiteMapNode

Creates a new node that is a copy of the current node.

Clone(bool) : SiteMapNode

Creates a new copy that is a copy of the current node, optionally cloning all parent and ancestor nodes of the current node.

override
Equals(object) : bool

Gets a value indicating whether the current System.Web.SiteMapNode is identical to the specified object.

GetAllNodes() : SiteMapNodeCollection

Retrieves a read-only collection of all System.Web.SiteMapNode objects that are descendants of the calling node, regardless of the degree of separation.

GetDataSourceView(System.Web.UI.WebControls.SiteMapDataSource, string) : System.Web.UI.WebControls.SiteMapDataSourceView

Retrieves the System.Web.UI.WebControls.SiteMapDataSourceView object that is associated with the current node.

override
GetHashCode() : int

Returns the hash code of the System.Web.SiteMapNode object.

GetHierarchicalDataSourceView() : System.Web.UI.WebControls.SiteMapHierarchicalDataSourceView

Retrieves the System.Web.UI.WebControls.SiteMapHierarchicalDataSourceView object that is associated with the current node.

IsAccessibleToUser(HttpContext) : bool

Gets a value indicating whether the specified site map node can be viewed by the user in the specified context.

IsDescendantOf(SiteMapNode) : bool

Gets a value indicating whether the current site map node is a child or a direct descendant of the specified node.

override
ToString() : string

Converts the value of this instance of the System.Web.SiteMapNode class to its equivalent string representation.

Protected Methods

GetExplicitResourceString(string, string, bool) : string

Retrieves a localized string based on a System.Web.SiteMapNode attribute to localize, a default string to return if no resource is found, and a Boolean value indicating whether to throw an exception if no resource is found.

GetImplicitResourceString(string) : string

Gets a localized string based on the attribute name and SiteMapProvider.ResourceKey property that is specified by the System.Web.SiteMapProvider by which the System.Web.SiteMapNode is tracked.

Explicitly Implemented Interface Members

ICloneable.Clone

Creates a new node that is a copy of the current node. For a description of this member, see ICloneable.Clone.

System.Web.UI.IHierarchyData.GetChildren

Retrieves the hierarchical children data items of the current item. For a description of this member, see System.Web.UI.IHierarchyData.GetChildren.

System.Web.UI.IHierarchyData.GetParent

Retrieves the hierarchical parent of the current item. For a description of this member, see System.Web.UI.IHierarchyData.GetParent.

[read-only]
System.Web.UI.IHierarchyData.HasChildrenbool.

Gets a value that indicates whether the current System.Web.SiteMapNode object has any child nodes. For a description of this member, see System.Web.UI.IHierarchyData.HasChildren.

[read-only]
System.Web.UI.IHierarchyData.Itemobject.

Gets the hierarchical data item. For a description of this member, see System.Web.UI.IHierarchyData.Item.

[read-only]
System.Web.UI.INavigateUIData.Namestring.

Gets the SiteMapNode.Title property of the site map node. For a description of this member, see System.Web.UI.INavigateUIData.Name.

[read-only]
System.Web.UI.INavigateUIData.NavigateUrlstring.

Gets the SiteMapNode.Url property of the site map node. For a description of this member, see System.Web.UI.INavigateUIData.NavigateUrl.

[read-only]
System.Web.UI.IHierarchyData.Pathstring.

Gets the path of the hierarchical data item. For a description of this member, see System.Web.UI.IHierarchyData.Path.

[read-only]
System.Web.UI.IHierarchyData.Typestring.

Gets a string that represents the type name of the hierarchical data item. For a description of this member, see System.Web.UI.IHierarchyData.Type.

[read-only]
System.Web.UI.INavigateUIData.Valuestring.

Gets the SiteMapNode.Title property of the site map node. For a description of this member, see System.Web.UI.INavigateUIData.Value.