TreeListView Events
A View that displays information in a tree hierarchical structure.Name | Description |
---|---|
AddingNewNode | Occurs before a new node is added to the GridControl and allows you to initialize the new record. |
BeforeLayoutRefresh | Enables you to lock down end-user capabilities that affect the onscreen position of the focused row (moving row focus, row scrolling, filtering, sorting, etc.). Inherited from DataViewBase. |
CanSelectCell | Occurs in multiple cell selection mode when a user tries to select a cell and allows you to prevent the cell selection. |
CanSelectRow | Occurs in multiple row select mode when an end-user tries to select a grid row (node) and allows you to prevent selecting a particular row (node). Inherited from DataViewBase. |
CanUnselectCell | Occurs in multiple cell selection mode when a user tries to unselect a cell and allows you to prevent this operation for a particular cell. |
CanUnselectRow | Occurs in multiple row select mode when an end-user tries to unselect a grid row (node) and allows you to prevent unselecting a particular row (node). Inherited from DataViewBase. |
CellValueChanged | Occurs when a cell value is changed. |
CellValueChanging | Occurs when a user edits a cell value (for example, types or deletes a character, chooses a value from the drop-down list). |
ClipboardNodeCopying | Fires before a data row, group row, column headers, or band headers are copied to the clipboard. Allows you to apply a format, change the copied data, or skip a data row or header. |
ClipboardRowCellValuePasting | Fires when an end-user pastes a cell to the TreeListView and allows you to process the pasted data. |
ClipboardRowPasting | Fires when an end-user pastes a node to the TreeListView and allows you to process the pasted data. |
ColumnHeaderClick | Occurs when a column header is clicked. Inherited from DataViewBase. |
CompleteRecordDragDrop | Occurs when a drag-and-drop operation is completed. Inherited from DataViewBase. |
ContextMenuClosing | Occurs just before any context menu on the element is closed. Inherited from FrameworkElement. |
ContextMenuOpening | Occurs when any context menu on the element is opened. Inherited from FrameworkElement. |
ContinueRecordDrag | Occurs when there is a change in the keyboard or mouse button states during a drag-and-drop operation, and enables the drop source to cancel the drag-and-drop operation depending on the key/button states. Inherited from DataViewBase. |
CopyingToClipboard | Obsolete. Occurs when data is copied to the clipboard, allowing you to manually copy required data. |
CreateRootNodeCompleted | Inherited from DataViewBase. |
CustomBestFit | Allows you to manually calculate the optimal width for a column(s). |
CustomCellAppearance | Allows overriding the cell’s foreground and background settings. |
CustomColumnDisplayText | Allows you to customize a data cell‘s display text. |
CustomColumnSort | Enables you to sort data using custom rules. |
CustomDataUpdateFormatCondition | Allows defining a custom logic of conditional formatting of the changed grid cells (rows). |
CustomFilterDisplayText | Allows you to display custom text instead of a filter expression in the legacy Filter Panel. Inherited from DataViewBase. |
CustomFilterPopupList | Allows you to filter values displayed in a column Drop-down Filter. |
CustomNodeFilter | Allows you to use custom rules to filter nodes. |
CustomRowAppearance | Allows overriding the row’s foreground and background settings. |
CustomScrollAnimation | Enables you to provide custom animation played when grid data is vertically scrolled (per-pixel). |
CustomSummary | Enables you to calculate summary values manually. |
CustomUnboundColumnData | Allows you to populate unbound columns with data. |
DataContextChanged | Occurs when the data context for this element changes. Inherited from FrameworkElement. |
DataSourceRefresh |
Occurs before the data source is refreshed (a user presses F5 or executes the RefreshDataSource command) and allows you to implement custom refresh logic.
Inherited from DataViewBase. |
DragEnter | Occurs when the input system reports an underlying drag event with this element as the drag target. Inherited from UIElement. |
DragLeave | Occurs when the input system reports an underlying drag event with this element as the drag origin. Inherited from UIElement. |
DragOver | Occurs when the input system reports an underlying drag event with this element as the potential drop target. Inherited from UIElement. |
DragRecordOver | Occurs continuously while a record is dragged (moved) within the drop target’s boundary. Inherited from DataViewBase. |
Drop | Occurs when the input system reports an underlying drop event with this element as the drop target. Inherited from UIElement. |
DropRecord | Occurs when a record is dropped on the drop target element. Inherited from DataViewBase. |
EditFormShowing | Occurs when the TreeListView is about to display the Edit Form. |
EndSorting | Occurs after a sorting operation has been completed. |
FilterEditorCreated | Fires after the embedded FilterControl has been created. This event is not fired for the new FilterEditorControl. Inherited from DataViewBase. |
FocusableChanged | Occurs when the value of the Focusable property changes. Inherited from UIElement. |
FocusedColumnChanged | Obsolete. Occurs after the focused column has been changed. Inherited from DataViewBase. |
FocusedRowChanged | Obsolete. Occurs after the focused row has been changed. Inherited from DataViewBase. |
FocusedRowHandleChanged | Occurs after the focused row’s handle has been changed. Inherited from DataViewBase. |
FocusedRowHandleChanging | Occurs when the focused row handle is about to change. Inherited from DataViewBase. |
FocusedViewChanged | Occurs after the active View has been changed. Inherited from DataViewBase. |
GetActiveEditorNeedsKey | Allows you to specify whether an active editor responds to keys that a user presses. Inherited from DataViewBase. |
GetIsEditorActivationAction | Allows you to specify whether an action (key down, text input, or mouse left button click) activates the focused editor. Inherited from DataViewBase. |
GiveFeedback | Occurs when the input system reports an underlying drag-and-drop event that involves this element. Inherited from UIElement. |
GiveRecordDragFeedback | Occurs continuously while a drag-and-drop operation is in progress, and enables the drag source to give feedback to the user. Inherited from DataViewBase. |
GotFocus | Occurs when this element gets logical focus. Inherited from UIElement. |
GotKeyboardFocus | Occurs when the keyboard is focused on this element. Inherited from UIElement. |
GotMouseCapture | Occurs when this element captures the mouse. Inherited from UIElement. |
GotStylusCapture | Occurs when this element captures the stylus. Inherited from UIElement. |
GotTouchCapture | Occurs when a touch is captured to this element. Inherited from UIElement. |
HiddenColumnChooser | Occurs after the Column Chooser has been hidden. Inherited from DataViewBase. |
HiddenEditor | Occurs after a cell’s editor has been closed. |
Initialized |
Occurs when this FrameworkElement is initialized. This event coincides with cases where the value of the IsInitialized property changes from false (or undefined) to true .
Inherited from FrameworkElement. |
InitNewNode | Allows you to initialize a new node with default values. |
InitNewRow | Obsolete. Allows you to initialize a new row with default values. |
InvalidNodeException | Occurs when a node fails validation or cannot be saved to a data source. |
IsEnabledChanged | Occurs when the value of the IsEnabled property on this element changes. Inherited from UIElement. |
IsHitTestVisibleChanged | Occurs when the value of the IsHitTestVisible dependency property changes on this element. Inherited from UIElement. |
IsKeyboardFocusedChanged | Occurs when the value of the IsKeyboardFocused property changes on this element. Inherited from UIElement. |
IsKeyboardFocusWithinChanged | Occurs when the value of the IsKeyboardFocusWithin property changes on this element. Inherited from UIElement. |
IsMouseCapturedChanged | Occurs when the value of the IsMouseCaptured property changes on this element. Inherited from UIElement. |
IsMouseCaptureWithinChanged | Occurs when the value of the IsMouseCaptureWithinProperty changes on this element. Inherited from UIElement. |
IsMouseDirectlyOverChanged | Occurs when the value of the IsMouseDirectlyOver property changes on this element. Inherited from UIElement. |
IsStylusCapturedChanged | Occurs when the value of the IsStylusCaptured property changes on this element. Inherited from UIElement. |
IsStylusCaptureWithinChanged | Occurs when the value of the IsStylusCaptureWithin property changes on this element. Inherited from UIElement. |
IsStylusDirectlyOverChanged | Occurs when the value of the IsStylusDirectlyOver property changes on this element. Inherited from UIElement. |
IsVisibleChanged | Occurs when the value of the IsVisible property changes on this element. Inherited from UIElement. |
KeyDown | Occurs when a key is pressed while focus is on this element. Inherited from UIElement. |
KeyUp | Occurs when a key is released while focus is on this element. Inherited from UIElement. |
LayoutUpdated | Occurs when the layout of the various visual elements associated with the current Dispatcher changes. Inherited from UIElement. |
Loaded | Occurs when the element is laid out, rendered, and ready for interaction. Inherited from FrameworkElement. |
LostFocus | Occurs when this element loses logical focus. Inherited from UIElement. |
LostKeyboardFocus | Occurs when the keyboard is no longer focused on this element. Inherited from UIElement. |
LostMouseCapture | Occurs when this element loses mouse capture. Inherited from UIElement. |
LostStylusCapture | Occurs when this element loses stylus capture. Inherited from UIElement. |
LostTouchCapture | Occurs when this element loses a touch capture. Inherited from UIElement. |
ManipulationBoundaryFeedback | Occurs when the manipulation encounters a boundary. Inherited from UIElement. |
ManipulationCompleted | Occurs when a manipulation and inertia on the UIElement object is complete. Inherited from UIElement. |
ManipulationDelta | Occurs when the input device changes position during a manipulation. Inherited from UIElement. |
ManipulationInertiaStarting | Occurs when the input device loses contact with the UIElement object during a manipulation and inertia begins. Inherited from UIElement. |
ManipulationStarted | Occurs when an input device begins a manipulation on the UIElement object. Inherited from UIElement. |
ManipulationStarting | Occurs when the manipulation processor is first created. Inherited from UIElement. |
MouseDoubleClick | Occurs when a mouse button is clicked two or more times. Inherited from Control. |
MouseDown | Occurs when any mouse button is pressed while the pointer is over this element. Inherited from UIElement. |
MouseEnter | Occurs when the mouse pointer enters the bounds of this element. Inherited from UIElement. |
MouseLeave | Occurs when the mouse pointer leaves the bounds of this element. Inherited from UIElement. |
MouseLeftButtonDown | Occurs when the left mouse button is pressed while the mouse pointer is over this element. Inherited from UIElement. |
MouseLeftButtonUp | Occurs when the left mouse button is released while the mouse pointer is over this element. Inherited from UIElement. |
MouseMove | Occurs when the mouse pointer moves while over this element. Inherited from UIElement. |
MouseRightButtonDown | Occurs when the right mouse button is pressed while the mouse pointer is over this element. Inherited from UIElement. |
MouseRightButtonUp | Occurs when the right mouse button is released while the mouse pointer is over this element. Inherited from UIElement. |
MouseUp | Occurs when any mouse button is released over this element. Inherited from UIElement. |
MouseWheel | Occurs when the user rotates the mouse wheel while the mouse pointer is over this element. Inherited from UIElement. |
NodeCanceled | Occurs when the changes made in a node are discarded. |
NodeChanged | Occurs when a node’s property changes. |
NodeCheckStateChanged | Occurs when a node’s check box has changed its value. |
NodeCollapsed | Occurs after a node has been collapsed. |
NodeCollapsing | Occurs before a node is collapsed and allowing the action to be canceled. |
NodeEditFinished | Occurs when a user finished the edit operation in a node. |
NodeEditStarted | Occurs when a user edits a node. |
NodeEditStarting | Occurs when a user starts to edit a node. |
NodeExpanded | Occurs after a node has been expanded. |
NodeExpanding | Occurs before a node is expanded. |
NodeUpdated | Occurs when the GridControl updates the data source with the changes made within the focused node. |
PastingFromClipboard | Obsolete. Occurs when some information is pasted from the clipboard to the grid. Inherited from DataViewBase. |
PreviewDragEnter | Occurs when the input system reports an underlying drag event with this element as the drag target. Inherited from UIElement. |
PreviewDragLeave | Occurs when the input system reports an underlying drag event with this element as the drag origin. Inherited from UIElement. |
PreviewDragOver | Occurs when the input system reports an underlying drag event with this element as the potential drop target. Inherited from UIElement. |
PreviewDrop | Occurs when the input system reports an underlying drop event with this element as the drop target. Inherited from UIElement. |
PreviewGiveFeedback | Occurs when a drag-and-drop operation is started. Inherited from UIElement. |
PreviewGotKeyboardFocus | Occurs when the keyboard is focused on this element. Inherited from UIElement. |
PreviewKeyDown | Occurs when a key is pressed while focus is on this element. Inherited from UIElement. |
PreviewKeyUp | Occurs when a key is released while focus is on this element. Inherited from UIElement. |
PreviewLostKeyboardFocus | Occurs when the keyboard is no longer focused on this element. Inherited from UIElement. |
PreviewMouseDoubleClick | Occurs when a user clicks the mouse button two or more times. Inherited from Control. |
PreviewMouseDown | Occurs when any mouse button is pressed while the pointer is over this element. Inherited from UIElement. |
PreviewMouseLeftButtonDown | Occurs when the left mouse button is pressed while the mouse pointer is over this element. Inherited from UIElement. |
PreviewMouseLeftButtonUp | Occurs when the left mouse button is released while the mouse pointer is over this element. Inherited from UIElement. |
PreviewMouseMove | Occurs when the mouse pointer moves while the mouse pointer is over this element. Inherited from UIElement. |
PreviewMouseRightButtonDown | Occurs when the right mouse button is pressed while the mouse pointer is over this element. Inherited from UIElement. |
PreviewMouseRightButtonUp | Occurs when the right mouse button is released while the mouse pointer is over this element. Inherited from UIElement. |
PreviewMouseUp | Occurs when any mouse button is released while the mouse pointer is over this element. Inherited from UIElement. |
PreviewMouseWheel | Occurs when the user rotates the mouse wheel while the mouse pointer is over this element. Inherited from UIElement. |
PreviewQueryContinueDrag | Occurs when there is a change in the keyboard or mouse button state during a drag-and-drop operation. Inherited from UIElement. |
PreviewStylusButtonDown | Occurs when the stylus button is pressed while the pointer is over this element. Inherited from UIElement. |
PreviewStylusButtonUp | Occurs when the stylus button is released while the pointer is over this element. Inherited from UIElement. |
PreviewStylusDown | Occurs when the stylus touches the digitizer while it is over this element. Inherited from UIElement. |
PreviewStylusInAirMove | Occurs when the stylus moves over an element without actually touching the digitizer. Inherited from UIElement. |
PreviewStylusInRange | Occurs when the stylus is close enough to the digitizer to be detected, while over this element. Inherited from UIElement. |
PreviewStylusMove | Occurs when the stylus moves while over the element. The stylus must move while being detected by the digitizer to raise this event, otherwise, PreviewStylusInAirMove is raised instead. Inherited from UIElement. |
PreviewStylusOutOfRange | Occurs when the stylus is too far from the digitizer to be detected. Inherited from UIElement. |
PreviewStylusSystemGesture | Occurs when a user performs one of several stylus gestures. Inherited from UIElement. |
PreviewStylusUp | Occurs when the user raises the stylus off the digitizer while the stylus is over this element. Inherited from UIElement. |
PreviewTextInput | Occurs when this element gets text in a device-independent manner. Inherited from UIElement. |
PreviewTouchDown | Occurs when a finger touches the screen while the finger is over this element. Inherited from UIElement. |
PreviewTouchMove | Occurs when a finger moves on the screen while the finger is over this element. Inherited from UIElement. |
PreviewTouchUp | Occurs when a finger is raised off of the screen while the finger is over this element. Inherited from UIElement. |
ProcessEditorActivationAction | Allows you to specify whether the focused editor should process an activation action. Inherited from DataViewBase. |
PropertyChanged | Occurs every time the DataViewBase.FocusedView property has changed its value. Inherited from DataViewBase. |
QueryContinueDrag | Occurs when there is a change in the keyboard or mouse button state during a drag-and-drop operation. Inherited from UIElement. |
QueryCursor | Occurs when the cursor is requested to display. This event is raised on an element each time that the mouse pointer moves to a new location, which means the cursor object might need to be changed based on its new position. Inherited from UIElement. |
RequestBringIntoView | Occurs when BringIntoView(Rect) is called on this element. Inherited from FrameworkElement. |
RowAnimationBegin | Enables you to provide a custom animation effect after row data has been asynchronously retrieved from a data source. Inherited from DataViewBase. |
RowDoubleClick | Occurs when a user double-clicks a node. |
ScrollBarAnnotationsCreating | Allows creating a set of predefined scrollbar annotations. |
ScrollBarCustomRowAnnotation | Allows creating a new scrollbar annotation based on data row values and a row handle. |
SearchStringToFilterCriteria | Occurs each time the GridControl starts to search data and allows you to convert the search string to filter criteria. Inherited from DataViewBase. |
SelectionChanged | Obsolete. Occurs after treelist’s selection has been changed. |
ShowFilterPopup | Allows you to customize a column’s drop-down filter. Inherited from DataViewBase. |
ShowGridMenu | Enables you to customize the context menu. Inherited from DataViewBase. |
ShowingEditor | Enables you to prevent an end-user from activating editors of individual cells. |
ShowingNodeFooter | Fires for each parent node before showing its node footer. |
ShownColumnChooser | Occurs after the Column Chooser has been shown. Inherited from DataViewBase. |
ShownEditor | Occurs after the focused cell’s editor has been shown. |
SizeChanged | Occurs when either the ActualHeight or the ActualWidth properties change value on this element. Inherited from FrameworkElement. |
SourceUpdated | Occurs when the source value changes for any existing property binding on this element. Inherited from FrameworkElement. |
StartRecordDrag | This event occurs when a drag-and-drop operation is started. Inherited from DataViewBase. |
StartSorting | Occurs before a sorting operation is started. |
StylusButtonDown | Occurs when the stylus button is pressed while the pointer is over this element. Inherited from UIElement. |
StylusButtonUp | Occurs when the stylus button is released while the pointer is over this element. Inherited from UIElement. |
StylusDown | Occurs when the stylus touches the digitizer while the stylus is over this element. Inherited from UIElement. |
StylusEnter | Occurs when the stylus enters the bounds of this element. Inherited from UIElement. |
StylusInAirMove | Occurs when the stylus moves over an element without actually touching the digitizer. Inherited from UIElement. |
StylusInRange | Occurs when the stylus is close enough to the digitizer to be detected, while over this element. Inherited from UIElement. |
StylusLeave | Occurs when the stylus leaves the bounds of the element. Inherited from UIElement. |
StylusMove | Occurs when the stylus moves over this element. The stylus must move while on the digitizer to raise this event. Otherwise, StylusInAirMove is raised instead. Inherited from UIElement. |
StylusOutOfRange | Occurs when the stylus is too far from the digitizer to be detected, while over this element. Inherited from UIElement. |
StylusSystemGesture | Occurs when a user performs one of several stylus gestures. Inherited from UIElement. |
StylusUp | Occurs when the user raises the stylus off the digitizer while it is over this element. Inherited from UIElement. |
SubstituteFilter | Allows you to replace the applied filter with another filter. |
TargetUpdated | Occurs when the target value changes for any property binding on this element. Inherited from FrameworkElement. |
TextInput | Occurs when this element gets text in a device-independent manner. Inherited from UIElement. |
ToolTipClosing | Occurs just before any tooltip on the element is closed. Inherited from FrameworkElement. |
ToolTipOpening | Occurs when any tooltip on the element is opened. Inherited from FrameworkElement. |
TouchDown | Occurs when a finger touches the screen while the finger is over this element. Inherited from UIElement. |
TouchEnter | Occurs when a touch moves from outside to inside the bounds of this element. Inherited from UIElement. |
TouchLeave | Occurs when a touch moves from inside to outside the bounds of this element. Inherited from UIElement. |
TouchMove | Occurs when a finger moves on the screen while the finger is over this element. Inherited from UIElement. |
TouchUp | Occurs when a finger is raised off of the screen while the finger is over this element. Inherited from UIElement. |
UnboundExpressionEditorCreated | Fires after the Expression Editor has been invoked for an unbound column. Inherited from DataViewBase. |
Unloaded | Occurs when the element is removed from within an element tree of loaded elements. Inherited from FrameworkElement. |
ValidateCell | Allows you to validate the focused cell’s data. |
ValidateNode | Allows you to validate node values. |
ValidateNodeDeletion | Allows you to validate nodes, check database constraints, and delete nodes from the database before a user deletes a node from the Data Grid. |
See Also