Script function
world.NotepadReadOnly
Read about scripting
Type
Method
Summary
Make a selected notepad window read-only
Prototype
long NotepadReadOnly(BSTR Title, BOOL ReadOnly);
View list of data type meanings
Description
This lets you mark a notepad window as read-only.
This might be useful for help screens or other "output-only" information.
You can specify true or false as the second argument. Under Lua, it defaults to true.
Available in MUSHclient version 4.30 onwards.
VBscript example
NotepadReadOnly "test", vbTrue
Jscript example
NotepadReadOnly ("test", true);
Lua example
NotepadReadOnly ("test", true)
Lua notes
The ReadOnly argument is optional and defaults to true.
Return value
0 = Could not do it (eg. that notepad does not exist)
1 = Changed status OK.
See Also ...
Topic
Notepad
Functions
(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
(GetNotepadText) Gets the text from a notepad window
(GetNotepadWindowPosition) Returns the position and size of the specified 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
(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=NotepadReadOnly)