Version

UltraTreeAction Enumeration

Enumerates the possible actions that can be performed on the Tree
Syntax
'Declaration
 
Public Enum UltraTreeAction 
   Inherits System.Enum
public enum UltraTreeAction : System.Enum
Members
MemberDescription
AboveCellActivates the same cell in the previous logical row.
BelowCellActivates the same cell in the next logical row.
CheckOptionButtonChecks the currently active node's option button
ClearAllSelectedNodesClears all the currently selected nodes
CollapseNodeCollapse the Active Node
CopyCopies the selected nodes to the clipboard
CutCuts the selected nodes to the clipboard
DeactivateCellDeactivates 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.
DeleteNodesDeletes all Selected Nodes
EnterEditModeEnter Edit Mode
EnterEditModeOnCellEnters edit mode on the UltraTree.ActiveCell
ExitEditModeExit Edit Mode
ExitEditModeAndSaveExit Edit Mode and save changes
ExitEditModeOnCellSaveChangesEnds the edit mode session for the UltraTree.ActiveCell, applying changes to the cell's value.
ExpandAllNodeExpand Active Node and its descendants
ExpandNodeExpand the Active Node
FirstCellInNodeActivates the cell in the first logical column for the UltraTreeNode which contains the UltraTree.ActiveCell.
FirstCellInNodesCollectionActivates the cell in the first logical column for the first visible UltraTreeNode in the same collection as the node which contains the UltraTree.ActiveCell.
FirstCellInTreeActivates the cell in the first logical column for the first visible UltraTreeNode displayed by the UltraTree control.
FirstNodeMove to the First Node In Tree
FirstNodeNoSelectMove to First Node without altering the Selection
LastCellInNodeActivates the cell in the last logical column for the UltraTreeNode which contains the UltraTree.ActiveCell.
LastCellInNodesCollectionActivates the cell in the last logical column for the last visible UltraTreeNode in the same collection as the node which contains the UltraTree.ActiveCell.
LastCellInTreeActivates the cell in the last logical column for the last visible UltraTreeNode displayed by the UltraTree control.
LastNodeMove to Last Node In Tree
LastNodeNoSelectMove to Last Node without altering the Selection
NextCellActivates the cell in the next logical column.
NextCellEnterEditModeActivates the cell in the next logical column and enters edit mode on that cell.
NextNodeMove to Next Node
NextNodeNoSelectMove to Next Node without altering the Selection
NoActionPerforms 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.
PageDownPage Down In Tree
PageDownNoSelectPage Down in the Tree without altering the Selection
PageUpPage Up In Tree
PageUpNoSelectPage Up in the Tree without altering the Selection
ParentNodeMove to the Parent of the Active Node
PasteAppends nodes from the clipboard to the UltraTree.ActiveNode's UltraTreeNode.Nodes collection.
PreviousCellActivates the cell in the previous logical column.
PreviousCellEnterEditModeActivates the cell in the previous logical column and enters edit mode on that cell.
PrevNodeMove to Previous Node
PrevNodeNoSelectMove to Previous Node without altering the Selection
ScrollBottomScroll to the bottom of the tree without altering the selection or the active node.
ScrollDownScroll the tree down one node without altering the selection or the active node.
ScrollPageDownScroll down one page without altering the selection or the active node.
ScrollPageUpScroll up one page without altering the selection or the active node.
ScrollTopScroll to the top of the tree without altering the selection or the active node.
ScrollUpScroll the tree up one node without altering the selection or the active node.
SelectActiveNodeSelects the currently active node
SelectNextControlSelects the next control in the tab order.
SelectPreviousControlSelects the next control in the tab order.
ToggleCheckboxToggle Check Box state on the Active Node
ToggleSelectionToggles selection of the Active Node
UndoCellEditEnds the edit mode session for the UltraTree.ActiveCell, discarding changes made during the edit mode session.
UndoNodeEditCancels 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.

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
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

See Also