world.NotepadFont

MUSHclient script function (Method) — introduced in version 3.57

Changes the font and style of the selected notepad window

Prototype

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

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.

Related topic

Notepad

See also