TreeSiteMapProvider MembersKentico 8.0 API Reference
The TreeSiteMapProvider type exposes the following members.
Constructors

  NameDescription
Public methodTreeSiteMapProvider
Back to Top
Methods

  NameDescription
Protected methodOnlineAddNode(SiteMapNode)
Adds a OnlineSiteMapNode object to the node collection that is maintained by the site map provider.
(Inherited from OnlineSiteMapProvider.)
Protected methodOnlineAddNode(SiteMapNode, SiteMapNode)
Adds a OnlineSiteMapNode to the collections that are maintained by the site map provider and establishes a parent/child relationship between the OnlineSiteMapNode objects.
(Inherited from OnlineStaticSiteMapProvider.)
Public methodBuildSiteMap
Performs the sitemap build.
(Overrides OnlineStaticSiteMapProvider BuildSiteMap .)
Protected methodClear
Clean up any collections or other state that an instance of this may hold.
(Overrides OnlineStaticSiteMapProvider Clear .)
Public methodOnlineEquals
Determines whether the specified OnlineObject is equal to the current OnlineObject.
(Inherited from OnlineObject.)
Protected methodOnlineFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from OnlineObject.)
Public methodOnlineFindSiteMapNode(String)
Retrieves a OnlineSiteMapNode object that represents the page at the specified URL.
(Inherited from OnlineStaticSiteMapProvider.)
Public methodOnlineFindSiteMapNode(HttpContext)
Retrieves a OnlineSiteMapNode object that represents the currently requested page using the specified OnlineHttpContext object.
(Inherited from OnlineSiteMapProvider.)
Public methodOnlineFindSiteMapNodeFromKey
Retrieves a OnlineSiteMapNode object based on a specified key.
(Inherited from OnlineStaticSiteMapProvider.)
Public methodOnlineGetCurrentNodeAndHintAncestorNodes
Provides an optimized lookup method for site map providers when retrieving the node for the currently requested page and fetching the parent and ancestor site map nodes for the current page.
(Inherited from OnlineSiteMapProvider.)
Public methodOnlineGetCurrentNodeAndHintNeighborhoodNodes
Provides an optimized lookup method for site map providers when retrieving the node for the currently requested page and fetching the site map nodes in the proximity of the current node.
(Inherited from OnlineSiteMapProvider.)
Public methodOnlineGetHashCode
Serves as a hash function for a particular type.
(Inherited from OnlineObject.)
Public methodOnlineGetChildNodes(SiteMapNode)
Retrieves the child site map nodes of a specific OnlineSiteMapNode object.
(Inherited from OnlineStaticSiteMapProvider.)
Public methodGetChildNodes(Int32)
Returns the set of child nodes for the specified node.
Public methodGetChildNodes(Int32, Int32)
Returns the set of child nodes for the specified node.
Public methodGetNodeByAliasPath
Returns the node by its Alias.
Public methodGetNodeById
Returns the node specified by given Node ID.
Public methodOnlineGetParentNode
Retrieves the parent site map node of a specific OnlineSiteMapNode object.
(Inherited from OnlineStaticSiteMapProvider.)
Public methodOnlineGetParentNodeRelativeToCurrentNodeAndHintDownFromParent
Provides an optimized lookup method for site map providers when retrieving an ancestor node for the currently requested page and fetching the descendant nodes for the ancestor.
(Inherited from OnlineSiteMapProvider.)
Public methodOnlineGetParentNodeRelativeToNodeAndHintDownFromParent
Provides an optimized lookup method for site map providers when retrieving an ancestor node for the specified OnlineSiteMapNode object and fetching its child nodes.
(Inherited from OnlineSiteMapProvider.)
Protected methodGetRootNodeCore
Returns the the root sitemap node.
(Overrides OnlineSiteMapProvider GetRootNodeCore .)
Public methodOnlineGetType
Gets the OnlineType of the current instance.
(Inherited from OnlineObject.)
Public methodOnlineHintAncestorNodes
Provides a method that site map providers can override to perform an optimized retrieval of one or more levels of parent and ancestor nodes, relative to the specified OnlineSiteMapNode object.
(Inherited from OnlineSiteMapProvider.)
Public methodOnlineHintNeighborhoodNodes
Provides a method that site map providers can override to perform an optimized retrieval of nodes found in the proximity of the specified node.
(Inherited from OnlineSiteMapProvider.)
Public methodOnlineInitialize
Initializes the OnlineSiteMapProvider implementation, including any resources that are needed to load site map data from persistent storage.
(Inherited from OnlineSiteMapProvider.)
Public methodOnlineIsAccessibleToUser
Retrieves a Boolean value indicating whether the specified OnlineSiteMapNode object can be viewed by the user in the specified context.
(Inherited from OnlineSiteMapProvider.)
Protected methodOnlineMemberwiseClone
Creates a shallow copy of the current OnlineObject.
(Inherited from OnlineObject.)
Public methodReloadData
Reloads the tree data.
Protected methodOnlineRemoveNode
Removes the specified OnlineSiteMapNode object from all site map node collections that are tracked by the site map provider.
(Inherited from OnlineStaticSiteMapProvider.)
Protected methodOnlineResolveSiteMapNode
Raises the OnlineSiteMapResolve event.
(Inherited from OnlineSiteMapProvider.)
Public methodOnlineToString
Returns a string that represents the current object.
(Inherited from OnlineObject.)
Back to Top
Extension Methods

  NameDescription
Public Extension MethodGetAPIString
Gets the string by the specified resource key
(Defined by CoreExtensions.)
Public Extension MethodGetString
Gets the string by the specified resource key
(Defined by CoreExtensions.)
Public Extension MethodToBoolean
Returns the boolean representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToDateTime
Returns the DateTime representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToDouble
Returns the double representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToGuid
Returns the Guid representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToInteger
Returns the integer representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToString
Returns the string representation of an object or default value if not.
(Defined by CoreExtensions.)
Back to Top
Fields

  NameDescription
Protected fieldmAlternativePath
Alternative path.
Protected fieldmBindNodeData
Bind the node data to the nodes.
Protected fieldmClassNames
Class names.
Protected fieldmCombineWithDefaultCulture
Combine with default culture.
Protected fieldmCultureCode
Culture code.
Protected fieldmCheckPermissions
Indicates if the permissions should be checked.
Protected fieldmMaxRelativeLevel
Maximum relative level.
Protected fieldmMaxTreeNodes
Maximum number of the nodes in a level.
Protected fieldmOrderBy
Order by.
Protected fieldmPath
Path.
Protected fieldmRootNodeLevel
Root node level.
Protected fieldmSelectOnlyPublished
Select only published.
Protected fieldmSelectPublishedData
Select the published data.
Protected fieldmSiteName
Site name.
Protected fieldmTreeProvider
Tree provider.
Protected fieldmUsedPath
Used path.
Protected fieldmWhereCondition
Where condition.
Back to Top
Properties

  NameDescription
Public propertyAlternativePath
Property to set and get the alternative path.
Public propertyBindNodeData
Specifies if the node data (TreeNode) should be bound to the nodes.
Public propertyClassNames
Property to set and get the classnames list (separated by the semicolon).
Public propertyCombineWithDefaultCulture
Property to set and get the CombineWithDefaultCulture flag.
Public propertyCultureCode
Property to set and get the CultureCode.
Public propertyOnlineCurrentNode
Gets the OnlineSiteMapNode object that represents the currently requested page.
(Inherited from OnlineSiteMapProvider.)
Public propertyOnlineDescription
Gets a brief, friendly description suitable for display in administrative tools or other user interfaces (UIs).
(Inherited from OnlineProviderBase.)
Public propertyOnlineEnableLocalization
Gets or sets a Boolean value indicating whether localized values of OnlineSiteMapNode attributes are returned.
(Inherited from OnlineSiteMapProvider.)
Public propertyCheckPermissions
Indicates if the permissions should be checked.
Public propertyMaxRelativeLevel
Property to set and get the MaxRelativeLevel.
Public propertyMaxTreeNodes
Maximum number of tree nodes displayed within the tree.
Public propertyOnlineName
Gets the friendly name used to refer to the provider during configuration.
(Inherited from OnlineProviderBase.)
Public propertyOrderBy
Property to set and get the OrderBy.
Public propertyOnlineParentProvider
Gets or sets the parent OnlineSiteMapProvider object of the current provider.
(Inherited from OnlineSiteMapProvider.)
Public propertyPath
Property to set and get the Path.
Public propertyOnlineResourceKey
Get or sets the resource key that is used for localizing OnlineSiteMapNode attributes.
(Inherited from OnlineSiteMapProvider.)
Public propertyRootNode
Property to get Sitemap root node.
(Overrides OnlineSiteMapProvider RootNode.)
Public propertyRootNodeLevel
Root node level.
Public propertyOnlineRootProvider
Gets the root OnlineSiteMapProvider object in the current provider hierarchy.
(Inherited from OnlineSiteMapProvider.)
Public propertyOnlineSecurityTrimmingEnabled
Gets a Boolean value indicating whether a site map provider filters site map nodes based on a user's role.
(Inherited from OnlineSiteMapProvider.)
Public propertySelectOnlyPublished
Property to set and get the SelectOnlyPublished flag.
Public propertySelectPublishedData
If true, the published data.
Public propertySiteName
Property to set and get the SiteName.
Public propertyTreeProvider
Tree provider instance used to access data. If no TreeProvider is assigned, a new TreeProvider instance is created.
Public propertyUsedPath
Used alias path.
Public propertyWhereCondition
Property to set and get the WhereCondition.
Back to Top
Events

  NameDescription
Public eventOnlineSiteMapResolve
Occurs when the OnlineCurrentNode property is called.
(Inherited from OnlineSiteMapProvider.)
Back to Top
See Also