NotepadFont
Script function

world.NotepadFont

DOC_scripting Read about scripting

Type

Method

Summary

Changes the font and style of the selected notepad window

Prototype

long NotepadFont(BSTR Title, BSTR FontName, short Size, short Style, short Charset);

DOC_data_types View list of data type meanings

Description

This lets you change the font, font size, style, and character set of the font for an open notepad window.

eg.

NotepadFont ("test", "Comic Sans MS", 11, 0, 0)

The arguments are:

notepad name
font name
font size
style bits
character set

If the font name is empty, then the font is unchanged.

If the font size is zero, then the font size is unchanged. The font size is in points.

The style should be a combination of the numbers below (zero is just plain text). For instance, bold and italic would be 3.

Style bits:

1 = bold
2 = italic
4 = underline
8 = strikeout

VBscript example

NotepadFont "test", "Comic Sans MS", 11, 0, 0


Jscript example

NotepadFont ("test", "Comic Sans MS", 11, 0, 0);


Lua example

NotepadFont ("test", "Comic Sans MS", 11, 0, 0)


Lua notes

The charset argument is optional and defaults to zero.


Return value

0 = Could not do it (eg. that notepad does not exist)
1 = Font and style 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_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=NotepadFont)

DOC_contents Documentation contents page