StateRequired Property

Gets/sets the required state. These are bit flags that specify the state that the control MUST be in for this mapping to be active.

Syntax

Visual Basic

'Declaration
 
Public Shadows Property StateRequired As UltraTabControlStates

C#

public new UltraTabControlStates StateRequired {get; set;}

Example

The following code illustrates how to add a custom key/action mapping to the tab control that will select the first tab when the tab control has focus and the user presses the ‘H’ key (unless the ‘alt’ key is also pressed).

Visual Basic

Imports Infragistics.Win
Imports Infragistics.Win.UltraWinTabs
Imports Infragistics.Win.UltraWinTabControl

Private Sub LoadNewMappings()

    Dim newMapping As UltraTabControlKeyActionMapping

    ' Add a custom key/action mapping to the tab that 
    ' will navigate to the first tab (if that tab
    ' isn't already selected when the tab control 
    ' has focus and the users presses the ‘H’ key 
    ' (unless the 'alt’ key is also pressed). 
    newMapping = New UltraTabControlKeyActionMapping(Keys.H, UltraTabControlAction.SelectFirstTab, UltraTabControlStates.FirstTab, 0, Infragistics.Win.SpecialKeys.Alt, 0)

    Me.ultraTabControl1.KeyActionMappings.Add(newMapping)

End Sub

C#

using System.Diagnostics;
using Infragistics.Win;
using Infragistics.Win.UltraWinTabs;
using Infragistics.Win.UltraWinTabControl;

private void LoadNewMappings()
{
	// Add a custom key/action mapping to the tab that 
	// will navigate to the first tab (if that tab
	// isn't already selected when the tab control 
	// has focus and the users presses the ‘H’ key 
	// (unless the 'alt’ key is also pressed). 
	this.ultraTabControl1.KeyActionMappings.Add( 
		new UltraTabControlKeyActionMapping( 
			// the key code
			Keys.H,
			// the action to take
			UltraTabControlAction.SelectFirstTab,
			// disallowed state
			UltraTabControlStates.FirstTab, 
			// required state (none)
			0, 
			// 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