SendToNotepad
Script function

world.SendToNotepad

DOC_scripting Read about scripting

Type

Method

Summary

Creates a notepad and sends text to it

Prototype

boolean SendToNotepad(BSTR Title, BSTR Contents);

DOC_data_types View list of data type meanings

Description

Creates a notepad window with the nominated title and contents.

The contents are copied "as is" without a trailing newline. If you want a newline you will need to add it yourself. The built-in constant "vbcrlf" can be used for this purpose in Visual Basic.

VBscript example

world.SendToNotepad "Nick's window", "Hello, world" & _
              vbcrlf & "another line"


Jscript example

world.SendToNotepad("Nick's window", 
                    "Hello, world\r\nanother line")


PerlScript example

$world->SendToNotepad("Nick's window", 
                  "Hello, world\r\nanother line");


Python example

world.SendToNotepad("Nick's window", 
                    "Hello, world\r\nanother line")


Lua example

SendToNotepad ("Nick's window", 
               "Hello, world\r\nanother line")


Lua notes

You can supply multiple arguments after the notepad name, which are concatenated together.


Return value

0: Window not created.
1:  Window created 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_GetNotepadText GetNotepadText (Gets the text from a 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)

(Help topic: function=SendToNotepad)

DOC_contents Documentation contents page