System.Web 2.0.0.0 System.Object System.ICloneable System.Web.UI.IHierarchyData System.Web.UI.INavigateUIData

A object represents a Web site page in a site map structure. objects are loaded by the static class at run time using one or more site map providers to load site map data from persistent storage into memory. objects are wrapped by the class for use by Web server controls, such as the control.

The class includes several properties that are used to describe a single page in a Web site, including properties that describe a page, such as the , , and properties. Whereas the property is used by the class, which is the default site map provider for ASP.NET, as a lookup key in the internal collections that the provider uses to track nodes, the class supports a basic property that can be used by site map providers to track nodes. Additionally, the property is used by navigation controls to render hyperlinks to pages within a navigation structure. The property is a friendly name for the , is often the same as the HTML title of a Web Form, and is used by navigation controls to render simple labels. Finally, a collection of additional attributes is available to site map providers that use objects, but require additional properties that are not available in the base class.

Represents a node in the hierarchical site map structure such as that described by the class and classes that implement the abstract class.

- Constructor

  The class, which is the default provider implementation for ASP.NET, uses the property as a lookup key, if one is provided for the node (if a URL is not provided, a tracking identifier is generated for the node). Therefore, any control that provides a URL and is used by the must have a unique URL within the scope of the provider.

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

  The with which the node is associated.
  A provider-specific lookup key.
  2.0.0.0
- Constructor

  The class, which is the default provider implementation for ASP.NET, uses the property as a lookup key, if one is provided for the node (if a URL is not provided, a tracking identifier is generated for the node). Therefore, any object that provides a URL and is used by the must have a unique URL within the scope of the provider.

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

  The with which the node is associated.
  A provider-specific lookup key.
  The URL of the page that the node represents within the site.
  2.0.0.0
- Constructor

  The class, which is the default provider implementation for ASP.NET, uses the property as a lookup key, if one is provided for the node (if a URL is not provided, a tracking identifier is generated for the node). Therefore, any object that provides a URL and is used by the must have a unique URL within the scope of the provider.

  If no is provided, calls to the property return the field.

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

  The with which the node is associated.
  A provider-specific lookup key.
  The URL of the page that the node represents within the site.
  A label for the node, often displayed by navigation controls.
  2.0.0.0
- Constructor

  The class, which is the default provider implementation for ASP.NET, uses the property as a lookup key, if one is provided for the node (if a URL is not provided, a tracking identifier is generated for the node). Therefore, any object that provides a URL and is used by the must have a unique URL within the scope of the provider.

  If no or is provided, calls to the or properties return an field.

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

  The with which the node is associated.
  A provider-specific lookup key.
  The URL of the page that the node represents within the site.
  A label for the node, often displayed by navigation controls.
  A description of the page that the node represents.
  2.0.0.0
- Constructor

  The class, which is the default provider implementation for ASP.NET, uses the property as a lookup key, if one is provided for the node (if a URL is not provided, a tracking identifier is generated for the node). Therefore, any object that provides a URL and is used by the must have a unique URL within the scope of the provider.

  The collection of attributes that the is created with is available through the property, and makes it easy to apply additional attributes to a site map node and extend its capabilities without deriving a custom class to do so.

  Supply an collection of roles to provide a set of roles that can view the node when the property returns true. For more information, see .

  The provider uses the property as a lookup key. Therefore, any that is used by the must have a unique URL within the scope of the provider.

  If no or is provided, calls to the or properties return an field.

  To programmatically specify resources for localization, either set the value of to a unique name that will be used to identify localized resources for the node or set to a collection of pairs where is the node property or custom attribute to localize and contains localization values for the node property or custom attribute. The localized values can then be set in the appropriate .resx files. For more information about how to localize the , , and any custom properties of a object, see How to: Localize Site-Map Data. For the syntax requirements of the collection, see .

  Initializes a new instance of the 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.

  The with which the node is associated.
  A provider-specific lookup key.
  The URL of the page that the node represents within the site.
  A label for the node, often displayed by navigation controls.
  A description of the page that the node represents.
  An of roles that are allowed to view the page represented by the .
  A of additional attributes used to initialize the .
  A of explicit resource keys used for localization.
  An implicit resource key used for localization.
  2.0.0.0
- Property
  System.Collections.Specialized.NameValueCollection To be added.

  The collection is typically used when you need to apply additional attributes to a site map node, but do not want to derive a custom class in order to do so.

  The protected attribute does not perform in the same manner as the or properties. For localization support, developers must use the default indexer.

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

  2.0.0.0
- Property
  System.Web.SiteMapNodeCollection To be added.

  The relies on the that it is associated with to keep track of its relationships to other nodes in the site map. This property calls the method, passing a reference to itself, to retrieve the .

  If security trimming is enabled, only nodes that the current user is permitted to see are returned. If the user is not permitted to see any child nodes, an empty collection is returned.

  Gets or sets all the child nodes of the current object from the associated provider.

  2.0.0.0
- Method
  System.Web.SiteMapNode

  Calls the method with the parameter set to false. The provider, , , , and properties are copied. The and collections are copied to new collections. Ancestor and child nodes are not cloned.

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

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

  2.0.0.0
- Method
  System.Web.SiteMapNode ``

  If the parameter is true, the method recursively clones all direct ancestor nodes and associates them with the current cloned node. Child nodes are not cloned.

  The and collections are applied to new collections.

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

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

  true to clone all parent and ancestor nodes of the current node; otherwise, false. 2.0.0.0
- Property
  System.ComponentModel.Localizable(true)
  System.String To be added.

  While the of a is used by some navigation controls as a label or hyperlink, the is used as a ToolTip element for mouse over events.

  A localized value of the property is returned if the property is true.

  Gets or sets a description for the .

  2.0.0.0
- Method
  System.Boolean `` To be added.

  Two objects are considered equal if both of the following conditions are met:

  Both objects have the same value for the property.

  The culture-invariant, case-insensitive comparison of both properties returns true.

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

  true if is both a and identical to the current ; otherwise, false.

  2.0.0.0
- Method
  System.Web.SiteMapNodeCollection

  This method retrieves immediate child nodes, and all their child nodes, recursively.

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

  A read-only that represents all the descendants of a within the scope of the current provider.

  2.0.0.0
- Method
  System.Web.UI.WebControls.SiteMapDataSourceView `` `` To be added.

  Retrieves the object that is associated with the current node.

  A named for the current node.

  A control that the view is associated with. The name of the view. 2.0.0.0
- Method
  System.String `` `` ``

  The method is invoked in the get accessor of the property, the property, and any custom attributes that are defined in the property. The object by which the is tracked must have its property set to true for the method to return a localized string. If the is set to false, localization is not performed and the method is never called.

  The property, the property, and any custom attributes that are defined in the property first invoke the method. If it returns null, the method is invoked with set to the value of the default value from the explicit resource expression (assuming one was defined) and set to true.

  The class imposes the restriction that the object cannot define both implicit resource expressions and explicit resource expressions for attributes. However, a custom provider implementation can choose to allow both.

  The method uses the collection of resource keys that the object was initialized with. If a collection of resource keys was not specified, the returns null.

  Retrieves a localized string based on a 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.

  A string representing the localized attribute.

  The attribute to localize. The default value to return if a matching resource is not found. true to throw an , if an explicit resource is defined for , is null, and a localized value is not found; otherwise, false. 2.0.0.0
- Method
  System.Int32

  The hash code is generated using the lookup key (that is, a hash of the property) for a site map node.

  Returns the hash code of the object.

  A 32-bit signed integer representing the hash code.

  2.0.0.0
- Method
  System.Web.UI.WebControls.SiteMapHierarchicalDataSourceView To be added.

  Retrieves the object that is associated with the current node.

  A for the current node.

  2.0.0.0
- Method
  System.String ``

  The method is invoked in the get accessor of the property, the property, and any custom attributes that are defined in the property. The provider by which the object is tracked must have its property set to true for the method to be called. If the is set to false, localization is not performed and the method is never called.

  If the method returns a string that is not empty, this becomes the value of the , , or custom attribute property.

  The method uses the value of the property to localize the attribute. If the is not specified, the returns null.

  The class imposes the restriction that the object cannot define both implicit resource expressions and explicit resource expressions for attributes. However, a custom provider implementation can choose to allow both.

  Gets a localized string based on the attribute name and property that is specified by the by which the is tracked.

  A string representing the localized attribute. The default is null.

  The attribute to localize. 2.0.0.0
- Property
  System.Boolean To be added.

  This property is a convenience property that calls the property internally, so it will not perform better than if you call the property yourself and check to see if it is empty.

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

  2.0.0.0
- Method
  System.Boolean `` To be added.

  The method calls the method of the provider that the node is associated with, passing the specified .

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

  true if any one of the following conditions is met: the security trimming is enabled and the current user is a member of at least one of the roles allowing access to view the site map node; the current user is authorized specifically for the requested node's URL in the authorization element for the current application and the URL is located within the directory structure for the application; the current thread has an associated that has file access to the requested node's URL and the URL is located within the directory structure for the application; or security trimming is not enabled and therefore any user is allowed to view the site map node; otherwise, false.

  2.0.0.0
- Method
  System.Boolean `` To be added.

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

  true if the current node is a child or descendant of the specified node; otherwise, false.

  The to check if the current node is a child or descendant of. 2.0.0.0
- Property
  System.String `` To be added. To be added. To be added. To be added. 2.0.0.0
- Property
  System.String To be added.

  Internally, site navigation classes can use this lookup key when searching for site map nodes, as well as for establishing relationships between nodes. The class also exposes the method as a means for getting a reference to a object that matches the key value.

  The specific value that is used for the key is provider specific; however, it is guaranteed to not be null.

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

  2.0.0.0
- Property
  System.Web.SiteMapNode To be added.

  The property presumes that the object implements its internal collections such that when a parent node retrieves its property, the nodes are in the same order as they appear in the site map. If you use .NET Framework collection classes in an implementation of a site map provider, choose collections that implement the interface, such as the or classes. If you choose collections that do not implement the interface, such as the class, unexpected results can occur for simple site navigation operations.

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

  2.0.0.0
- Property
  System.Web.SiteMapNode To be added.

  The class relies on the site map provider with which it is associated to track its relationships to other nodes in the site map. The property calls the method, passing a reference to itself, to retrieve the parent .

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

  2.0.0.0
- Property
  System.Web.SiteMapNode To be added.

  The property presumes that the site map provider implements its internal collections such that when a parent node retrieves its objects, the nodes are in the same order as they appear in the site map. If you use .NET Framework collection classes in an implementation of a provider, choose collections that implement the interface, such as the or class. If you choose collections that do not implement the interface, such as the class, unexpected results can occur for simple site navigation operations.

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

  2.0.0.0
- Property
  System.Web.SiteMapProvider To be added.

  A provider is always returned; passing null to the constructor results in an exception.

  Gets the provider that the object is tracked by.

  2.0.0.0
- Property
  System.Boolean To be added.

  A object is modifiable by default.

  All nodes that are returned by the are read-only, by default.

  The , , , , , , and property mutators check the property before attempting to modify the property of a site map node. If the node is read-only when a mutator is called, the object throws an exception.

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

  2.0.0.0
- Property
  System.String To be added.

  Using the set accessor of the property when the property is true will result in an exception. To set the for a object, use the constructor.

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

  2.0.0.0
- Property
  System.Collections.IList To be added.

  If security trimming is enabled, a site map provider builds a node tree of nodes that the current user is able to view, based in part on whether the current user's assigned role is included in the collection. URL authorization and file authorization are also used to determine whether a user has the rights to access a object. For more information on authorization, see ASP.NET Authorization.

  You can use the constructor to supply a list of roles to the object when it is first created.

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

  2.0.0.0
- Property
  System.Web.SiteMapNode To be added.

  The class relies on the site map provider with which it is associated to track its relationships to other nodes in the site map. The property calls the property of the root provider (the property) to retrieve the root node.

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

  2.0.0.0
- Method
  2.0.0.0
  System.Object

  The and collections are copied to new collections.

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

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

- Method
  2.0.0.0
  System.Web.UI.IHierarchicalEnumerable

  The method delegates to the property.

  This member is an explicit interface member implementation. It can be used only when the instance is cast to an interface.

  Retrieves the hierarchical children data items of the current item. For a description of this member, see .

  An that represents the immediate children of the current item in the hierarchy.

- Method
  2.0.0.0
  System.Web.UI.IHierarchyData

  The method delegates to the property.

  This member is an explicit interface member implementation. It can be used only when the instance is cast to an interface.

  Retrieves the hierarchical parent of the current item. For a description of this member, see .

  An that represents the parent of the current item in the hierarchy.

- Property
  2.0.0.0
  System.Boolean To be added.

  The property delegates to the property.

  This member is an explicit interface member implementation. It can be used only when the instance is cast to an interface.

  Gets a value that indicates whether the current object has any child nodes. For a description of this member, see .

- Property
  2.0.0.0
  System.Object To be added.

  This member is an explicit interface member implementation. It can be used only when the instance is cast to an interface.

  Gets the hierarchical data item. For a description of this member, see .

- Property
  2.0.0.0
  System.String To be added.

  The property delegates to the property.

  This member is an explicit interface member implementation. It can be used only when the instance is cast to an interface.

  Gets the path of the hierarchical data item. For a description of this member, see .

- Property
  2.0.0.0
  System.String To be added.

  This member is an explicit interface member implementation. It can be used only when the instance is cast to an interface.

  Gets a string that represents the type name of the hierarchical data item. For a description of this member, see .

- Property
  2.0.0.0
  System.String To be added.

  The property delegates to the property.

  This member is an explicit interface member implementation. It can be used only when the instance is cast to an interface.

  Gets the property of the site map node. For a description of this member, see .

- Property
  2.0.0.0
  System.String To be added.

  The property delegates to the property.

  This member is an explicit interface member implementation. It can be used only when the instance is cast to an interface.

  Gets the property of the site map node. For a description of this member, see .

- Property
  2.0.0.0
  System.String To be added.

  The property delegates to the property and is used to store additional data about the navigation node, such as the data that is used for handling postback events.

  This member is an explicit interface member implementation. It can be used only when the instance is cast to an interface.

  Gets the property of the site map node. For a description of this member, see .

- Property
  System.ComponentModel.Localizable(true)
  System.String To be added.

  The property is used by navigation controls to render a label for the node, instead of using the property, while the property is used as a ToolTip element for mouse-over events.

  A localized value of the property is returned if the property is true.

  Gets or sets the title of the object.

  2.0.0.0
- Method
  System.String

  The method returns the property of a object.

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

  The string representation of the value of this .

  2.0.0.0
- Property
  System.String To be added.

  The class, which is the default site map provider implementation for ASP.NET, uses the property as a lookup key. Therefore, any object that is used by the class must have a unique URL within the scope of the provider.

  Leading and trailing white-space characters are ignored.

  Gets or sets the URL of the page that the object represents.

  2.0.0.0