Infragistics logo
메뉴
.NET and JavaScript UI Controls
Version

PerformAction(UltraGridAction,Boolean,Boolean) Method

Simulates user interaction with the control.
Syntax
'Declaration
 
Public Overloads Overridable Function PerformAction( _
   ByVal actionCode As UltraGridAction, _
   ByVal shift As Boolean, _
   ByVal control As Boolean _
) As Boolean
public virtual bool PerformAction( 
   UltraGridAction actionCode,
   bool shift,
   bool control
)

Parameters

actionCode
An UltraGridAction enumeration value that determines the user action to be performed.
shift
A boolean specifies whether the action should be performed as if the shift key is depressed. This mainly affects actions where selection is involved and determines if the existing selection is extended, as it is when the user holds down the shift key and selects a range of rows in a grid.
control
A boolean specifies whether the action should be performed as if the control key is depressed. This mainly affects actions where selection is involved and determines if the existing selection is maintained, as it is when the user holds down the control key and selects a row in a grid.

Return Value

True if the action was performed successfully.true if the action completed successfully, false if the action failed.
Remarks

Invoke this method to simulate an action the user can perform.

Many actions are only appropriate in certain situations; if an action is inappropriate, it will not be performed. For example, attempting to delete rows by performing the DeleteRows action (37 - KeyActionDeleteRows) will have no effect if no rows are selected. Similarly, an attempt to toggle a cell's dropdown list by performing a droptown toggle action (14 - KeyActionToggleDropdown) will also be ignored if the column does not have a dropdown list associated with it.

You can use the CurrentState property to determine the state of the control when the action is about to be performed.

Example
The following code illustrates how to test what state a grid is in and to perform an action based on the current state, it this case enter edit mode if a cell is selected.

Imports Infragistics.Win.UltraWinGrid

Private Sub button1_Click(ByVal sender As System.Object, ByVal e As System.EventArgs) Handles button1.Click

    Dim state As UltraGridState

    ' Get the current state of the grid
    state = Me.ultraGrid1.CurrentState

    ' Check the state bit flags to see if the 'InEdit' bit is set
    If ((state And UltraGridState.InEdit) = 0) Then
        ' since we aren't in edit mode check the bit that
        ' determines if a cell is selected. If it is then
        ' call perform action to enter edit mode
        If ((state And UltraGridState.Cell) = UltraGridState.Cell) Then
            Me.ultraGrid1.PerformAction(UltraGridAction.EnterEditMode)
        End If
    End If

    ' 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
using Infragistics.Win.UltraWinGrid;

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

	// Get the current state of the grid
	UltraGridState state = this.ultraGrid1.CurrentState;

	// Check the state bit flags to see if the 'InEdit' bit is set
	if ( ( state & UltraGridState.InEdit ) == 0 )
	{
		// since we aren't in edit mode check the bit that
		// determines if a cell is selected. If it is then
		// call perform action to enter edit mode
		if ( ( state & UltraGridState.Cell ) == UltraGridState.Cell )
			this.ultraGrid1.PerformAction( UltraGridAction.EnterEditMode );
	}

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

See Also