Click or drag to resize
CMSTreeView Class
CMSTreeView class.
Inheritance Hierarchy
SystemObject
  System.Web.UIControl
    System.Web.UI.WebControlsWebControl
      System.Web.UI.WebControlsBaseDataBoundControl
        System.Web.UI.WebControlsHierarchicalDataBoundControl
          System.Web.UI.WebControlsTreeView
            CMS.DocumentEngine.Web.UICMSTreeView

Namespace: CMS.DocumentEngine.Web.UI
Assembly: CMS.DocumentEngine.Web.UI (in CMS.DocumentEngine.Web.UI.dll) Version: 13.0.131
Syntax
C#
public class CMSTreeView : TreeView

The CMSTreeView type exposes the following members.

Constructors
  NameDescription
Public methodCMSTreeView
Constructor.
Top
Fields
  NameDescription
Protected fieldmFilterControl
Filter control.
Protected fieldmFilterName
Filter name.
Protected fieldmProperties
Menu properties variable.
Top
Properties
  NameDescription
Public propertyCacheDependencies
Cache dependencies, each cache dependency on a new line.
Public propertyCacheItemName
Name of the cache item the control will use.
Public propertyCacheMinutes
Number of minutes the retrieved content is cached for. Zero indicates that the content will not be cached.
Public propertyCheckPermissions
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 propertyClassNames
Property to set and get the classnames list (separated by the semicolon).
Public propertyColumns
Gets or sets the columns to be retrieved from database.
Public propertyCombineWithDefaultCulture
Property to set and get the CombineWithDefaultCulture flag.
Public propertyControlContext
Control context.
Public propertyCSSPrefix
Specifies prefix of standard CMSMenu CSS classes. You can also use several values separated with semicolon (;) for particular levels.
Public propertyCultureCode
Property to set and get the CultureCode.
Public propertyDataSource
Gets or sets a DataSet containing values used to populate the items within the control. This value needn't be set.
Public propertyDisplayDocumentTypeImages
Indicates if images are sets by doc type images.
Public propertyDynamicBehavior
Enable populate on demand and load child nodes dynamically.
Public propertyEncodeMenuCaption
Indicates if menu caption should be HTML encoded.
Public propertyExpandAllOnStartup
Expand all nodes in tree.
Public propertyExpandCurrentPath
If it is true, treeview will expand all items to the current item.
Public propertyExpandSubTree
Gets or sets the value that indicates whether subtree under current item is expanded.
Public propertyFilterControl
Filter control.
Public propertyFilterName
Gets or Set filter name.
Public propertyFixBrokenLines
Fix broken lines.
Protected propertyGroupedDS
Grouped data source.
Public propertyHideControlForZeroRows
Hides the control when no data is loaded. Default value is False.
Public propertyHideRootNode
Gets or sets the value that indicates whether root node is hidden.
Public propertyHiglightSelectedItem
Indicates if selected item is highlighted.
Public propertyIgnoreDocumentMenuAction
Ignore document menu action.
Public propertyInactivateAllItemsInPath
Inactivate all items in path.
Public propertyInactivateSelectedItem
Inactivate selected item.
Public propertyInactiveItemClass
Inactive item class.
Public propertyInactiveItemStyle
Inactive item style.
Public propertyInactiveNodeImage
Indicates if node image is inactive.
Public propertyInactiveRoot
If it is true, root node is not active.
Public propertyItemClass
Item class.
Public propertyItemStyle
Item style.
Public propertyJSoriginalClass
Original item class.
Public propertyJSoriginalStyle
Original item style.
Public propertyJSselectedClass
Selected item class.
Public propertyJSselectedObject
Selected object.
Public propertyJSselectedStyle
Selected item style.
Public propertyLocalResolver
Local instance of macro resolver.
Public propertyMaxRelativeLevel
Property to set and get the MaxRelativeLevel.
Public propertyNodeImageUrl
Sets or Get images for every node.
Public propertyOnClickAction
Sets or Get onclick javascript action.
Public propertyOrderBy
Property to set and get the OrderBy.
Public propertyPath
Property to set and get the Path.
Public propertyRootImageUrl
If RootImageUrl is set to the some value, this image will be displayed for the root node.
Public propertyRootText
If RootText is set to the some value, this value replace normal root node text.
Public propertySelectedColumns
Gets or sets the columns to be retrieved from database.
Public propertySelectedItemClass
Selected item class.
Public propertySelectedItemStyle
Selected item style.
Public propertySelectOnlyPublished
Property to set and get the SelectOnlyPublished flag.
Public propertyShowToolTips
Indicates if images are sets by doc type images.
Public propertySiteName
Property to set and get the SiteName.
Public propertyStopProcessing
Stop processing.
Public propertySystemMode
Enable or disable system mode (ignore document show in navigation and e.g.).
Protected propertyTagKey
Overrides the generation of the SPAN tag with custom tag.
(Overrides TreeViewTagKey.)
Public propertyTopN
Select top N rows.
Public propertyTreeProvider
Tree provider instance used to access data. If no TreeProvider is assigned, a new TreeProvider instance is created.
Public propertyUseItemImagesForHighlightedItem
Indicates if highlighted images is not specified, use item image if exist.
Public propertyWhereCondition
Property to set and get the WhereCondition.
Public propertyWordWrap
Indicates if text can be wrapped or space is replaced with non breakable space.
Public propertyZeroRowsText
Text to be shown when the control is hidden by HideControlForZeroRows.
Top
Methods
  NameDescription
Protected methodGenerateOnClickAction
Generate onClick action for node link.
Protected methodGenerateTree
Creates the child controls collection.
Public methodGetDefaultCacheDependencies
Gets the default cache dependencies for the data source.
Protected methodGetNewTreeNode
Returns a new TreeNode object based on provided data row.
Protected methodInitControl
Ensures default data binding
Protected methodInitializeJavascript
Initialize javascript variables.
Protected methodOnInit
Init event handler
(Overrides TreeViewOnInit(EventArgs).)
Protected methodOnLoad
Load event handler
(Overrides HierarchicalDataBoundControlOnLoad(EventArgs).)
Protected methodOnPreRender
OnPreRender override.
(Overrides TreeViewOnPreRender(EventArgs).)
Protected methodOnTreeNodePopulate
OnTreeNodePopulate.
(Overrides TreeViewOnTreeNodePopulate(TreeNodeEventArgs).)
Protected methodProcessSubItem(TreeNode, IDataContainer)
Gets a node item and creates its subnodes.
Protected methodProcessSubItem(TreeNode, Int32)
Gets a node item and creates its subnodes.
Public methodReleaseContext
Releases the web part context.
Public methodReloadData
Reload control data.
Protected methodRender
Renders the control.
(Overrides WebControlRender(HtmlTextWriter).)
Public methodSetContext
Sets the web part context.
Top
Extension Methods
  NameDescription
Public Extension MethodAddCssClass
Adds CSS class to control. If class is already present, than adding is skipped. Class names are case sensitive.
(Defined by ControlsExtensions.)
Public Extension MethodCallHandled
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 MethodGetCssClasses
Returns all CSS classes of control.
(Defined by ControlsExtensions.)
Public Extension MethodGetRenderedHTML
Returns HTML which would be rendered by control to page.
(Defined by ControlsExtensions.)
Public Extension MethodGetString
Gets the string by the specified resource key
(Defined by ControlsExtensions.)
Public Extension MethodHasCssClass
Checks whether the control has given CSS class. Class names are case sensitive.
(Defined by ControlsExtensions.)
Public Extension MethodRemoveCssClass
Removes all occurrences. Class names are case sensitive.
(Defined by ControlsExtensions.)
Public Extension MethodSetCssClasses
Sets CSS classes to the control. Current classes will be overridden.
(Defined by ControlsExtensions.)
Top
See Also