Product Documentation
Cadence User Interface SKILL Reference
Product Version IC23.1, September 2023

hiSetInsertionPosition

hiSetInsertionPosition(
g_form
s_field
x_newPosition
)
=> t / nil

Description

Resets the position of the insertion cursor in a type-in field. You can use the hiGetInsertionPosition function to get the current position of the cursor.

Arguments

g_form

Handle to the form, which is returned by hiCreateAppForm.

s_field

Symbol name of the field.

x_newPosition

The new position of the insertion cursor, specified as an integer. A value of 0 places the cursor at the beginning of the field, 1 places it after the first character, 2 places it after the second character, and so on. A negative number, or a number higher than the number of characters in the field, places the cursor at the end of the string.

Value Returned

t

The position of the insertion cursor was changed.

nil

The position of the insertion cursor could not be changed.

Related Topics

Form and Field Functions

hiCreateAppForm

hiGetInsertionPosition


Return to top
 ⠀
X