| Name | Type | Default | Description |
|---|
| AllowDrag | bool | false | Enables drag-and-drop functionality within the current tree structure. When this option is set to 'true', users can drag items from the current tree and drop them into another tree that has the allowDrop setting enabled. This facilitates moving or copying items between compatible trees using a drag-and-drop interface. |
| AllowDrop | bool | false | Enables drag-and-drop functionality, permitting items to be dropped into this tree. The dropped items may originate from either within the current tree or from a different tree, supporting both intra-tree and inter-tree item transfers. |
| AutoHideToggleElement | bool | false | Automatically hides the tree's toggle arrow when the mouse pointer leaves the tree area, and displays the toggle arrow again when the mouse pointer enters the tree area. This provides a cleaner interface by only showing the toggle control when the user is actively interacting with the tree. |
| AutoLoadState | bool | false | Controls whether the component automatically loads its state (including filtering, sorting, expanded, and selected items) from the browser's localStorage. When enabled, any previously saved state is retrieved and applied to the component on initialization, allowing users to resume where they left off. Disabling this option prevents the component from loading state information from localStorage. |
| AutoSaveState | bool | false | Controls whether the component automatically saves its state—including filtering, sorting, expanded rows, and selected items—to the browser’s localStorage. When enabled, these settings are preserved and restored on page reload, providing a persistent user experience. |
| AutoSort | bool | true | Controls whether the tree is automatically re-sorted after changes. When autoSort is set to false, any modifications made to an already sorted tree will not trigger an automatic re-sorting; you will need to manually sort the tree to update its order. If autoSort is true, the tree will automatically re-sort itself whenever its contents are modified. |
| DataSource | IEnumerable<object> | N/A | Specifies the data source from which the Tree component will retrieve and display its hierarchical data. This property determines which dataset is loaded and rendered within the Tree structure. |
| Disabled | bool | false | Controls whether the SmartTree widget is enabled or disabled. When enabled, users can interact with the tree and perform standard operations; when disabled, all user interaction is blocked and the tree appears visually inactive. |
| DisplayLoadingIndicator | bool | false | Controls the visibility of the loading indicator, allowing you to display it when a process is in progress and hide it when the process completes. |
| DisplayMember | string | "label" | Specifies which field in the data source should be used as the label for each item—this determines the display text shown to users for every item in lists, dropdowns, or other UI elements. |
| DragFeedbackFormatFunction | object | N/A | A callback function that allows you to customize the HTML content displayed as drag feedback during a drag-and-drop operation. This function receives a single parameter: an array containing the items currently being dragged. Use this array to generate and return your custom HTML representation for the drag feedback. |
| DragOffset | int[] | new int[]{} | Specifies the pixel offset of the drag feedback element relative to the mouse cursor during a drag operation. This value is defined as an array, where the first element represents the horizontal (X-axis) offset and the second element represents the vertical (Y-axis) offset. Adjusting these values changes the position of the visual feedback element in relation to the cursor as items are being dragged. |
| DropDownMode | bool | false | |
| DropDownWidth | int | 300 | Specifies the width, in pixels, of the Tree component when it appears within a drop-down interface. Adjusting this value controls how wide the drop-down Tree is rendered, allowing for customization to fit various layouts or content requirements. |
| DropDownHeight | int | 400 | Specifies the height of the Tree component when it is rendered within a drop-down menu. Adjusting this value determines how much vertical space the Tree occupies in drop-down mode, affecting the number of visible items before scrolling is required. |
| Editable | bool | false | Controls whether an item can be edited. When enabled, users can initiate editing by double-clicking a tree item or by selecting an item and pressing F2. If disabled, editing operations for the item are prevented. |
| ExpandMode | TreeExpandMode | TreeExpandMode.Multiple | Specifies how TreeItemGroups within the Tree expand or collapse, controlling whether multiple groups can be expanded simultaneously, only one group can be expanded at a time, or all groups are collapsed by default. This setting defines the expand/collapse interaction pattern for grouped items in the Tree structure. |
| Filterable | bool | false | Controls the filtering functionality within the component. When enabled, a filter input field is displayed, allowing users to refine visible data based on their input. When disabled, the filter input is hidden, and all data items are shown without filtering options. |
| FilterOnEnter | bool | false | Triggers the filter action exclusively when the 'Enter' key is pressed, ensuring that filtering occurs only after user confirmation rather than on every input change. |
| FilterInputPlaceholder | string | "" | Defines a custom placeholder text to display within the filter input field, guiding users on what they can search or filter for. |
| FilterMember | string | "label" | Specifies which property of the TreeItem will be used as the filtering criterion. By default, the component filters using the label property of each TreeItem. You can change this behavior by setting the property to value to filter based on the value property, or to textContent to filter based on the textual content within the TreeItem. You may also specify any other valid property name to customize the filtering logic according to your data structure. This allows for flexible and precise filtering of TreeItems based on your application's requirements. |
| FilterMode | FilterMode | FilterMode.ContainsIgnoreCase | Specifies the filtering method to be applied when processing data, such as selecting between different filter types (e.g., linear, nearest, or custom). Determines how input data is modified or constrained based on the selected filter mode. |
| HasThreeStates | bool | false | Configures or retrieves whether the tree checkboxes support three distinct states: checked, unchecked, and indeterminate. This property is applicable only when the selectionMode is set to 'checkBox'. When enabled, the indeterminate state allows parent checkboxes to visually reflect that only some of their child nodes are selected. |
| ItemsMember | string | "items" | Specifies the field in the data source that contains the collection of subitems associated with each item group. This property maps the hierarchical structure by identifying where the subitems data for each group is stored, enabling the component to correctly render nested or grouped elements. |
| LoadingIndicatorPlaceholder | string | "Loading..." | Specifies a custom placeholder text to display within the loading indicator when the loadingIndicatorPosition property is set to either 'top' or 'bottom'. This allows you to personalize the message shown to users while content is loading in these positions. |
| LoadingIndicatorPosition | VerticalAlignment | VerticalAlignment.Center | Specifies the location on the screen where the loading indicator will appear, such as 'top', 'bottom', 'center', or a custom position. |
| UnlockKey | string | "" | Sets or retrieves the unlockKey value used to grant access to the product. The unlockKey acts as an authorization token or password that allows users to unlock and use the product’s features. |
| Locale | string | "en" | Sets or retrieves the current locale (language and regional settings) used by the component. This property works together with the messages property, which provides localized text and translations based on the selected locale. Use this property to display content in different languages and formats according to user preferences. |
| Messages | object | N/A | Defines or retrieves an object containing the text strings displayed by the widget, enabling customization for different languages and regions. This property is used together with the locale property to provide localization support, allowing you to easily translate or adjust interface text based on the user's language settings. |
| Overflow | Overflow | Overflow.Auto | Defines the behavior of the scrollbar—or, when 'scrollMode' is set to ''scrollButtons'', the scroll buttons—when the content exceeds the visible area of the element. This setting determines how users can navigate overflow content, such as automatically displaying scrollbars, enabling scroll buttons, or applying custom overflow handling. |
| Readonly | bool | false | If the element is set to readonly, users will be able to see its value but will not be able to modify, edit, or interact with its content in any way. The element will appear as non-editable, ensuring that its value remains unchanged by user input. |
| RightToLeft | bool | false | Specifies whether right-to-left (RTL) layout support is activated. When enabled, the user interface elements, text direction, and content flow are adjusted to accommodate languages that are read from right to left, such as Arabic or Hebrew. |
| ScrollMode | TreeScrollMode | TreeScrollMode.Scrollbar | Specifies whether to display a traditional scrollbar or to use scroll buttons for navigating content when the element’s content exceeds its visible area. This setting controls the user’s method of scrolling in overflow situations. |
| SelectedIndexes | string[] | new string[]{} | A list (array) containing the index paths of the currently selected items. Each element in the array represents the hierarchical position of a selected item within the data structure, allowing precise identification of multiple selections. |
| SelectionDisplayMode | TreeSelectionDisplayMode | TreeSelectionDisplayMode.Row | Specifies the visual style or method used to highlight selected items, such as changing their background color, border, or font style, to indicate their selection state to the user. |
| SelectionMode | TreeSelectionMode | TreeSelectionMode.One | Specifies how selections can be made within the component, such as allowing single selection, multiple selections, or no selection at all. |
| SelectionTarget | TreeSelectionTarget | TreeSelectionTarget.All | Specifies whether selection is enabled for Smart-tree-items-groups, allowing users to select one or more groups within the tree component. When set to true, group items in the SmartTree can be selected by user interaction. |
| ShowLines | bool | false | Displays or hides connector lines that visually represent the relationships between elements within a group, making it easier to understand how the elements are interconnected. |
| ShowRootLines | bool | false | Controls the visibility of connector lines between tree nodes, starting from the root node. When the 'showLines' property is set to true, lines connecting the hierarchical levels of the tree are displayed; if set to false, these lines are hidden. |
| Sort | object | N/A | Defines a user-provided function to specify custom sorting logic. This function allows you to determine how items are ordered, overriding the default sort behavior. It receives two items as arguments and should return a value indicating their sort order. |
| SortDirection | TreeSortDirection | TreeSortDirection.Asc | Specifies the sort order to be applied, allowing values of either 'ascending' (arranging items from lowest to highest) or 'descending' (arranging items from highest to lowest). |
| Sorted | bool | false | Controls whether sorting functionality is enabled or disabled for the data set. When enabled, users can sort items based on specified criteria or columns; when disabled, sorting is not available. |
| Theme | string | "" | Sets or retrieves the visual theme applied to the element, allowing you to customize its appearance (such as color scheme, style, or overall look) by selecting from predefined theme options. |
| ToggleElementPosition | Position | Position.Near | Specifies the position of the toggle element (such as an arrow) within the component, indicating where the toggle control will be displayed relative to the content (e.g., left, right, top, or bottom). |
| ToggleMode | TreeToggleMode | TreeToggleMode.Dblclick | Controls how groups within Smart-tree-items are expanded or collapsed. Specifies the toggle behavior for displaying or hiding group items in the SmartTree component. |
| Unfocusable | bool | false | Determines whether the element can receive keyboard focus. When set, the element is focusable using keyboard navigation (such as the Tab key) or scripting. This property can also be used to check the current focusable state of the element. |
| ValueMember | string | "value" | Specifies which field in the data source provides the value for each item. This property maps item values in your component or UI element to the corresponding field in your underlying data source, ensuring the correct value is referenced and displayed. |
| Name | Type | Arguments | Description |
|---|
| AddAfter | void | object item, string sibling | Inserts a new item immediately after a specified item within the same parent, making it a sibling element in the list or hierarchy.Args: object item - A smart-tree-item/smart-tree-items-group to add to the Tree,string sibling - The smart-tree-item/smart-tree-items-group (or its id or numeric path) to add the item after. |
| AddBefore | void | object item, string sibling | Inserts a new item directly before a specified existing item within the same parent, making both items siblings in the data structure.Args: object item - A smart-tree-item/smart-tree-items-group to add to the Tree,string sibling - The smart-tree-item/smart-tree-items-group (or its id or numeric path) to add the item before. |
| AddTo | void | object item, string parent | Appends a new item to the end of the specified parent item's list of children, making it the last child within the parent structure.Args: object item - A smart-tree-item/smart-tree-items-group to add to the Tree,string parent - The smart-tree-items-group (or its id or numeric path) to add the item to. |
| AddTo | void | object item | Appends a new item to the end of the specified parent item's list of children, making it the last child within the parent structure. |
| ClearSelection | void | N/A | Removes any current selections, resetting the selection state to none. This action ensures that no items remain highlighted or marked as selected. |
| CloseDropDown | void | N/A | Closes the dropdown menu when the Tree component is operating in dropdown mode, ensuring that the dropdown is dismissed upon selection or when appropriate user interactions occur. |
| CollapseAll | void | bool animation | Collapses all elements with the class smart-tree-items-group, ensuring that every expandable group within the tree component is minimized and any nested content is hidden from view. This action provides a streamlined overview of the tree by hiding detailed or child items under each group.Args: bool animation - If set to false, disables collapse animation even if animation is enabled for the element. |
| CollapseAll | void | N/A | Collapses all elements with the class smart-tree-items-group, ensuring that every expandable group within the tree component is minimized and any nested content is hidden from view. This action provides a streamlined overview of the tree by hiding detailed or child items under each group. |
| CollapseItem | void | object item, bool animation | Collapses the specified smart-tree-items-group, hiding all of its nested child items from view within the tree component. This action changes the group's state to collapsed, providing a more compact tree display by temporarily concealing its contents.Args: object item - smart-tree-items-group (or its id or numeric path).,bool animation - If set to false, disables collapse animation even if animation is enabled for the element. |
| CollapseItem | void | object item | Collapses the specified smart-tree-items-group, hiding all of its nested child items from view within the tree component. This action changes the group's state to collapsed, providing a more compact tree display by temporarily concealing its contents. |
| EnsureVisible | void | object item | Ensures that a specified item is brought into the visible area of the scrollable container by automatically scrolling the container as needed, so the item is fully or partially in view for the user.Args: object item - The id or numeric path of an item |
| ExpandAll | void | string animation | Expands all elements within the tree component that are assigned the 'smart-tree-items-group' class, making every group and its child items visible in the tree view.Args: string animation - If set to false, disables expand animation even if animation is enabled for the element. |
| ExpandAll | void | N/A | Expands all elements within the tree component that are assigned the 'smart-tree-items-group' class, making every group and its child items visible in the tree view. |
| ExpandItem | void | object item, bool animation | Expands a specific group within the SmartTree component, displaying all child items associated with the selected tree group. This action reveals the contents of a single smart-tree-items-group node, making its nested items visible to the user.Args: object item - smart-tree-items-group (or its id or numeric path).,bool animation - If set to false, disables expand animation even if animation is enabled for the element. |
| ExpandItem | void | object item | Expands a specific group within the SmartTree component, displaying all child items associated with the selected tree group. This action reveals the contents of a single smart-tree-items-group node, making its nested items visible to the user. |
| Filter | void | string filterQuery | Applies a filter to the Tree component, displaying only the nodes that match the specified criteria while hiding all others. This helps users easily find and focus on relevant items within the tree structure.Args: string filterQuery - Filter query. |
| GetDataSourceAsync() | Task<IEnumerable<object>> | 'N/A' | Gets the "DataSource" property as Task<IEnumerable<object>>. |
| GetFilter | string | N/A | Retrieves the currently active filter, including its criteria and settings, that has been applied to the data set. |
| GetItem | object | string id | Retrieves a specific item by using either its unique identifier (ID) or a numeric path value. This function supports both string-based IDs and numeric paths to locate and return the corresponding item from the collection.Args: string id - The id or numeric path of an item. |
| GetSelectedIndexesAsync() | Task<string[]> | 'N/A' | Gets the "SelectedIndexes" property as Task<string[]>. |
| GetSelectedValues | string[] | N/A | Retrieves the currently selected values from the component. If no value is explicitly set, the method returns the labels of the selected items instead. |
| GetState | object | N/A | Returns the current state of the SmartTree component, including information such as which nodes are expanded, collapsed, selected, or checked. This allows you to save or restore the tree’s structure and user interactions. |
| Insert | void | object item, string path | Inserts a specified item into the array or list at the designated index, shifting subsequent items to the right to accommodate the new element. If the given position is out of range, an error may be thrown or the item may be added at the nearest valid position, depending on implementation.Args: object item - A smart-tree-item/smart-tree-items-group (or an Object to create an item from) to add to the Tree. If an Object is passed, the available fields are "tagName" ("'smart-tree-item'" - default - or "'smart-tree-items-group'"), "disabled", "expanded" (only if "tagName" is "'smart-tree-items-group'"), "(items)" (only if "tagName" is "'smart-tree-items-group'"), "(label)", "separator", "shortcut" (only if "tagName" is "'smart-tree-item'"), and "(value)". (items), (label), and (value) have to correspond to the values of "itemsMember", "displayMember", and "valueMember" respectively.,string path - The path to insert the item at. |
| Insert | void | object item | Inserts a specified item into the array or list at the designated index, shifting subsequent items to the right to accommodate the new element. If the given position is out of range, an error may be thrown or the item may be added at the nearest valid position, depending on implementation. |
| LoadState | void | object state | Loads and restores the current state of the Tree, including expanded or collapsed branches, selected nodes, and any custom configurations. This ensures the Tree appears as it was previously saved or last interacted with.Args: object state - An object returned by one of the methods "getState" or "saveState". If a state is not passed, the method tries to load the state from the browser's localStorage. |
| LoadState | void | N/A | Loads and restores the current state of the Tree, including expanded or collapsed branches, selected nodes, and any custom configurations. This ensures the Tree appears as it was previously saved or last interacted with. |
| MoveDown | void | object item | Moves the selected item one position lower in the order among its sibling elements, placing it directly after the next sibling in the list.Args: object item - The smart-tree-item/smart-tree-items-group (or its id or numeric path) to remove. |
| MoveUp | void | object item | Moves the specified item one position higher in the list of its sibling items, effectively placing it before the previous sibling in the order.Args: object item - The smart-tree-item/smart-tree-items-group (or its id or numeric path) to remove. |
| OpenDropDown | void | N/A | Displays the dropdown menu when the Tree component is set to dropdown mode, allowing users to interact with the tree structure within a dropdown interface. |
| Refresh | void | 'N/A' | Refreshes the Blazor Component. Performs a layout of the HTML Elements and recalculates the measurements. |
| RemoveItem | void | object item | Removes a specified item from the collection or list. This operation locates the target item based on the provided identifier or criteria and deletes it from the data structure, ensuring that the collection is updated accordingly. If the item does not exist, no action is taken.Args: object item - The smart-tree-item/smart-tree-items-group (or its id or numeric path) to remove. |
| Render | void | 'N/A' | Re-renders the Blazor Component. This method will make a full re-render. |
| SaveState | object | N/A | Persists the current state of the Tree structure, including all nodes, their expanded or collapsed statuses, and any selection information, allowing the Tree to be accurately restored in future sessions. |
| Select | void | object item | Allows selection of an item either by specifying its numerical index in the list or by providing the item's unique HTMLElement ID. This enables precise targeting of elements for further operations.Args: object item - The smart-tree-item/smart-tree-items-group (or its id or numeric path) to remove. |
| SetSelectedValues | void | IEnumerable<object> items | Selects one or multiple items from a list based on their specified values. This allows you to programmatically choose which items are highlighted or marked as selected, using their corresponding value identifiers.Args: IEnumerable<object> items - The smart-tree-item/smart-tree-items-group values or labels, if values are not defined. |
| SetSelectedValues | void | string items | Selects one or multiple items from a list based on their specified values. This allows you to programmatically choose which items are highlighted or marked as selected, using their corresponding value identifiers.Args: string items - The smart-tree-item/smart-tree-items-group values or labels, if values are not defined. |
| StateHasChanged | void | 'N/A' | Refreshes the state and Re-renders the Blazor Component, if necessary. |
| Unselect | void | object item | Deselects a specified item, either by providing its numeric index in the list or by passing the item's HTMLElement ID as a string.Args: object item - The smart-tree-item/smart-tree-items-group (or its id or numeric path) to remove. |
| UnselectValues | void | IEnumerable<object> items | Deselects one or more items based on their specified values, removing them from the current selection set.Args: IEnumerable<object> items - The smart-tree-item/smart-tree-items-group values or labels, if values are not defined. |
| UnselectValues | void | string items | Deselects one or more items based on their specified values, removing them from the current selection set.Args: string items - The smart-tree-item/smart-tree-items-group values or labels, if values are not defined. |
| UpdateItem | void | object item, object newItem | Updates an existing item in the database with new values provided in the request. This operation locates the item by its unique identifier and applies the specified changes to its properties. Returns the updated item upon success.Args: object item - smart-tree-item/smart-tree-items-group (or its id or numeric path).,object newItem - An object with updated properties. |
| Name | Type | Description | Event Detail |
|---|
| OnChange | EventCallback<Event> | This event is triggered whenever the selected item(s) in the jqx-tree component change. It occurs both when a user selects a new item or deselects a previously selected item, allowing developers to execute custom logic in response to changes in the tree's selection state. | dynamic item- The item the user has interacted with to change the selection (only when applicable)., IEnumerable<string> oldSelectedIndexes- The selected indexes before the selection is changed., IEnumerable<string> selectedIndexes- The selected indexes after the selection is changed. |
| Changed | event TreeChangedEventHandler | This event is triggered whenever the selected item(s) in the jqx-tree component change. It occurs both when a user selects a new item or deselects a previously selected item, allowing developers to execute custom logic in response to changes in the tree's selection state. | TreeChangedEventArgs |
| OnCollapse | EventCallback<Event> | This event is triggered whenever a jqx-tree-items-group component is collapsed by the user. It occurs immediately after the group transitions from an expanded (open) state to a collapsed (closed) state, allowing you to execute custom logic in response to this action. | dynamic item- the collapsed jqx-tree-items-group, string label- the label of the collapsed jqx-tree-items-group, dynamic path- the path of the collapsed jqx-tree-items-group, dynamic value- the value of the collapsed jqx-tree-items-group, dynamic children- the children of the collapsed jqx-tree-items-group |
| Collapsed | event TreeCollapsedEventHandler | This event is triggered whenever a jqx-tree-items-group component is collapsed by the user. It occurs immediately after the group transitions from an expanded (open) state to a collapsed (closed) state, allowing you to execute custom logic in response to this action. | TreeCollapsedEventArgs |
| OnCollapsing | EventCallback<Event> | This event fires immediately before a jqx-tree-items-group collapses, providing an opportunity to intercept the action. Within the event handler, you can call event.preventDefault() to cancel the collapsing operation, preventing the group from being closed. This allows developers to implement custom logic—such as confirmation dialogs or validation checks—prior to the group’s collapse. | dynamic item- the jqx-tree-items-group to be collapsed, string label- the label of the jqx-tree-items-group to be collapsed, dynamic path- the path of the jqx-tree-items-group to be collapsed, dynamic value- the value of the jqx-tree-items-group to be collapsed, dynamic children- the children of the jqx-tree-items-group to be collapsed |
| Collapsing | event TreeCollapsingEventHandler | This event fires immediately before a jqx-tree-items-group collapses, providing an opportunity to intercept the action. Within the event handler, you can call event.preventDefault() to cancel the collapsing operation, preventing the group from being closed. This allows developers to implement custom logic—such as confirmation dialogs or validation checks—prior to the group’s collapse. | TreeCollapsingEventArgs |
| OnDragEnd | EventCallback<Event> | This event is triggered when a jqx-tree-item or jqx-tree-items-group element is dropped onto a target location within the DOM during a drag-and-drop operation. You can prevent the drop action from completing—effectively canceling the move—by calling event.preventDefault() within your event handler function. This allows you to implement custom logic to determine whether the drop should be allowed or denied. | dynamic container- the tree the dragged item(s) is dropped to, dynamic data- an object with additional drag details, dynamic item- the item that is dragged; if multiple items are dragged, this is the item that has been clicked when initiating the drag operation, dynamic items- an array with all dragged items, dynamic originalEvent- the original, browser, event that initiates the drop operation, dynamic previousContainer- the tree the dragged item(s) is dragged from, dynamic target- the element the dragged items are dropped to |
| DragEnded | event TreeDragEndedEventHandler | This event is triggered when a jqx-tree-item or jqx-tree-items-group element is dropped onto a target location within the DOM during a drag-and-drop operation. You can prevent the drop action from completing—effectively canceling the move—by calling event.preventDefault() within your event handler function. This allows you to implement custom logic to determine whether the drop should be allowed or denied. | TreeDragEndedEventArgs |
| OnDragging | EventCallback<Event> | This event is triggered when a jqx-tree-item or jqx-tree-items-group component starts being dragged by the user. It occurs at the moment the drag operation begins, allowing you to implement custom logic or UI feedback during the drag-and-drop interaction within the jqxTree widget. | dynamic data- an object with additional drag details, dynamic item- the item that is dragged; if multiple items are dragged, this is the item that has been clicked when initiating the drag operation, dynamic items- an array with all dragged items, dynamic originalEvent- the original, browser, event that initiates the dragging operation |
| Dragging | event TreeDraggingEventHandler | This event is triggered when a jqx-tree-item or jqx-tree-items-group component starts being dragged by the user. It occurs at the moment the drag operation begins, allowing you to implement custom logic or UI feedback during the drag-and-drop interaction within the jqxTree widget. | TreeDraggingEventArgs |
| OnDragStart | EventCallback<Event> | This event is fired when a drag operation begins within the jqx-tree component. It allows you to intercept the initiation of the drag action. By invoking event.preventDefault() within your event handler, you can cancel the drag operation before it proceeds. This provides an opportunity to implement custom logic, such as conditional validations or user permissions, before allowing or preventing the drag from taking place. | dynamic container- the tree the dragged item(s) is dragged from, dynamic data- an object with additional drag details, dynamic item- the item that is dragged; if multiple items are dragged, this is the item that has been clicked when initiating the drag operation, dynamic items- an array with all dragged items, dynamic originalEvent- the original, browser, event that initiates the drag operation, dynamic previousContainer- the tree the dragged item(s) is dragged from |
| DragStarted | event TreeDragStartedEventHandler | This event is fired when a drag operation begins within the jqx-tree component. It allows you to intercept the initiation of the drag action. By invoking event.preventDefault() within your event handler, you can cancel the drag operation before it proceeds. This provides an opportunity to implement custom logic, such as conditional validations or user permissions, before allowing or preventing the drag from taking place. | TreeDragStartedEventArgs |
| OnExpand | EventCallback<Event> | This event is triggered when a `jqx-tree-items-group` element within the tree is expanded by the user, either through a mouse click or keyboard interaction. It allows developers to execute custom logic in response to the expansion of a specific group of items within the jqxTree component. | dynamic item- the expanded jqx-tree-items-group, string label- the label of the expanded jqx-tree-items-group, dynamic path- the path of the expanded jqx-tree-items-group, dynamic value- the value of the expanded jqx-tree-items-group, dynamic children- the children of the expanded jqx-tree-items-group |
| Expanded | event TreeExpandedEventHandler | This event is triggered when a `jqx-tree-items-group` element within the tree is expanded by the user, either through a mouse click or keyboard interaction. It allows developers to execute custom logic in response to the expansion of a specific group of items within the jqxTree component. | TreeExpandedEventArgs |
| OnExpanding | EventCallback<Event> | This event is fired just before a jqx-tree-items-group is expanded. At this stage, the expansion process has not yet occurred, allowing you to perform custom logic or checks. If you want to prevent the group from expanding, call event.preventDefault() within your event handler; this will cancel the default expand action. | dynamic item- the jqx-tree-items-group to be expanded, string label- the label of the jqx-tree-items-group to be expanded, dynamic path- the path of the jqx-tree-items-group to be expanded, dynamic value- the value of the jqx-tree-items-group to be expanded, dynamic children- the children of the jqx-tree-items-group to be expanded |
| Expanding | event TreeExpandingEventHandler | This event is fired just before a jqx-tree-items-group is expanded. At this stage, the expansion process has not yet occurred, allowing you to perform custom logic or checks. If you want to prevent the group from expanding, call event.preventDefault() within your event handler; this will cancel the default expand action. | TreeExpandingEventArgs |
| OnFilterChange | EventCallback<Event> | This event is triggered whenever the selected item in the jqx-tree component changes. It occurs after a user selects a different tree node, either through mouse interaction or keyboard navigation, allowing you to respond to selection changes within the tree. | dynamic value- The filter input value. |
| FilterChanged | event TreeFilterChangedEventHandler | This event is triggered whenever the selected item in the jqx-tree component changes. It occurs after a user selects a different tree node, either through mouse interaction or keyboard navigation, allowing you to respond to selection changes within the tree. | TreeFilterChangedEventArgs |
| OnOpen | EventCallback<Event> | This event is triggered each time the dropdown menu becomes visible to the user, such as when the user clicks on the dropdown or focuses on the dropdown field, causing the options list to appear. Use this event to perform actions whenever the dropdown is opened, such as loading options dynamically or tracking user interactions. | N/A |
| Opened | event TreeOpenedEventHandler | This event is triggered each time the dropdown menu becomes visible to the user, such as when the user clicks on the dropdown or focuses on the dropdown field, causing the options list to appear. Use this event to perform actions whenever the dropdown is opened, such as loading options dynamically or tracking user interactions. | TreeOpenedEventArgs |
| OnClose | EventCallback<Event> | This event is triggered whenever the dropdown menu is closed, either by user interaction (such as clicking outside the dropdown or selecting an option) or programmatically through the application logic. Use this event to execute any cleanup tasks or update UI elements that depend on the dropdown’s visibility state. | N/A |
| Closed | event TreeClosedEventHandler | This event is triggered whenever the dropdown menu is closed, either by user interaction (such as clicking outside the dropdown or selecting an option) or programmatically through the application logic. Use this event to execute any cleanup tasks or update UI elements that depend on the dropdown’s visibility state. | TreeClosedEventArgs |
| OnScrollBottomReached | EventCallback<Event> | This event is triggered when the user scrolls the Tree component all the way to its bottom edge, indicating that the last visible item in the Tree is fully displayed. You can use this event to implement features such as infinite scrolling, lazy loading, or displaying additional content as the user reaches the end of the Tree. | N/A |
| ScrollBottomReached | event TreeScrollBottomReachedEventHandler | This event is triggered when the user scrolls the Tree component all the way to its bottom edge, indicating that the last visible item in the Tree is fully displayed. You can use this event to implement features such as infinite scrolling, lazy loading, or displaying additional content as the user reaches the end of the Tree. | TreeScrollBottomReachedEventArgs |
| OnScrollTopReached | EventCallback<Event> | This event is triggered when the user scrolls the Tree component and reaches the very topmost position, indicating that no more content is available above within the scrollable area. | N/A |
| ScrollTopReached | event TreeScrollTopReachedEventHandler | This event is triggered when the user scrolls the Tree component and reaches the very topmost position, indicating that no more content is available above within the scrollable area. | TreeScrollTopReachedEventArgs |
| OnSwipeleft | EventCallback<Event> | This event is triggered when the user performs a leftward swipe gesture within the Tree component. It detects when the user places their finger or cursor on the Tree and moves it horizontally to the left, allowing you to handle custom interactions or navigation in response to this action. | N/A |
| SwipedLeft | event TreeSwipedLeftEventHandler | This event is triggered when the user performs a leftward swipe gesture within the Tree component. It detects when the user places their finger or cursor on the Tree and moves it horizontally to the left, allowing you to handle custom interactions or navigation in response to this action. | TreeSwipedLeftEventArgs |
| OnSwiperight | EventCallback<Event> | This event is triggered when the user performs a rightward swipe gesture within the Tree component. It detects when a swipe action starts inside the Tree and moves in the right direction, allowing developers to implement custom behaviors in response to this specific user interaction. | N/A |
| SwipeRight | event TreeSwipeRightEventHandler | This event is triggered when the user performs a rightward swipe gesture within the Tree component. It detects when a swipe action starts inside the Tree and moves in the right direction, allowing developers to implement custom behaviors in response to this specific user interaction. | TreeSwipeRightEventArgs |