UltraTreeAction Enumeration

Enumerates the possible actions that can be performed on the Tree

Syntax

Visual Basic

'Declaration
 
Public Enum UltraTreeAction 
   Inherits System.Enum

C#

public enum UltraTreeAction : System.Enum 

Members

Member	Description
AboveCell	Activates the same cell in the previous logical row.
BelowCell	Activates the same cell in the next logical row.
CheckOptionButton	Checks the currently active node's option button
ClearAllSelectedNodes	Clears all the currently selected nodes
CollapseNode	Collapse the Active Node
Copy	Copies the selected nodes to the clipboard
Cut	Cuts the selected nodes to the clipboard
DeactivateCell	Deactivates the UltraTree.ActiveCell, while maintaining the UltraTree.ActiveNode. This makes it possible to redirect the keyboard focus to the ActiveNode, so that navigational keys will apply to nodes rather than cells.
DeleteNodes	Deletes all Selected Nodes
EnterEditMode	Enter Edit Mode
EnterEditModeOnCell	Enters edit mode on the UltraTree.ActiveCell
ExitEditMode	Exit Edit Mode
ExitEditModeAndSave	Exit Edit Mode and save changes
ExitEditModeOnCellSaveChanges	Ends the edit mode session for the UltraTree.ActiveCell, applying changes to the cell's value.
ExpandAllNode	Expand Active Node and its descendants
ExpandNode	Expand the Active Node
FirstCellInNode	Activates the cell in the first logical column for the UltraTreeNode which contains the UltraTree.ActiveCell.
FirstCellInNodesCollection	Activates the cell in the first logical column for the first visible UltraTreeNode in the same collection as the node which contains the UltraTree.ActiveCell.
FirstCellInTree	Activates the cell in the first logical column for the first visible UltraTreeNode displayed by the UltraTree control.
FirstNode	Move to the First Node In Tree
FirstNodeNoSelect	Move to First Node without altering the Selection
LastCellInNode	Activates the cell in the last logical column for the UltraTreeNode which contains the UltraTree.ActiveCell.
LastCellInNodesCollection	Activates the cell in the last logical column for the last visible UltraTreeNode in the same collection as the node which contains the UltraTree.ActiveCell.
LastCellInTree	Activates the cell in the last logical column for the last visible UltraTreeNode displayed by the UltraTree control.
LastNode	Move to Last Node In Tree
LastNodeNoSelect	Move to Last Node without altering the Selection
NextCell	Activates the cell in the next logical column.
NextCellEnterEditMode	Activates the cell in the next logical column and enters edit mode on that cell.
NextNode	Move to Next Node
NextNodeNoSelect	Move to Next Node without altering the Selection
NoAction	Performs no action. This action is used so that a key will be considered to be available for processing by the control and will therefore result in the key events of the control being invoked but does not cause any action to occur.
PageDown	Page Down In Tree
PageDownNoSelect	Page Down in the Tree without altering the Selection
PageUp	Page Up In Tree
PageUpNoSelect	Page Up in the Tree without altering the Selection
ParentNode	Move to the Parent of the Active Node
Paste	Appends nodes from the clipboard to the UltraTree.ActiveNode's UltraTreeNode.Nodes collection.
PreviousCell	Activates the cell in the previous logical column.
PreviousCellEnterEditMode	Activates the cell in the previous logical column and enters edit mode on that cell.
PrevNode	Move to Previous Node
PrevNodeNoSelect	Move to Previous Node without altering the Selection
ScrollBottom	Scroll to the bottom of the tree without altering the selection or the active node.
ScrollDown	Scroll the tree down one node without altering the selection or the active node.
ScrollPageDown	Scroll down one page without altering the selection or the active node.
ScrollPageUp	Scroll up one page without altering the selection or the active node.
ScrollTop	Scroll to the top of the tree without altering the selection or the active node.
ScrollUp	Scroll the tree up one node without altering the selection or the active node.
SelectActiveNode	Selects the currently active node
SelectNextControl	Selects the next control in the tab order.
SelectPreviousControl	Selects the next control in the tab order.
ToggleCheckbox	Toggle Check Box state on the Active Node
ToggleSelection	Toggles selection of the Active Node
UndoCellEdit	Ends the edit mode session for the UltraTree.ActiveCell, discarding changes made during the edit mode session.
UndoNodeEdit	Cancels pending changes to cell values for the UltraTree.ActiveNode.

Example

The following code illustrates how to test what state a tree control is in and to perform an action based on the current state, in this case toggling the active node's checked state if its style is a checkbox.

Visual Basic

Imports Infragistics.Win.UltraWinTree

Private Sub button16_Click(ByVal sender As System.Object, ByVal e As System.EventArgs) Handles button16.Click

    Dim state As UltraTreeState

    ' Get the current state of the tree control
    state = Me.ultraTree1.CurrentState

    ' Check the state bit flags to see if the 'InEdit' bit is set.
    ' Only proceed if the node is not in edit mode.
    If (state And UltraTreeState.InEdit) = 0 Then
        ' Since we aren't in edit mode check the bit that
        ' determines if the active node is a checkbox. 
        ' If it is then call perform action to toggle the
        ' node's check state.
        If (state And UltraTreeState.IsCheckbox) = UltraTreeState.IsCheckbox Then
            Me.ultraTree1.PerformAction(UltraTreeAction.ToggleCheckbox, False, False)
        End If

    End If

End Sub

C#

using Infragistics.Win.UltraWinTree;

private void button16_Click(object sender, System.EventArgs e)
{
	// Get the current state of the tree control
	UltraTreeState state = this.ultraTree1.CurrentState;

	// Check the state bit flags to see if the 'InEdit' bit is set
	// Only proceed if the node is not in edit mode.
	if ( ( state & UltraTreeState.InEdit ) == 0 )
	{
		// Since we aren't in edit mode check the bit that
		// determines if the active node is a checkbox. 
		// If it is then call perform action to toggle the
		// node's check state.
		if ( ( state & UltraTreeState.IsCheckbox ) == UltraTreeState.IsCheckbox )
			this.ultraTree1.PerformAction( UltraTreeAction.ToggleCheckbox, false, false );
	}
		
}

Requirements

Target Platforms: Windows 10, Windows 8.1, Windows 8, Windows 7, Windows Server 2012, Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2