Application
Web
Session
Var
MonkeyTerm Object Model
Object: Session
 Property Terminal(Index As Long) As Terminal Property CmdBox(Index As Long) As TextBox This is the white chat-window in the bottom of the session window Function CollapsePath(byval sPath As Variant) As String This will collapse a path. It reverses the effect of ExpandPath.
Function ExpandPath(byval sPath As String) As String This function will take a path and replace any occurances of %AppPath% with the application path and and %SessionPath% with the path of the session file.
Sub UpdateLayout() This will update the session layout. This might be needed after calls that alters sizes on different objects.
Sub Paste() This will paste the text from the clipboard to the command-box.
Sub Cut() This will copy the selected text to the clipboard. If the text is in the command-box it will be cut, but on the terminal it will work like a normal copy.
Sub Copy() This will copy the selected text to the clipboard.
Sub ShowTree([strPath As String = ""]) This will bring op the SessionTree, showing the aliases/actions/etc. nodes.
If strPath is set, the node with that name will be selected.
Sub EvaluateCommand(strCmd As String, [objMatches As Collection = Nothing], [Gag As Boolean = False], [bReset As Boolean = False]) This sub will evaluate a command ;) What it means is basically it will act as if you had typed the command in the command-box, meaning it will parse it for actions first.
strCmd is the command to be evaluated. objMatches should be left missing, Gag will cause the command to be supressed (not shown on the terminal). bReset should be left false, but can be used to overwrite the infinite-loop protection (NOT recommended).
Sub Disconnect() Will disconnect the session from the host.
Sub Connect() Will connect to the chosen host on the chosen IP.
Sub ShowOptions(OptionPage As OptionPageEnum) This sub will probably change so don't use it for scripting.
Property SessionName() As String Sets or reads the name of the session.
Sub Save([blnSaveAs As Boolean = False]) Saves the session. If blnSaveAs is set or if the filename of this session is empty, the user will be prompted for a filename before the save occurs.
Property TXTFilename() As String Sets or reads the name of the filename to log to. Can be set with full path or without. If only filename is set, the application.path will be used as path.
Property ANSIFilename() As String Sets or reads the name of the filename to log to. Can be set with full path or without. If only filename is set, the application.path will be used as path.
Property FileName() As String The name to save as when the session is saved.
Property Port() As Long Port number of the host to connect to.
Property Host() As String Name or IP of the host to connect to.
Property KeepCommand() As Boolean When set, the last command will be kept selected in the command-box.
Property SaveOnExit() As Boolean When set, the session will save before closing.
Property JumpOnOutput() As Boolean When set, the terminal window will jump to bottom when new text is written on the terminal.
Property JumpOnKeyPressed() As Boolean When set, the terminal window will jump to bottom when any key is pressed.
Property Web() As Web
|
