NotepadReadOnly
Script function

world.NotepadReadOnly

DOC_scripting Read about scripting

Type

Method

Summary

Make a selected notepad window read-only

Prototype

long NotepadReadOnly(BSTR Title, BOOL ReadOnly);

DOC_data_types 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.



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

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_GetNotepadLength GetNotepadLength (Gets the length of the text in a notepad window)
FNC_GetNotepadList GetNotepadList (Gets the list of open notepads - returning their titles)
FNC_GetNotepadText GetNotepadText (Gets the text from a notepad window)
FNC_GetNotepadWindowPosition GetNotepadWindowPosition (Returns the position and size of the specified notepad window)
FNC_MoveNotepadWindow MoveNotepadWindow (Move and resize the specified notepad 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=NotepadReadOnly)

DOC_contents Documentation contents page