GuiMemoSetCaretIndex: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(New page: __NOTOC__ {{Client function}} This function sets the current position of the caret (the text cursor) within the memo. ==Syntax== <syntaxhighlight lang="lua"> bool guiMemoSetCaretIndex ( gui-memo theMe...)
 
(Add missing OOP info)
 
(4 intermediate revisions by 4 users not shown)
Line 7: Line 7:
bool guiMemoSetCaretIndex ( gui-memo theMemo, int index )
bool guiMemoSetCaretIndex ( gui-memo theMemo, int index )
</syntaxhighlight>  
</syntaxhighlight>  
{{OOP||[[GuiMemo]]:setCaretIndex|caretIndex|guiMemoGetCaretIndex}}


===Required Arguments===  
===Required Arguments===  
*'''theMemo:''' The memo edit box where the caret position is to be changed.
*'''theMemo:''' The memo edit box where the caret position is to be changed.
*'''index:''' An integer referring to the desired position within the box.
*'''index:''' An integer referring to the desired character position within the box. 0 would be before the first character in the box, 1 before the second, etc.


===Returns===
===Returns===
Line 16: Line 17:


==Example==
==Example==
[[Category:Needs Example]]
This example would create a memo and set the caret before the "H" in "Hi".
<syntaxhighlight lang="lua">local memo = guiCreateMemo(100,100,200,100,"Hi",false)
guiMemoSetCaretIndex(memo,0)--sets the caret before H
</syntaxhighlight>


==See Also==
==See Also==
{{GUI_functions}}
{{GUI_functions}}
{{GUI_events}}

Latest revision as of 13:54, 10 August 2021

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

Syntax

bool guiMemoSetCaretIndex ( gui-memo theMemo, int index )

OOP Syntax Help! I don't understand this!

Method: GuiMemo:setCaretIndex(...)
Variable: .caretIndex
Counterpart: guiMemoGetCaretIndex


Required Arguments

  • theMemo: The memo edit box where the caret position is to be changed.
  • index: An integer referring to the desired character position within the box. 0 would be before the first character in the box, 1 before the second, etc.

Returns

Returns true if the caret was successfully moved, false otherwise.

Example

This example would create a memo and set the caret before the "H" in "Hi". 

local memo = guiCreateMemo(100,100,200,100,"Hi",false)
guiMemoSetCaretIndex(memo,0)--sets the caret before H

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/GuiMemoSetCaretIndex?oldid=71644"