UltraGridState Enumeration

Bit flags that describe the state of the control. For example, if the first cell in the second row is active but not in edit mode bits Row, Cell, and FirstCell will be set.

Syntax

Visual Basic

'Declaration
 
Public Enum UltraGridState 
   Inherits System.Enum

C#

public enum UltraGridState : System.Enum 

Members

Member	Description
AddRow	Active row is an add-row.
CanCopy	A state that indicates whether multi-cell copy operation can be performed.
CanCut	A state that indicates whether multi-cell cut operation can be performed.
CanDeleteCells	A state that indicates whether multi-cell delete (deleting the contents of the cells) operation can be performed.
CanPaste	A state that indicates whether multi-cell paste operation can be performed.
CanRedo	A state that indicates whether multi-cell redo operation can be performed.
CanUndo	A state that indicates whether multi-cell undo operation can be performed.
Cell	Active Cell not null
CellFirst	Active Cell is first cell
CellLast	Active Cell is last cell
CellMultiline	A state that indicates whether the current cell in edit mode is a multi-line cell.
FilterDroppedDown	If the filter drop down is dropped down.
FilterRow	Active row is a filter row.
FirstRowInGrid	Active row is the fist row in the grid. This differs from RowFirst in that RowFirst only takes into account sibling bands while FirstRowInGrid cosiders the whole grid (all the bands).
GroupByRow	A GroupByRow is the active row.
HasDropdown	Active Cell can be dropped down
HeaderInEditMode	There is an active header in edit mode
InEdit	Active Cell is in edit state
IsCheckbox	Active Cell has a check box
IsDroppedDown	Active Cell is dropped down state
LastRowInGrid	Active row is the last row in the grid. This differs from Rowlast in that RowLast only takes into account sibling bands while LastRowInGrid cosiders the whole grid (all the bands).
Row	Active Row is not null
RowChild	Active Row is a child row
RowDirty	If the current row is dirty.
RowExpandable	Active Row is expandable
RowExpanded	Active Row is expanded
RowFirst	Active Row is the first Row
RowFirstChild	Active Row is the first child (in its parent row)
RowLast	Active Row is the last Row
RowLastChild	Active Row is the last child (in its parent row)
SwapDroppedDown	If the swap drop down is dropped down.

Example

The following code illustrates how to add a custom key/action mapping to the grid that will navigate to the first row in the grid when the grid has focus but is not in edit mode and the users presses the ‘H’ key (unless the ‘alt’ key is also pressed).

Visual Basic

Imports Infragistics.Win.UltraWinGrid

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

     Dim newMapping As GridKeyActionMapping

    ' Add a custom key/action mapping to the grid that 
    ' will navigate to the first row in the grid when 
    ' the grid has focus but is not in edit mode 
    ' and the users presses the ‘H’ key (unless the
    ' 'alt’ key is also pressed). 
    newMapping = New GridKeyActionMapping(Keys.H, UltraGridAction.FirstRowInGrid, UltraGridState.InEdit, 0, Infragistics.Win.SpecialKeys.Alt, 0)

    Me.ultraGrid1.KeyActionMappings.Add(newMapping)

    ' Note: The concept applies to UltraCombo controls as
    ' well except that the combo's KeyActionMappings is
    ' a collection of a mapping class, and associated
    ' state and actiion flags, that make sense for a combo
    ' (i.e. ComboKeyActionMapping, UltraComboAction and
    ' UltraComboState.

End Sub

C#

using Infragistics.Win.UltraWinGrid;

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

	this.oleDbDataAdapter1.Fill( this.dataSet11 );

	// Add a custom key/action mapping to the grid that 
	// will navigate to the first row in the grid when 
	// the grid has focus but is not in edit mode 
	// and the users presses the ‘H’ key (unless the
	// 'alt’ key is also pressed). 
	this.ultraGrid1.KeyActionMappings.Add( 
		new GridKeyActionMapping( 
			// the key code
			Keys.H,
			// the action to take
			UltraGridAction.FirstRowInGrid,
			// disallowed state
			UltraGridState.InEdit, 
			// required state (none)
			0, 
			// disallowed special keys
			Infragistics.Win.SpecialKeys.Alt, 
			// required special keys (none)
			0 ) );

	// Note: The concept applies to UltraCombo controls as
	// well except that the combo's KeyActionMappings is
	// a collection of a mapping class, and associated
	// state and actiion flags, that make sense for a combo
	// (i.e. ComboKeyActionMapping, UltraComboAction and
	// UltraComboState.

}

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