Script function

world.GetNotepadLength

Type

Method

Summary

Gets the length of the text in a notepad window

Prototype

long GetNotepadLength(BSTR Title);

Description

Find the length of the text in the specified notepad window.

If a notepad of that name does not exist a length of zero is returned.

Available in MUSHclient version 3.40 onwards.

VBscript example

world.Note world.GetNotepadLength ("mynotes")

Jscript example

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

PerlScript example

Note (GetNotepadLength ("mynotes"));

Python example

world.Note (str (world.GetNotepadLength ("mynotes")));

Lua example

Note (GetNotepadLength ("mynotes"))

Return value

The length of the text in the specified notepad, in characters.

If that notepad does not exist, zero 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
(GetNotepadList) Gets the list of open notepads - returning their titles
(GetNotepadText) Gets the text from a notepad window
(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=GetNotepadLength)