ClassesClassesClassesClasses | | | | Operators

new_linenew_lineNewLinenew_lineNewLineNewLine (Operator)

Name

new_linenew_lineNewLinenew_lineNewLineNewLine — Set the position of the text cursor to the beginning of the next line.

Signature

new_line( : : WindowHandle : )

Herror new_line(const Hlong WindowHandle)

Herror T_new_line(const Htuple WindowHandle)

Herror new_line(const HTuple& WindowHandle)

void HWindow::NewLine() const

void NewLine(const HTuple& WindowHandle)

void HWindow::NewLine() const

void HOperatorSetX.NewLine([in] VARIANT WindowHandle)

void HWindowX.NewLine()

static void HOperatorSet.NewLine(HTuple windowHandle)

void HWindow.NewLine()

Description

new_linenew_lineNewLinenew_lineNewLineNewLine sets the position of the text cursor to the beginning of the next line. The new position depends on the current font. The left end of the baseline for writing the following text string (not considering descenders) is placed on this position.

If the next line does not fit into the window the content of the window is scrolled by the height of one line in the upper direction. In order to reach the correct new cursor position the font used in the next line must be set before new_linenew_lineNewLinenew_lineNewLineNewLine is called. The position is changed by the output or input of text (write_stringwrite_stringWriteStringwrite_stringWriteStringWriteString, read_stringread_stringReadStringread_stringReadStringReadString) or by an explicit change of position by (set_tpositionset_tpositionSetTpositionset_tpositionSetTpositionSetTposition).

Parallelization

Parameters

WindowHandleWindowHandleWindowHandleWindowHandleWindowHandlewindowHandle (input_control)  window HWindow, HTupleHTupleHTupleHWindowX, VARIANTHtuple (integer) (IntPtr) (Hlong) (Hlong) (Hlong) (Hlong)

Window identifier.

Result

new_linenew_lineNewLinenew_lineNewLineNewLine returns 2 (H_MSG_TRUE) if the window is valid. Otherwise an exception is raised.

Possible Predecessors

open_windowopen_windowOpenWindowopen_windowOpenWindowOpenWindow, open_textwindowopen_textwindowOpenTextwindowopen_textwindowOpenTextwindowOpenTextwindow, set_fontset_fontSetFontset_fontSetFontSetFont, write_stringwrite_stringWriteStringwrite_stringWriteStringWriteString

Alternatives

get_tpositionget_tpositionGetTpositionget_tpositionGetTpositionGetTposition, get_string_extentsget_string_extentsGetStringExtentsget_string_extentsGetStringExtentsGetStringExtents, set_tpositionset_tpositionSetTpositionset_tpositionSetTpositionSetTposition, move_rectanglemove_rectangleMoveRectanglemove_rectangleMoveRectangleMoveRectangle

See also

write_stringwrite_stringWriteStringwrite_stringWriteStringWriteString, set_fontset_fontSetFontset_fontSetFontSetFont

Module

Foundation


ClassesClassesClassesClasses | | | | Operators