get-text

Arguments: window-or-widget &key return-crlf

Returns as a string the text of a window or dialog-item. For a text control (such as an editable-text control or a multi-line-editable-text control) or a text-edit-pane, the returned text is the contents of the control or pane, while for other windows the title is returned. Note that for a text control, the returned text will always be the actual text that is presently displayed in the control, even if the user has just typed it in and the value of the dialog-item has not yet been updated to reflect the new text because the control still has the keyboard focus.

The return-crlf argument no longer has any effect, and is kept for backward compatibility only. It was used on the Windows platform by an earlier version of the RichEdit control.

The length of the returned string is returned as a second value.

See also set-text, which can be used to set the text in a text-edit-pane.

Copyright (c) 1998-2016, Franz Inc. Oakland, CA., USA. All rights reserved.
This page was not revised from the 8.1 page.
Created 2010.1.21.