_Added in 1.9.0_
*$editbox(window|editor,[N])*
Returns the text in the [[Editbox Control|Editbox]] of the specified window or the text in the current active Editor.
_See also [[$editboxhistory]], [[/editbox]]._
*Parameters*
table(ktable).
|*Parameter*|*Description*|
| window|editor | The window associated with the [[Editbox Control|Editbox]] to use or the current active Editor. |
| [N] | *TODO* (optional) |
*Properties*
table(ktable).
|*Property*|*Description*|
| .selstart | Returns the position of the first selected character. |
| .selend | - Returns the position of the last selected character. |
| .color | Gets the current [[Editbox Control|Editbox]] text color in [[$rgb]] format. *(AdiIRC only)* |
| .backcolor | Gets the current [[Editbox Control|Editbox]] background color in [[$rgb]] format. *(AdiIRC only)* |
| .rgbcolor | Gets the current [[Editbox Control|Editbox]] text color in rrr,ggg,bbb format. *(AdiIRC only)* |
| .rgbbackcolor | Gets the current [[Editbox Control|Editbox]] background color in rrr,ggg,bbb format. *(AdiIRC only)* |
| .spellcheckword | Gets the current word at the cursor position formatted for spellchecking. *(AdiIRC only)* |
| .currline | Returns the line where the cursor is in a multiline [[Editbox Control|Editbox]]. *(AdiIRC only)* |
| .lines | Returns the number of lines in a multiline [[Editbox Control|Editbox]]. *(AdiIRC only)* |
*Example*
; Open a custom window.
/window -e @Example
; Add 'Hello World' to the Editbox.
/editbox @Example Hello World
; Print the content of the Editbox.
//echo -ag Text is $editbox(@Example) selstart is $editbox(@Example).selstart selend is $editbox(@Example).selend
; Print the content of the current active Editor, must be triggered from a custom shortcut.
//echo -ag Text is $editbox(editor) selstart is $editbox(editor).selstart selend is $editbox(editor).selend