Salesforce

CaretPosGet (Magic xpa 4.x)

« Go Back

Information

 
Approval Process StatusPublished
Objective
Description

CaretPosGet (Magic xpa 4.x)

Returns the current caret (cursor) position in the Edit control. The position is one based, such as Position = 1, meaning that the cursor is parked before the first character of the string. For Multi-line Edit and Rich Edit controls, the New Line character is counted as two characters.

Syntax:

CaretPosGet( )

Parameters:

None

Returns:

The current cursor position in the Edit control.

This function returns 0 in the following circumstances:

  • No control is in focus

  • The control in focus is not the Edit Control

  • This function is evaluated in the flow when the Magic xpa engine is not parked on an Edit control

  • The handler is invoked for an event with the Force Exit set to Control or Record

Exceptions:

This function is not supported in Web Client tasks.

Platform specific:

This function is not supported for mobile devices.

See also:

MarkText, MarkedTextGet, MarkedTextSet

The Online and Rich Client Samples projects (program VA02 and RVA02)

Reference
TitleCaretPosGet (Magic xpa 4.x)
URL NameCaretPosGet-xpa-4x