StateRequired Property (ScrollBarKeyActionMapping)

State that the control must be in for the action to be allowed.

Syntax

Visual Basic

'Declaration
 
Public Shadows Property StateRequired As ScrollBarState

C#

public new ScrollBarState StateRequired {get; set;}

Example

The following sample illustrates how to add key action mappings to the UltraScrollBar control.

Visual Basic

Imports Infragistics.Win
Imports Infragistics.Win.UltraWinScrollBar

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

    Dim mapping As ScrollBarKeyActionMapping

    ' Add a key action mapping that will scroll the 
    ' scrollbar to its maximum value if the user presses
    ' the 'L' key and the thumb isn't being dragged.
    mapping = New ScrollBarKeyActionMapping(Keys.L, ScrollBarAction.Last, ScrollBarState.ThumbDrag, 0, Infragistics.Win.SpecialKeys.Alt, 0)
    Me.ultraScrollBar1.KeyActionMappings.Add(mapping)

    ' Add a key action mapping that will scroll the 
    ' scrollbar to its mimimum value if the user presses
    ' the 'F' key and the thumb isn't being dragged.
    mapping = New ScrollBarKeyActionMapping(Keys.F, ScrollBarAction.First, ScrollBarState.ThumbDrag, 0, Infragistics.Win.SpecialKeys.Alt, 0)
    Me.ultraScrollBar1.KeyActionMappings.Add(mapping)

End Sub

C#

using Infragistics.Win;
using Infragistics.Win.UltraWinScrollBar;

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

	// Add a key action mapping that will scroll the 
	// scrollbar to its maximum value if the user presses
	// the 'L' key and the thumb isn't being dragged.
	this.ultraScrollBar1.KeyActionMappings.Add( 
		new ScrollBarKeyActionMapping( 
			// the key code
			Keys.L,
			// the action to take
			ScrollBarAction.Last,
			// disallowed state
			ScrollBarState.ThumbDrag, 
			// required state 
			0,
			// diallowed special keys
			Infragistics.Win.SpecialKeys.Alt, 
			// requird special keys
			0 ) );

	// Add a key action mapping that will scroll the 
	// scrollbar to its minimum value if the user presses
	// the 'F' key and the thumb isn't being dragged.
	this.ultraScrollBar1.KeyActionMappings.Add( 
		new ScrollBarKeyActionMapping( 
			// the key code
			Keys.F,
			// the action to take
			ScrollBarAction.First,
			// disallowed state
			ScrollBarState.ThumbDrag, 
			// required state 
			0,
			// diallowed special keys
			Infragistics.Win.SpecialKeys.Alt, 
			// requird special keys
			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