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

  NameDescription
Public methodUniTreeProvider
Constructor
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 site map build and returns UniTreeNode.
(Overrides OnlineStaticSiteMapProvider BuildSiteMap .)
Protected methodOnlineClear
Removes all elements in the collections of child and parent site map nodes that the OnlineStaticSiteMapProvider tracks as part of its state.
(Inherited from OnlineStaticSiteMapProvider.)
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(String)
Returns the set of child nodes for the specified node.
Public methodGetChildNodes(String, Int32)
Returns the set of child nodes for the specified node.
Public methodGetNodeByKey
Returns the UniTreeNode 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 root UniTreeNode.
(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.)
Public methodLoadData
Loads data with dependence on current settings Where condition
Protected methodOnlineMemberwiseClone
Creates a shallow copy of the current OnlineObject.
(Inherited from OnlineObject.)
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
Properties

  NameDescription
Public propertyBindNodeData
Specifies if the node data (TreeNode) should be bound to the nodes.
Public propertyCaptionColumn
Gets or sets the name of column which contains caption of current object.
Public propertyColumns
Gets or sets the list of columns which should be selected.
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 propertyDisplayNameColumn
Gets or sets the name of column which contains display name value.
Public propertyOnlineEnableLocalization
Gets or sets a Boolean value indicating whether localized values of OnlineSiteMapNode attributes are returned.
(Inherited from OnlineSiteMapProvider.)
Public propertyChildCountColumn
Gets or sets the name of column which contains current object child count.
Public propertyIconClassColumn
Gets or sets the name of column which contains font icon CSS class.
Public propertyIDColumn
Gets or sets the name of column which contains object id value.
Public propertyImageColumn
Gets or sets the name of column which contains image URL value.
Public propertyLevelColumn
Gets or sets the name of column which contains current object level value.
Public propertyMaxRelativeLevel
Gets or sets the maximal nested level which should be loaded.
Public propertyOnlineName
Gets the friendly name used to refer to the provider during configuration.
(Inherited from OnlineProviderBase.)
Public propertyObjectType
Gets or sets the name of the object.
Public propertyObjectTypeColumn
Gets or sets the column name of the object type.
Public propertyOrderBy
Gets or sets the query order by expression.
Public propertyOrderColumn
Gets or sets the name of column which contains current object order.
Public propertyParameterColumn
Gets or sets the name of column which contains additional parameter.
Public propertyParameters
Gets or sets query parametres.
Public propertyParentIDColumn
Gets or sets the name of column which contains parent id value for current object.
Public propertyOnlineParentProvider
Gets or sets the parent OnlineSiteMapProvider object of the current provider.
(Inherited from OnlineSiteMapProvider.)
Public propertyPathColumn
Gets or sets the name of column which contains current object path.
Public propertyQueryName
Gets or sets the query name. if query name is specified object type is not used to data loading.
Public propertyOnlineResourceKey
Get or sets the resource key that is used for localizing OnlineSiteMapNode attributes.
(Inherited from OnlineSiteMapProvider.)
Public propertyRootLevelOffset
Specifies the root level offset.
Public propertyRootNode
Property to get Sitemap root node.
(Overrides OnlineSiteMapProvider RootNode.)
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 propertyTopN
Gets or sets the number of rows which should be selected.
Public propertyUseCustomRoots
Indicates whether using custom roots. When set to true, roots will not be obtained from DB. Default value is false.
Public propertyValueColumn
Gets or sets the name of column which contains value.
Public propertyWhereCondition
Gets or sets the query where condition.
Back to Top
Events

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