GetNotepadList
Script function

world.GetNotepadList

DOC_scripting Read about scripting

Type

Method

Summary

Gets the list of open notepads - returning their titles

Prototype

VARIANT GetNotepadList(boolean All);

DOC_data_types View list of data type meanings

Description

Returns a variant array which is a list of all open notepad windows.

If more than one notepad has the same title you may get duplicates.

If the argument (All) is true, then all notepad windows for the MUSHclient application are returned.

If the argument is false, then only "related" notepads for the current world are returned. Related notepads are those created from the world (eg. by AppendToNotepad), and are not ones manually created (eg. by the player).

Note that most notepad-related functions only apply to related notepads - that is, ones that "belong" to the world calling them.

VBscript example

for each name in world.GetNotepadList
  world.Note name
next


Jscript example

notepadlist = new VBArray(world.GetNotepadList()).toArray();

if (notepadlist )  // if not empty
 for (i = 0; i < notepadlist.length; i++)
   world.note(notepadlist [i]);


PerlScript example

foreach $item (Win32::OLE::in ($world->GetNotepadList))
 {
 $world->note($item);
 }


Python example

notepadlist = world.GetNotepadList
if (notepadlist):
  for w in notepadlist : world.Note (w)


Lua example

for k, v in pairs (GetNotepadList()) do 
  Note (v) 
end


Lua notes

The argument "All" is optional, and defaults to false.


Return value

If there are no notepads open then the return value is empty. Use "IsEmpty" to test for this possibility.

Otherwise, it returns a variant array containing the titles of all the notepads. Use "ubound" to find the number of notepads in the list.



See Also ...

Topic

DOC_notepad Notepad

Functions

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_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_NotepadReadOnly NotepadReadOnly (Make a selected notepad window read-only)
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=GetNotepadList)

DOC_contents Documentation contents page