CMSTreeView Class

CMSTreeView class.

Inheritance Hierarchy

System.Object
  System.Web.UI.Control
    System.Web.UI.WebControls.WebControl
      System.Web.UI.WebControls.BaseDataBoundControl
        System.Web.UI.WebControls.HierarchicalDataBoundControl
          System.Web.UI.WebControls.TreeView
            CMS.DocumentEngine.Web.UI.CMSTreeView

Namespace: CMS.DocumentEngine.Web.UI
Assembly: CMS.DocumentEngine.Web.UI (in CMS.DocumentEngine.Web.UI.dll) Version: 10.0.0

Syntax

public class CMSTreeView : TreeView

The CMSTreeView type exposes the following members.

Constructors

	Name	Description
Public method	CMSTreeView	Constructor.

Fields

	Name	Description
Protected field	mFilterControl	Filter control.
Protected field	mFilterName	Filter name.
Protected field	mProperties	Menu properties variable.

Properties

	Name	Description
Public property	CacheDependencies	Cache dependencies, each cache dependency on a new line.
Public property	CacheItemName	Name of the cache item the control will use.
Public property	CacheMinutes	Number of minutes the retrieved content is cached for. Zero indicates that the content will not be cached.
Public property	ClassNames	Property to set and get the classnames list (separated by the semicolon).
Public property	Columns	Gets or sets the columns to be retrieved from database.
Public property	CombineWithDefaultCulture	Property to set and get the CombineWithDefaultCulture flag.
Public property	ControlContext	Control context.
Public property	CSSPrefix	Specifies prefix of standard CMSMenu CSS classes. You can also use several values separated with semicolon (;) for particular levels.
Public property	CultureCode	Property to set and get the CultureCode.
Public property	DataSource	Gets or sets a DataSet containing values used to populate the items within the control. This value needn't be set.
Public property	DisplayDocumentTypeImages	Indicates if images are sets by doc type images.
Public property	DynamicBehavior	Enable populate on demand and load child nodes dynamically.
Public property	EncodeMenuCaption	Indicates if menu caption should be HTML encoded.
Public property	ExpandAllOnStartup	Expand all nodes in tree.
Public property	ExpandCurrentPath	If it is true, treeview will expand all items to the current item.
Public property	ExpandSubTree	Gets or sets the value that indicates whether subtree under current item is expanded.
Public property	FilterControl	Filter control.
Public property	FilterName	Gets or Set filter name.
Public property	FixBrokenLines	Fix broken lines.
Protected property	GroupedDS	Grouped data source.
Public property	HideControlForZeroRows	Hides the control when no data is loaded. Default value is False.
Public property	HideRootNode	Gets or sets the value that indicates whether root node is hidden.
Public property	HiglightSelectedItem	Indicates if selected item is highlighted.
Public property	CheckPermissions	Allows you to specify whether to check permissions of the current user. If the value is 'false' (default value) no permissions are checked. Otherwise, only nodes for which the user has read permission are displayed.
Public property	IgnoreDocumentMenuAction	Ignore document menu action.
Public property	InactivateAllItemsInPath	Inactivate all items in path.
Public property	InactivateSelectedItem	Inactivate selected item.
Public property	InactiveItemClass	Inactive item class.
Public property	InactiveItemStyle	Inactive item style.
Public property	InactiveNodeImage	Indicates if node image is inactive.
Public property	InactiveRoot	If it is true, root node is not active.
Public property	ItemClass	Item class.
Public property	ItemStyle	Item style.
Public property	JSoriginalClass	Original item class.
Public property	JSoriginalStyle	Original item style.
Public property	JSselectedClass	Selected item class.
Public property	JSselectedObject	Selected object.
Public property	JSselectedStyle	Selected item style.
Public property	LocalResolver	Local instance of macro resolver.
Public property	MaxRelativeLevel	Property to set and get the MaxRelativeLevel.
Public property	NodeImageUrl	Sets or Get images for every node.
Public property	OnClickAction	Sets or Get onclick javascript action.
Public property	OrderBy	Property to set and get the OrderBy.
Public property	Path	Property to set and get the Path.
Public property	RootImageUrl	If RootImageUrl is set to the some value, this image will be displayed for the root node.
Public property	RootText	If RootText is set to the some value, this value replace normal root node text.
Public property	SelectedColumns	Gets or sets the columns to be retrieved from database.
Public property	SelectedItemClass	Selected item class.
Public property	SelectedItemStyle	Selected item style.
Public property	SelectOnlyPublished	Property to set and get the SelectOnlyPublished flag.
Public property	ShowToolTips	Indicates if images are sets by doc type images.
Public property	SiteName	Property to set and get the SiteName.
Public property	StopProcessing	Stop processing.
Public property	SystemMode	Enable or disable system mode (ignore document show in navigation and e.g.).
Protected property	TagKey	Overrides the generation of the SPAN tag with custom tag. (Overrides TreeView.TagKey.)
Public property	TopN	Select top N rows.
Public property	TreeProvider	Tree provider instance used to access data. If no TreeProvider is assigned, a new TreeProvider instance is created.
Public property	UseItemImagesForHighlightedItem	Indicates if highlighted images is not specified, use item image if exist.
Public property	WhereCondition	Property to set and get the WhereCondition.
Public property	WordWrap	Indicates if text can be wrapped or space is replaced with non breakable space.
Public property	ZeroRowsText	Text to be shown when the control is hidden by HideControlForZeroRows.

Methods

	Name	Description
Protected method	GenerateOnClickAction	Generate onClick action for node link.
Protected method	GenerateTree	Creates the child controls collection.
Public method	GetDefaultCacheDependencies	Gets the default cache dependencies for the data source.
Protected method	GetNewTreeNode	Returns a new TreeNode object based on provided data row.
Protected method	InitControl	Ensures default data binding
Protected method	InitializeJavascript	Initialize javascript variables.
Protected method	OnInit	Init event handler (Overrides TreeView.OnInit(EventArgs).)
Protected method	OnLoad	Load event handler (Overrides HierarchicalDataBoundControl.OnLoad(EventArgs).)
Protected method	OnPreRender	OnPreRender override. (Overrides TreeView.OnPreRender(EventArgs).)
Protected method	OnTreeNodePopulate	OnTreeNodePopulate. (Overrides TreeView.OnTreeNodePopulate(TreeNodeEventArgs).)
Protected method	ProcessSubItem(TreeNode, IDataContainer)	Gets a node item and creates its subnodes.
Protected method	ProcessSubItem(TreeNode, Int32)	Gets a node item and creates its subnodes.
Public method	ReleaseContext	Releases the web part context.
Public method	ReloadData	Reload control data.
Protected method	Render	Renders the control. (Overrides WebControl.Render(HtmlTextWriter).)
Public method	SetContext	Sets the web part context.

Extension Methods

	Name	Description
Public Extension Method	AddCssClass	Adds CSS class to control. If class is already present, than adding is skipped. Class names are case sensitive. (Defined by ControlsExtensions.)
Public Extension Method	CallHandled	Calls the method handled by the exception handler. If the call doesn't succeed, the problem is reported through parent IExceptionHandler control instead of throwing unhandled exception for the entire page. Returns true, if the call succeeded, otherwise returns false. (Defined by ControlsExtensions.)
Public Extension Method	GetCssClasses	Returns all CSS classes of control. (Defined by ControlsExtensions.)
Public Extension Method	GetRenderedHTML	Returns HTML which would be rendered by control to page. (Defined by ControlsExtensions.)
Public Extension Method	GetString	Gets the string by the specified resource key (Defined by ControlsExtensions.)
Public Extension Method	HasCssClass	Checks whether the control has given CSS class. Class names are case sensitive. (Defined by ControlsExtensions.)
Public Extension Method	RemoveCssClass	Removes all occurrences. Class names are case sensitive. (Defined by ControlsExtensions.)
Public Extension Method	SetCssClasses	Sets CSS classes to the control. Current classes will be overridden. (Defined by ControlsExtensions.)