KaxTreeView Class |
Namespace: Kettic.AspNet.Controls
The KaxTreeView type exposes the following members.
Name | Description | |
---|---|---|
KaxTreeView |
Initializes a new instance of the KaxTreeView class.
|
Name | Description | |
---|---|---|
CheckAllNodes |
Checks all nodes of the current KaxTreeView object.
| |
ClearCheckedNodes | Obsolete. | |
ClearSelectedNodes | Obsolete. | |
CollapseAllNodes |
Collapses all nodes in the tree.
| |
ExpandAllNodes |
Expands all nodes in the tree.
| |
FindNode |
Returns the first KaxTreeNode
that matches the conditions defined by the specified predicate.
The predicate should returns a boolean value.
| |
FindNodeByAttribute |
Searches all nodes for a KaxTreeNode which contains the specified attribute and attribute value.
| |
FindNodeByText(String) |
Searches all nodes for a KaxTreeNode with a Text property
equal to the specified text.
| |
FindNodeByText(String, Boolean) |
Searches all nodes for a KaxTreeNode with a Text property
equal to the specified text.
| |
FindNodeByUrl |
Searches all nodes for a KaxTreeNode with a NavigateUrl property
equal to the specified URL.
| |
FindNodeByValue(String) |
Searches all nodes for a KaxTreeNode with a Value property
equal to the specified value.
| |
FindNodeByValue(String, Boolean) |
Searches all nodes for a KaxTreeNode with a Value property
equal to the specified value.
| |
GetAllNodes |
Gets a linear list of all nodes in the KaxTreeView control.
| |
LoadContentFile |
Populates the control from the specified XML file.
(Overrides HierarchicalControlItemContainerLoadContentFile(String).) | |
LoadXmlString |
Loads the control from an XML string. Identical to LoadXml.
| |
UncheckAllNodes |
This method unchecks all nodes of the current KaxTreeView instance. Useful when you need to uncheck all nodes after postback.
| |
UnselectAllNodes |
This method unselects all nodes of the current KaxTreeView instance. Useful when you need to clear node selection after postback.
|
Name | Description | |
---|---|---|
AllowNodeEditing |
Gets a value indicating whether the text of the tree nodes are edinodele in the
browser.
| |
CheckBoxes |
When set to true displays a checkbox next to each treenode.
| |
CheckChildNodes |
Gets or sets a value indicating whether checking (unchecking) a node will check (uncheck) its child nodes.
| |
CheckedNodes |
Gets a collection of KaxTreeNode objects that represent the nodes in the control
that display a selected check box.
| |
ClientChanges |
Gets a list of all client-side changes (adding a node, removing a node, changing a node's property) which have occurred.
| |
CollapseAnimation | Gets the settings for the animation played when a node closes. | |
ContextMenus |
Gets a collection of KaxTreeViewContextMenu objects
that represent the context menus of a KaxTreeView control.
| |
DataBindings |
Gets a collection of KaxTreeNodeBindingCollection objects that define the relationship
between a data item and the tree node it is binding to.
| |
EnableAriaSupport |
When set to true enables support for WAI-ARIA
| |
EnableDragAndDrop |
When set to true enables drag-and-drop functionality
| |
EnableDragAndDropBetweenNodes |
When set to true enables drag-and-drop visual clue (underline) between nodes while draggin
| |
ExpandAnimation | Gets the settings for the animation played when a node opens. | |
IsEmpty | Gets a value indicating whether the KaxTreeView control has no nodes. | |
LoadingMessage |
Gets or sets the loading message that is displayed when child nodes are retrieved
on AJAX calls.
| |
LoadingStatusPosition |
Gets or sets the position of the loading message when child nodes are retrieved
on AJAX calls.
| |
LoadingStatusTemplate | ||
MaxDataBindDepth |
Gets or sets the maximum number of levels to bind to the KaxTreeView control.
(Overrides HierarchicalControlItemContainerMaxDataBindDepth.) | |
MultipleSelect |
When set to true the treeview allows multiple node selection (by holding down ctrl key while selecting nodes)
| |
Nodes |
Gets a KaxTreeNodeCollection object that contains the root nodes of the current KaxTreeView control.
| |
NodeTemplate | Gets or sets the template for displaying all node in the current KaxTreeView. | |
OnClientContextMenuItemClicked |
The name of the JavaScript function that will be called after the user clicks on a context menu item.
| |
OnClientContextMenuItemClicking |
The name of the JavaScript function that will be called when the user clicks on a context menu item.
| |
OnClientContextMenuShowing |
The name of the JavaScript function that will be called when a context menu is to be displayed.
| |
OnClientContextMenuShown |
The name of the JavaScript function that will be called after context menu is displayed.
| |
OnClientDoubleClick |
The name of the JavaScript function that will be called when the user double clicks on a node.
| |
OnClientKeyPressing |
The name of the JavaScript function that will be called when a key is pressed.
| |
OnClientLoad |
Gets or sets the name of the JavaScript function called when the control is fully
initialized on the client side.
| |
OnClientMouseOut |
The name of the JavaScript function that will be called when the mouse hovers away from the TreeView.
| |
OnClientMouseOver |
The name of the JavaScript function that will be called when the user highlights a treenode.
| |
OnClientNodeAnimationEnd |
Gets or sets the name of the JavaScript function called when a node's expand/collapse animation finishes
| |
OnClientNodeChecked |
The name of the JavaScript function that will be called after the user checks (checkbox) a treenode.
| |
OnClientNodeChecking |
The name of the JavaScript function that will be called when the user checks (checkbox) a treenode.
| |
OnClientNodeClicked |
The name of the JavaScript function that will be called after click on a treenode. Used for AJAX/callback hooks.
| |
OnClientNodeClicking |
The name of the JavaScript function that will be called upon click on a treenode. The function must accept a single parameter which is the instance of the node clicked.
For example if you define OnClientClick="ProcessClientClick", you must define a javascript function defined in the following way (example): function ProcessClientClick(node) { alert("You clicked on: " + node.Text); } | |
OnClientNodeCollapsed |
The name of the JavaScript function that will be called after a node is collapsed.
| |
OnClientNodeCollapsing |
The name of the JavaScript function that will be called before a node is collapsed.
| |
OnClientNodeDataBound |
Gets or sets the name of the JavaScript function called when a node is databound during load on demand
| |
OnClientNodeDragging |
The name of the JavaScript function that will be called when the user moves the mouse while dragging a node.
| |
OnClientNodeDragStart |
The name of the JavaScript function that will be called when the user starts dragging a node.
| |
OnClientNodeDropped |
The name of the JavaScript function that will be called after the user drops a node onto another node.
| |
OnClientNodeDropping |
The name of the JavaScript function that will be called when the user drops a node onto another node.
| |
OnClientNodeEdited |
The name of the JavaScript function that will be called after the user edits a node
| |
OnClientNodeEditing |
The name of the JavaScript function that will be called before the user edits a node
| |
OnClientNodeEditStart |
Gets or sets the name of the JavaScript function called when a node starts being edited
| |
OnClientNodeExpanded |
The name of the JavaScript function that will be called after a node is expanded.
| |
OnClientNodeExpanding |
The name of the JavaScript function that will be called before a node is expanded.
| |
OnClientNodePopulated |
Gets or sets a value indicating the client-side event handler that is called when
the children of a tree node were just populated (for example from web service).
| |
OnClientNodePopulating |
Gets or sets a value indicating the client-side event handler that is called when
the children of a tree node are about to be populated (for example from web service).
| |
OnClientNodePopulationFailed |
Gets or sets a value indicating the client-side event handler that is called when
the operation for populating the children of a tree node has failed.
| |
PersistLoadOnDemandNodes |
When set to true, the nodes populated through Load On Demand are persisted on the server.
| |
PostBackUrl |
Gets or sets the URL of the page to post to from the current page when a tree node is clicked.
(Overrides ControlItemContainerPostBackUrl.) | |
SelectedNode |
Gets a KaxTreeNode object that represents the selected node in the KaxTreeView
control.
| |
SelectedNodes |
Gets a collection of KaxTreeNode objects that represent the nodes in the control
that are currently selected.
| |
SelectedValue |
Gets the Value of the selected node.
| |
ShowLineImages |
Gets a value indicating whether the dotted lines indenting the nodes should be
displayed or not.
| |
SingleExpandPath |
Gets a value indicating whether only the current branch of the treeview is
expanded.
| |
TriStateCheckBoxes |
Gets or sets a value indicating whether KaxTreeView should display tri-state checkboxes.
| |
UniqueID | (Overrides ControlUniqueID.) | |
WebServiceSettings |
Gets the settings for the web service used to populate nodes when
ExpandMode set to
TreeNodeExpandMode.WebService.
|
Name | Description | |
---|---|---|
ContextMenuItemClick |
Occurs on the server when a item in the KaxTreeViewContextMenu is clicked.
| |
NodeCheck |
Occurs when a node is checked.
| |
NodeClick |
Occurs on the server when a node in the KaxTreeView
control is clicked.
| |
NodeCollapse |
Occurs when a node is collapsed.
| |
NodeCreated | Occurs when a node is created. | |
NodeDataBound | Occurs when a node is data bound. | |
NodeDrop |
Occurs when a node (or nodes) is dragged and dropped.
| |
NodeEdit |
Occurs when a node's text is edited.
| |
NodeExpand |
Occurs when a node is expanded.
| |
TemplateNeeded | Occurs before template is being applied to the node. |
The KaxTreeView control is used to display a list of nodes in a Web Forms page. The KaxTreeView control supports the following features:
The KaxTreeView control is made up of tree of nodes represented by KaxTreeNode objects. Nodes at the top level (level 0) are called root nodes. An node that has a parent node is called a child node. All root nodes are stored in the Nodes property of the KaxTreeView control. Child nodes are stored in the Nodes property of their parent KaxTreeNode.
Each node has a Text and a Value property. The value of the Text property is displayed in the KaxTreeView control, while the Value property is used to store any additional data about the node, such as data passed to the postback event associated with the node. When clicked, a node can navigate to another Web page indicated by the NavigateUrl property.