AppendToNotepad
Script function

world.AppendToNotepad

DOC_scripting Read about scripting

Type

Method

Summary

Appends text to a notepad window

Prototype

boolean AppendToNotepad(BSTR Title, BSTR Contents);

DOC_data_types View list of data type meanings

Description

Appends the text to a notepad window of the given title. If no such window exists, it is created.

The function "AppendToNotepad" does not activate (bring to the front) the notepad window. However the function "ActivateNotepad" can be used to do that.

You can use world.activate to activate the world itself (eg. you might want to do that after creating a notepad window).

You might use GetNotepadLength to check if there is likely to be room in the notepad for the new text.

VBscript example

world.AppendToNotepad "Nick's window", "More stuff" + vbcrlf


Jscript example

world.AppendToNotepad("Nick's window", "More stuff\r\n");


PerlScript example

$world->AppendToNotepad("Nick's window", "More stuff\r\n");


Python example

world.AppendToNotepad("Nick's window", "More stuff\r\n")


Lua example

AppendToNotepad("Nick's window", "More stuff\r\n",
                "another line")


Lua notes

You can supply multiple arguments after the notepad name, which are concatenated together.


Return value

0: Could not do it.
1:  Appended OK



See Also ...

Topic

DOC_notepad Notepad

Functions

FNC_Activate Activate (Activates the world window)
FNC_ActivateNotepad ActivateNotepad (Activates a notepad window)
FNC_CloseNotepad CloseNotepad (Closes a notepad window)
FNC_GetNotepadLength GetNotepadLength (Gets the length of the text in a notepad window)
FNC_GetNotepadText GetNotepadText (Gets the text from a notepad window)
FNC_MoveNotepadWindow MoveNotepadWindow (Move and resize the specified notepad window)
FNC_NotepadColour NotepadColour (Changes the text and background colour of the selected notepad window)
FNC_NotepadFont NotepadFont (Changes the font and style of the selected notepad window)
FNC_NotepadSaveMethod NotepadSaveMethod (Changes the save method for this notepad window)
FNC_ReplaceNotepad ReplaceNotepad (Replaces text in a notepad window)
FNC_SaveNotepad SaveNotepad (Saves a notepad window to disk)
FNC_SendToNotepad SendToNotepad (Creates a notepad and sends text to it)

(Help topic: function=AppendToNotepad)

DOC_contents Documentation contents page