GuiEditGetCaretIndex

From Multi Theft Auto: Wiki
Jump to: navigation, search

This function returns the caret (the text cursor) position within the editbox.

Syntax

int guiEditGetCaretIndex ( element theElement )

OOP Syntax Help! I don't understand this!

Method: GuiEdit:getCaretIndex(...)
Variable: .caretIndex
Counterpart: guiEditSetCaretIndex

Required Arguments

  • theElement: The edit box you want to get the caret position from

Returns

Returns the caret index on success, false otherwise.

Example

This example outputs the caret position of the edit field to the chat

local edit = guiCreateEdit(0.4,0.4,0.3,0.1,"",true)

addEventHandler("onClientGUIChanged",edit,function()
	outputChatBox("Caret index is: "..guiEditGetCaretIndex(edit)) -- output index to chat
end)

See Also

General functions

FROM VERSION 1.5.6 r16361 ONWARDS

Browsers

Buttons

Checkboxes

Comboboxes

Edit Boxes

Gridlists

FROM VERSION 1.5.6 r16204 ONWARDS

Memos

Progressbars

Radio Buttons

Scrollbars

Scrollpanes

Static Images

Tab Panels

Tabs

Text Labels

Windows

Input

GUI