GuiEditGetCaretIndex: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(OOP syntax)
 
Line 8: Line 8:
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
int guiEditGetCaretIndex ( element theElement )
int guiEditGetCaretIndex ( element theElement )
</syntaxhighlight>  
</syntaxhighlight>
{{OOP||[[Element/GUI/Edit_field|GuiEdit]]:getCaretIndex|caretIndex|guiEditSetCaretIndex}}


===Required Arguments===  
===Required Arguments===  

Latest revision as of 20:53, 7 November 2018

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

Browsers

Buttons

Checkboxes

Comboboxes

Edit Boxes

Gridlists

Memos

Progressbars

Radio Buttons

Scrollbars

Scrollpanes

Static Images

Tab Panels

Tabs

Text Labels

Windows

Input

GUI


Retrieved from "https://wiki.multitheftauto.com/wiki/GuiEditGetCaretIndex?oldid=60496"