NotepadColour
Script function

world.NotepadColour

DOC_scripting Read about scripting

Type

Method

Summary

Changes the text and background colour of the selected notepad window

Prototype

long NotepadColour(BSTR Title, BSTR TextColour, BSTR BackgroundColour);

DOC_data_types View list of data type meanings

Description

This lets you set the text and background colour of an open notepad window.

eg.

AppendToNotepad ("test", "but does it get goat's blood out?") -- create window
NotepadColour ("test", "whitesmoke", "saddlebrown") -- change its colour

The colours are specified by colour name - you can use the MUSHclient colour picker to see all possible colour names, or type: world.Debug ("colours").

You can also specify colours in HTML format, like this:

NotepadColour ("test", "#FAEBD7", "#FFB6C1")

VBscript example

NotepadColour "test", "#FAEBD7", "#FFB6C1"
NotepadColour "test", "whitesmoke", "saddlebrown"


Jscript example

NotepadColour ("test", "#FAEBD7", "#FFB6C1");
NotepadColour ("test", "whitesmoke", "saddlebrown");


Lua example

NotepadColour ("test", "#FAEBD7", "#FFB6C1")
NotepadColour ("test", "whitesmoke", "saddlebrown")


Return value

0 = Could not do it (eg. that notepad does not exist, one of those colours do not exist)
1 = Colours changed OK.



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_GetMainWindowPosition GetMainWindowPosition (Returns the position and size of the main MUSHclient 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_GetNotepadWindowPosition GetNotepadWindowPosition (Returns the position and size of the specified notepad window)
FNC_GetWorldWindowPosition GetWorldWindowPosition (Returns the position and size of the current world window)
FNC_MoveMainWindow MoveMainWindow (Move and resize the main MUSHclient window)
FNC_MoveNotepadWindow MoveNotepadWindow (Move and resize the specified notepad window)
FNC_MoveWorldWindow MoveWorldWindow (Move and resize a world 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=NotepadColour)

DOC_contents Documentation contents page