guiEditSetCaretIndex

Client-side

Server-side

Shared

This page is incomplete! Help wanted!

Please finish this page using the corresponding Old Wiki article.
Go to Contribution guidelines for more information.

This function sets the current position of the caret (the text cursor) within the edit box.

Syntax

 guiEditSetCaretIndex ( )

Code Examples

client

This example makes the text cursor jump to the end of an edit box if the user is holding the Left Control button.

function moveToEndOnClick()
  if ( getKeyState ( "lctrl" ) == true ) and ( getElementType(source) == "gui-edit" ) then          -- if the user is holding down left control
    local text = guiGetText ( source )
    local textLength = string.len ( text )
    guiEditSetCaretIndex ( source, textLength )  -- set the caret index. No need to check if the clicked control is actually an edit box as this function won't work on other controls anyway
  end
end
addEventHandler ( "onClientGUIClick", root, moveToEndOnClick )    -- add an event handler for clicks

guiEditSetCaretIndex

Syntax

Code Examples

See Also

GUI Functions

GUI Elements

Reference