Register forum user name Search FAQ

NotepadFont

Script function

world.NotepadFont

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);

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


Available in MUSHclient version 3.57 onwards.



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

Notepad

Functions

(ActivateNotepad) Activates a notepad window
(AppendToNotepad) Appends text to a notepad window
(CloseNotepad) Closes a notepad window
(GetMainWindowPosition) Returns the position and size of the main MUSHclient 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
(GetWorldWindowPosition) Returns the position and size of the current world window
(MoveMainWindow) Move and resize the main MUSHclient window
(MoveNotepadWindow) Move and resize the specified notepad window
(MoveWorldWindow) Move and resize a world window
(NotepadColour) Changes the text and background colour of the selected notepad window
(NotepadReadOnly) Make a selected notepad window read-only
(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=NotepadFont)

Documentation contents page


Search ...

Enter a search string to find matching documentation.

Search for:   

Information and images on this site are licensed under the Creative Commons Attribution 3.0 Australia License unless stated otherwise.