Script function
world.GetNotepadText
Read about scripting
Type
Method
Summary
Gets the text from a notepad window
Prototype
BSTR GetNotepadText(BSTR Title);
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.
Available in MUSHclient version 3.40 onwards.
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
Notepad
Functions
(Activate) Activates the world window
(ActivateNotepad) Activates a notepad window
(AppendToNotepad) Appends text to a notepad window
(CloseNotepad) Closes a notepad window
(GetNotepadLength) Gets the length of the text in a notepad window
(GetNotepadList) Gets the list of open notepads - returning their titles
(MoveNotepadWindow) Move and resize the specified notepad window
(NotepadColour) Changes the text and background colour of the selected notepad window
(NotepadFont) Changes the font and style of the selected notepad window
(NotepadReadOnly) Make a selected notepad window read-only
(NotepadSaveMethod) Changes the save method for this notepad window
(ReplaceNotepad) Replaces text in a notepad window
(SaveNotepad) Saves a notepad window to disk
(SendToNotepad) Creates a notepad and sends text to it
(Help topic: function=GetNotepadText)