UltraTreeState Enumeration

Bit flags that describe the state of the control. For example,

Syntax

Visual Basic

'Declaration
 
Public Enum UltraTreeState 
   Inherits System.Enum

C#

public enum UltraTreeState : System.Enum 

Members

Member	Description
ActiveCell	The UltraTree.ActiveCell property returns a non-null value.
ActiveCellIsInFirstLogicalColumn	The UltraTree.ActiveCell is in the first logical column of cells displayed by the UltraTree.ActiveNode.
ActiveCellIsInLastLogicalColumn	The UltraTree.ActiveCell is in the last logical column of cells displayed by the UltraTree.ActiveNode.
ActiveCellIsOnFirstLogicalRow	The UltraTree.ActiveCell is on the first logical row of cells displayed by the UltraTree.ActiveNode.
ActiveCellIsOnLastLogicalRow	The UltraTree.ActiveCell is on the last logical row of cells displayed by the UltraTree.ActiveNode.
ActiveNodeDisplaysCells	The UltraTree.ActiveNode displays cells.
AllowCopy	Determines if the UltraTree.SelectedNodes can be copied to the clipboard.
AllowCut	Determines if the UltraTree.SelectedNodes can be cut to the clipboard.
AllowPaste	Determines if the nodes from the clipboard can be pasted into the UltraTree.ActiveNode's UltraTreeNode.Nodes collection.
CellInEditMode	The UltraTree.ActiveCell property returns a non-null value, and that cell is in edit mode.
FirstCellActive	The UltraTree.ActiveCell property returns a non-null value, and that cell belongs to the first logical column displayed by the UltraTreeNode to which it belongs.
FirstNodeActive	The first visible, enabled node displayed by the control is the UltraTree.ActiveNode.
HasNodeChangesPending	The UltraTree.ActiveNode has pending changes to cell values that have not yet been committed.
InEdit	Active Node is in edit mode
IsCheckbox	Active Node has a check box
IsOptionButton	Active Node's NodeStyle property is set to OptionButton
LastCellActive	The UltraTree.ActiveCell property returns a non-null value, and that cell belongs to the last logical column displayed by the UltraTreeNode to which it belongs.
LastNodeActive	The last visible, enabled node displayed by the control is the UltraTree.ActiveNode.
NextNodeDisplaysCells	The next visible, enabled node relative to the UltraTree.ActiveNode displays cells.
NodeChild	Active Node is a child Node
NodeExpandable	Active Node is expandable
NodeExpanded	Active Node is expanded
NodeFirst	Active Node is first Node
NodeHasChildren	Active Node has Children
NodeLast	Active Node is last Node
NodeNotExpandable	Active Node is not expandable
NoFocusRect	The tree does not draw focus rectangles around the active node. This is probably because UltraTree.DrawsFocusRect is resolving to false.
PreviousNodeDisplaysCells	The previous visible, enabled node relative to the UltraTree.ActiveNode displays cells.
TabKeyNavigatesToNextCell	The control's UltraTreeColumnSettings.TabNavigation property resolves to 'NextCell'
TabKeyNavigatesToNextControl	The control's UltraTreeColumnSettings.TabNavigation property resolves to 'NextControl'

Example

The following code illustrates how to add a custom key/action mappings to the tree that will toggle the expanded state of the active node when the user presses the ‘X’ key (unless the ‘alt’ key is also pressed).

Visual Basic

Imports Infragistics.Win.UltraWinTree

Private Sub Form1_Load(ByVal sender As System.Object, ByVal e As System.EventArgs) Handles MyBase.Load

    Dim newAction As TreeKeyActionMapping

    ' Add 2 KeyActionMappings so that if the user presses
    ' the 'X' key (without also pressing the 'Alt' key)
    ' the active node will toggle its expanded state.

    ' The first mapping states that if the node is expandable
    ' and its not already expanded or in edit mode and the
    ' user presses the 'X' key then expand the node.
    newAction = New TreeKeyActionMapping( _
       Keys.X, _
       UltraTreeAction.ExpandNode, _
       UltraTreeState.InEdit Or UltraTreeState.NodeExpanded, _
       UltraTreeState.NodeExpandable, _
       Infragistics.Win.SpecialKeys.Alt, _
         0)

    Me.ultraTree1.KeyActionMappings.Add(newAction)

    ' The first mapping states that if the node is expanded
    ' and its not in edit mode and the user presses the 'X' 
    ' key then collapse the node.
    newAction = New TreeKeyActionMapping( _
       Keys.X, _
       UltraTreeAction.CollapseNode, _
       UltraTreeState.InEdit, _
       UltraTreeState.NodeExpanded, _
       Infragistics.Win.SpecialKeys.Alt, _
         0)

    Me.ultraTree1.KeyActionMappings.Add(newAction)

End Sub

C#

using System.Diagnostics;
using Infragistics.Win.UltraWinTree;

private void Form1_Load(object sender, System.EventArgs e)
{

	// Add 2 KeyActionMappings so that if the user presses
	// the 'X' key (without also pressing the 'Alt' key)
	// the active node will toggle its expanded state.

	// The first mapping states that if the node is expandable
	// and its not already expanded or in edit mode and the
	// user presses the 'X' key then expand the node.
	 this.ultraTree1.KeyActionMappings.Add(
		new TreeKeyActionMapping( 
					// the key code
					Keys.X,
					// the action to take
					UltraTreeAction.ExpandNode,
					// disallowed state
					UltraTreeState.InEdit | UltraTreeState.NodeExpanded, 
					// required state 
					UltraTreeState.NodeExpandable, 
					// disallowed special keys
					Infragistics.Win.SpecialKeys.Alt, 
					// required special keys (none)
					0 ) );

	// The first mapping states that if the node is expanded
	// and its not in edit mode and the user presses the 'X' 
	// key then collapse the node.
	this.ultraTree1.KeyActionMappings.Add(
		new TreeKeyActionMapping( 
					// the key code
					Keys.X,
					// the action to take
					UltraTreeAction.CollapseNode,
					// disallowed state
					UltraTreeState.InEdit, 
					// required state
					UltraTreeState.NodeExpanded, 
					// disallowed special keys
					Infragistics.Win.SpecialKeys.Alt, 
					// required special keys (none)
					0 ) );

}

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