GuiEditSetCaratIndex: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
mNo edit summary
No edit summary
Line 1: Line 1:
__NOTOC__  
__NOTOC__  
{{Client function}}
This function sets the current position of the carat (the text cursor) within the edit box.
This function sets the current position of the carat (the text cursor) within the edit box.


Revision as of 15:00, 11 August 2007

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

Syntax

bool guiEditSetCaratIndex ( element theElement, int index )

Required Arguments

  • theElement: The exit box to be changed.
  • index: An integer referring to the desired position within the box.

Returns

Returns true if the index was successful set, false otherwise.

Example

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 ) then --if he's holding down left control
		local text = guiGetText ( source )
		local textLength = string.len ( text )
		guiEditSetCaratIndex ( source, textLength )--set the carat index.  The function wont work anyway for other types of elements so no check is required.
	end
end
addEventHandler ( "onClientClick", getRootElement(), moveToEndOnClick )--add an event handler for this

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

Retrieved from "https://wiki.multitheftauto.com/wiki/GuiEditSetCaratIndex?oldid=10118"