PerformAction Method (UltraFormattedTextEditorBase)

Simulates user interaction with the control.

Syntax

Visual Basic

'Declaration
 
Public Overridable Function PerformAction( _
   ByVal actionCode As Infragistics.Win.FormattedLinkLabel.FormattedLinkEditorAction, _
   ByVal shift As Boolean, _
   ByVal control As Boolean _
) As Boolean

C#

public virtual bool PerformAction( 
   Infragistics.Win.FormattedLinkLabel.FormattedLinkEditorAction actionCode,
   bool shift,
   bool control
)

Parameters

actionCode

A Infragistics.Win.FormattedLinkLabel.FormattedLinkEditorAction 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 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.

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

See Infragistics.Win.FormattedLinkLabel.FormattedLinkEditorAction for a list of actions that can be performed.

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