Below are the available properties complete with descriptions.
Below are the available methods, complete with parameters and descriptions.
Below are the available properties complete with descriptions.
| Property Name | Type | Description |
|---|
| VisualRoot |
Panel |
Gets the root Panel object for this control. |
| Base |
Tree |
Gets or sets the base Tree control. |
| Nodes |
ObservableCollection`1 |
Gets a collection of child nodes. |
| EnableCheckboxes |
Boolean |
Gets or sets whether the node should have a checkbox. |
| IsEditable |
Boolean |
Gets or sets whether the node text is editable. |
| ParentNode |
Node |
Gets or sets the parent node. |
| Title |
String |
Gets or sets the node text. |
| EditedTitle |
String |
Gets or sets the edited node title. |
| Icon |
String |
Gets or sets the image URL when the node is not expanded. |
| IconExpanded |
String |
Gets or sets the image URL when the node is expanded. |
| IsExpanded |
Boolean |
Gets or sets whether the node is expanded. |
| HasChildren |
Boolean |
Gets or sets whether the node has children. |
| ChildrenLoaded |
Boolean |
Gets or sets whether the child nodes have been loaded. |
| IsSelected |
Boolean |
Gets or sets whether the node is selected. |
| OverallHeight |
Double |
Gets or sets the height of the node. |
| IsChecked |
Nullable`1 |
Gets or sets the nodes checked status. |
| ChildrenInheritCheckboxVisibility |
Boolean |
Gets or sets whether child checkbox visibility setting is taken from it's parent. |
| IsContainer |
Boolean |
Gets or sets whether this node can have children. |
| Popup |
Object |
Gets or sets the popup content. |
| IsBusy |
Boolean |
Gets or sets whether this node is busy, this sets the busy animation. |
| Top |
Node |
Gets the root node. |
| TemplateApplied |
Boolean |
Gets or sets whether OnApplyTemplate() has been called. |
| IsLabel |
Boolean |
Gets or sets whether the node can be selected. |
Below are the available methods, complete with parameters and descriptions.
| Method Name | Description | Parameters |
|---|
| Sort(SortActions) |
Sorts the child nodes by the node title. |
|
| Sort(Boolean, Comparison<Node>) |
Sorts the child nodes by the node title. |
ParameterssortAll Indicates whether descendant nodes should also be sorted comparer The sort compare method |
| Find(String) |
Iterates through the this and all child nodes looking for a node with the provided terms in the title text. |
ParametersReturns: Matching collection of nodes |
| Get(String) |
Iterates through all child nodes looking for a node with the matching ID. |
ParametersReturns: A matching Node or null |
| CheckAll() |
Checks the current and all child node checked state. |
|
| Clear() |
Removes all child nodes from the tree. |
|
| ClearAllChecked() |
Clears the current and all child node checked state. |
|
| GetAllChecked() |
Gets all checked nodes. |
Parameters |
| BulkUpdateBegin() |
You can call this method when adding large numbers of child nodes, this significantly increases performance
you must call BulkInsertEnd() when you have finished adding nodes. |
|
| BulkUpdateEnd() |
This method must be called when you have finished adding nodes and have previously called BulkInsertBegin(). |
|
| Expand() |
Expands the node, firing off events to populate child nodes. |
|
| ExpandOut() |
Expands all the parent nodes of this node. |
|
| ExpandAll() |
Expands all nodes. |
|
| ExpandAll(List<Node>) |
Expands all child nodes of the provided parent nodes. |
|
| Collapse() |
Collapses the node, child nodes are hidden. |
|
| CollapseAll() |
Collapses all nodes. |
|
| Delete() |
Deletes the current node, this removes the node from the parent nodes collection. |
|
| DeleteChild(String) |
Removes an individual child node. |
Parameters |
| SelectChild(String) |
Selects a specific node. |
Parametersid The ID of the node to select |
| Refresh() |
Removes all the child nodes and calls Populate() to re-populate the node. |
|
| SwapPrevious() |
Swaps the current node instance with the node above. |
|
| SwapNext() |
Swaps the current node instance with the node below. |
|
| Previous() |
Gets the previous node. |
Parameters |
| Next() |
Gets the next node. |
Parameters |
| GetChild(String) |
Gets a node with the matching ID. |
Parameters |
| GetChild(Int32) |
Gets a node at a given index. |
Parameters |
| IndexOfPrevious() |
Returns the index of the 'previous' node. This is the node above the current node instance in the tree. |
ParametersReturns: The index of the requested node or -1 if the node could not be found |
| IndexOfNext() |
Returns the index of the 'next' node. This is the node below the current node instance in the tree. |
ParametersReturns: The index of the requested node or -1 if the node could not be found |
| IndexOfChild(String) |
Returns the index of a specific node. |
Parametersid The ID of the node to locate Returns: The index of the requested node or -1 if the node could not be found |
| SortContainersFirstCallback(Node, Node) |
Sort method for sorting by title with all containers first. |
Parameters |
| SortCallback(Node, Node) |
Sort method for sorting by title. |
Parameters |
| SortReverseContainersFirstCallback(Node, Node) |
Sort method for sorting by title. |
Parameters |
| SortReverseCallback(Node, Node) |
Sort method for sorting by title. |
Parameters |
| DisableChildUpdates() |
Disables updates to the child node collection. |
|
| EnableChildUpdates() |
This method must be called when you have finished adding nodes and have previously called BulkInsertBegin(). |
|
| OnApplyTemplate() |
This is called when the template has been bound to the control. |
|