UniTreeProvider Class

Universal sitemap tree provider.

Inheritance Hierarchy

System.Object
  System.Configuration.Provider.ProviderBase
    System.Web.SiteMapProvider
      System.Web.StaticSiteMapProvider
        CMS.UIControls.UniTreeProvider

Namespace: CMS.UIControls
Assembly: CMS.UIControls (in CMS.UIControls.dll) Version: 8.2.23

Syntax

public class UniTreeProvider : StaticSiteMapProvider

The UniTreeProvider type exposes the following members.

Constructors

	Name	Description
Public method	UniTreeProvider	Constructor

Methods

	Name	Description
Public method	BuildSiteMap	Performs the site map build and returns UniTreeNode. (Overrides StaticSiteMapProvider.BuildSiteMap().)
Public method	GetChildNodes(String)	Returns the set of child nodes for the specified node.
Public method	GetChildNodes(String, Int32)	Returns the set of child nodes for the specified node.
Public method	GetNodeByKey	Returns the UniTreeNode specified by given Node ID.
Protected method	GetRootNodeCore	Returns the root UniTreeNode. (Overrides SiteMapProvider.GetRootNodeCore().)
Public method	LoadData	Loads data with dependence on current settings Where condition

Extension Methods

	Name	Description
Public Extension Method	AsValue	Converts object to a query value which can be used as a query parameter (Defined by QueryExtensions.)
Public Extension Method	GetAPIString	Gets the string by the specified resource key (Defined by CoreExtensions.)
Public Extension Method	GetString	Gets the string by the specified resource key (Defined by CoreExtensions.)
Public Extension Method	ToBoolean	Returns the boolean representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToDateTime	Returns the DateTime representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToDouble	Returns the double representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToGuid	Returns the Guid representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToInteger	Returns the integer representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToString	Returns the string representation of an object or default value if not. (Defined by CoreExtensions.)

Properties

	Name	Description
Public property	BindNodeData	Specifies if the node data (TreeNode) should be bound to the nodes.
Public property	CaptionColumn	Gets or sets the name of column which contains caption of current object.
Public property	Columns	Gets or sets the list of columns which should be selected.
Public property	DisplayNameColumn	Gets or sets the name of column which contains display name value.
Public property	ChildCountColumn	Gets or sets the name of column which contains current object child count.
Public property	IconClassColumn	Gets or sets the name of column which contains font icon CSS class.
Public property	IDColumn	Gets or sets the name of column which contains object id value.
Public property	ImageColumn	Gets or sets the name of column which contains image URL value.
Public property	LevelColumn	Gets or sets the name of column which contains current object level value.
Public property	MaxRelativeLevel	Gets or sets the maximal nested level which should be loaded.
Public property	ObjectType	Gets or sets the name of the object.
Public property	ObjectTypeColumn	Gets or sets the column name of the object type.
Public property	OrderBy	Gets or sets the query order by expression.
Public property	OrderColumn	Gets or sets the name of column which contains current object order.
Public property	ParameterColumn	Gets or sets the name of column which contains additional parameter.
Public property	Parameters	Gets or sets query parametres.
Public property	ParentIDColumn	Gets or sets the name of column which contains parent id value for current object.
Public property	PathColumn	Gets or sets the name of column which contains current object path.
Public property	QueryName	Gets or sets the query name. if query name is specified object type is not used to data loading.
Public property	RootLevelOffset	Specifies the root level offset.
Public property	RootNode	Property to get Sitemap root node. (Overrides SiteMapProvider.RootNode.)
Public property	TopN	Gets or sets the number of rows which should be selected.
Public property	UseCustomRoots	Indicates whether using custom roots. When set to true, roots will not be obtained from DB. Default value is false.
Public property	ValueColumn	Gets or sets the name of column which contains value.
Public property	WhereCondition	Gets or sets the query where condition.