GetNotepadText
Script function

world.GetNotepadText

DOC_scripting Read about scripting

Type

Method

Summary

Gets the text from a notepad window

Prototype

BSTR GetNotepadText(BSTR Title);

DOC_data_types View list of data type meanings

Description

Returns the text from the specified notepad window.

If a notepad of that name does not exist an empty string is returned.

VBscript example

world.Note world.GetNotepadText("mynotes")


Jscript example

world.Note (world.GetNotepadText ("mynotes"));


PerlScript example

Note (GetNotepadText ("mynotes"));


Python example

world.Note (world.GetNotepadText ("mynotes"))


Lua example

Note (GetNotepadText ("mynotes"))


Return value

The text from the specified notepad window.

If that notepad does not exist, an empty string is returned.



See Also ...

Topic

DOC_notepad Notepad

Functions

FNC_Activate Activate (Activates the world window)
FNC_ActivateNotepad ActivateNotepad (Activates a notepad window)
FNC_AppendToNotepad AppendToNotepad (Appends text to a notepad window)
FNC_CloseNotepad CloseNotepad (Closes a notepad window)
FNC_GetNotepadLength GetNotepadLength (Gets the length of the text in 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=GetNotepadText)

DOC_contents Documentation contents page