Platforms to show: All Mac Windows Linux Cross-Platform

Back to RemoteControlMBS module.

Next items

RemoteControlMBS.LinuxConvertCase(keysymbol as Integer, byref lowerSymbol as Integer, byref upperSymbol as Integer) as boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Remote Control MBS ComputerControl Plugin 8.4 ❌ No ❌ No ✅ Yes ❌ No Desktop, Console & Web
Converts the case of the given keysymbol.

In lowerSymbol you will receive the key symbol for a lower case key and in upperSymbol the uppercase keys.

So passing in the key symbol of "a" or "A" will both return "a" and "A".

RemoteControlMBS.LinuxKeyCodeToKeySymbol(keycode as Integer, index as Integer) as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Remote Control MBS ComputerControl Plugin 8.4 ❌ No ❌ No ✅ Yes ❌ No Desktop, Console & Web
Returns from the keyboard mapping tables the key symbol for the given key code.

Index is the offset in the tables. 0 for the first key symbol and 1 for the second. If the user presses shift the keyboard driver uses index=1 to access the capital letters.

Some examples using this method:

RemoteControlMBS.LinuxKeyNameToKeySymbol(keyname as string) as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Remote Control MBS ComputerControl Plugin 8.4 ❌ No ❌ No ✅ Yes ❌ No Desktop, Console & Web
Searches the key mapping list for the key symbol for a given name.

Returns 0 on failure.

RemoteControlMBS.LinuxKeySymbolToKeyCode(keysymbol as Integer) as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Remote Control MBS ComputerControl Plugin 8.4 ❌ No ❌ No ✅ Yes ❌ No Desktop, Console & Web
Searches the hardware dependend key code for the given key symbol.

Returns 0 on any error.

RemoteControlMBS.LinuxKeySymbolToKeyName(keysymbol as Integer) as string

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Remote Control MBS ComputerControl Plugin 8.4 ❌ No ❌ No ✅ Yes ❌ No Desktop, Console & Web
Returns the name of the key symbol.

Can return "" on an invalide keysymbol value.

Some examples using this method:

RemoteControlMBS.LinuxMouseClick(ButtonID as Integer, ButtonDown as boolean) as boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Remote Control MBS ComputerControl Plugin 8.4 ❌ No ❌ No ✅ Yes ❌ No Desktop, Console & Web
Simulates a mouse click with the given button.

ButtonID=1 is the left mouse button.
Returns true on success.

Be aware that the user may get into trouble if you forget to release a mouse button you pressed before. So always call this method another time to release the mouse buttons.

Some examples using this method:

RemoteControlMBS.LinuxMousePositionX as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Remote Control MBS ComputerControl Plugin 8.4 ❌ No ❌ No ✅ Yes ❌ No Desktop, Console & Web
Queries the current mouse position.

RemoteControlMBS.LinuxMousePositionY as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Remote Control MBS ComputerControl Plugin 8.4 ❌ No ❌ No ✅ Yes ❌ No Desktop, Console & Web
Queries the current mouse position.

RemoteControlMBS.LinuxMoveMouse(x as Integer, y as Integer) as boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Remote Control MBS ComputerControl Plugin 8.4 ❌ No ❌ No ✅ Yes ❌ No Desktop, Console & Web
Moves the mouse to the given position.

Returns true on success.

Some examples using this method:

RemoteControlMBS.LinuxPressControlKey(keydown as boolean) as boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Remote Control MBS ComputerControl Plugin 8.4 ❌ No ❌ No ✅ Yes ❌ No Desktop, Console & Web
Presses the ctrl key.

Returns true on success.

Be aware that the user may get into trouble if you forget to release a key you pressed before. So always call this method another time to release the key.

RemoteControlMBS.LinuxPressKey(Keycode as Integer) as boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Remote Control MBS ComputerControl Plugin 8.4 ❌ No ❌ No ✅ Yes ❌ No Desktop, Console & Web
Presses the key with the given keycode.

Performs a key down and a key up event.
Returns true on success.

See also:

Some examples using this method:

RemoteControlMBS.LinuxPressKey(Keycode as Integer, ButtonDown as boolean) as boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Remote Control MBS ComputerControl Plugin 8.4 ❌ No ❌ No ✅ Yes ❌ No Desktop, Console & Web
Performs a key event.

Returns true on success.

Be aware that the user may get into trouble if you forget to release a key you pressed before. So always call this method another time to release the key.

See also:

RemoteControlMBS.LinuxPressOptionKey(keydown as boolean) as boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Remote Control MBS ComputerControl Plugin 8.4 ❌ No ❌ No ✅ Yes ❌ No Desktop, Console & Web
Presses the alt key.

Returns true on success.

Be aware that the user may get into trouble if you forget to release a key you pressed before. So always call this method another time to release the key.

RemoteControlMBS.LinuxPressShiftKey(keydown as boolean) as boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Remote Control MBS ComputerControl Plugin 8.4 ❌ No ❌ No ✅ Yes ❌ No Desktop, Console & Web
Presses the shift key.

Returns true on success.

Be aware that the user may get into trouble if you forget to release a key you pressed before. So always call this method another time to release the key.

Some examples using this method:

RemoteControlMBS.LinuxSupported as boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Remote Control MBS ComputerControl Plugin 8.4 ❌ No ❌ No ✅ Yes ❌ No Desktop, Console & Web
Whether the functions are available for simulation of keyboard and mouse events.

Returns true if the Xtest extension is installed.

RemoteControlMBS.MacCurrentProcessID as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Remote Control MBS ComputerControl Plugin 8.4 ✅ Yes ❌ No ❌ No ❌ No Desktop, Console & Web
Returns the process ID of your application.

Returns 0 on any error.

RemoteControlMBS.MacCurrentProcessName as string

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Remote Control MBS ComputerControl Plugin 8.4 ✅ Yes ❌ No ❌ No ❌ No Desktop, Console & Web
Returns the name of the current process.
Example
msgbox RemoteControlMBS.MacCurrentProcessName

This is the name of your application.

RemoteControlMBS.MacDescriptionForKeyCode(keycode as Integer) as string

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Remote Control MBS ComputerControl Plugin 8.4 ✅ Yes ❌ No ❌ No ❌ No Desktop, Console & Web
Translates a keycode to a string for displaying.

Keycodes which match a special key like "Return", "F1" or "Backspace" are returned as descriptive strings.

RemoteControlMBS.MacDisplayNameForKeyCode(keycode as Integer) as string

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Remote Control MBS ComputerControl Plugin 8.4 ✅ Yes ❌ No ❌ No ❌ No Desktop, Console & Web
Translates a keycode to a string for displaying.

Same as MacTextForKeyCode(keycode, 4)

Some examples using this method:

RemoteControlMBS.MacForegroundProcessID as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Remote Control MBS ComputerControl Plugin 8.4 ✅ Yes ❌ No ❌ No ❌ No Desktop, Console & Web
Returns the process ID of the application in the foreground.

Returns 0 on any error.

RemoteControlMBS.MacFrontProcessName as string

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Remote Control MBS ComputerControl Plugin 8.4 ✅ Yes ❌ No ❌ No ❌ No Desktop, Console & Web
The name of the front process.
Example
RemoteControlMBS.MacFrontProcessName="iChat" // move iChat to front

(Read and Write computed property)

RemoteControlMBS.MacKeyboardLocalizedName as string

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Remote Control MBS ComputerControl Plugin 8.4 ✅ Yes ❌ No ❌ No ❌ No Desktop, Console & Web
The localized name of the current keyboard layout.

Returns "" on any error.

RemoteControlMBS.MacKeyboardName as string

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Remote Control MBS ComputerControl Plugin 8.4 ✅ Yes ❌ No ❌ No ❌ No Desktop, Console & Web
The name of the current keyboard layout.

Returns "" on any error.

Added 64-bit support for version 17.0.

RemoteControlMBS.MacMouseClick(x as Double, y as Double, updateMouseCursorPosition as boolean, MouseButton1 as boolean) as boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Remote Control MBS ComputerControl Plugin 8.4 ✅ Yes ❌ No ❌ No ❌ No Desktop, Console & Web
Clicks the mouse buttons on the given position.
Example
// doing a context menu click with control key:

dim x,y as Integer
x=System.MouseX
y=System.MouseY

call RemoteControlMBS.PressControlKey true
call RemoteControlMBS.MacMouseClick x, y, true, true
call RemoteControlMBS.MacMouseClick x, y, true, false
call RemoteControlMBS.PressControlKey false

Returns true on success.
If updateMouseCursorPosition is true the mouse position is updated on screen.

Be aware that the user may get into trouble if you forget to release a mouse button you pressed before. So always call this method another time to release the mouse buttons.

See also:

Some examples using this method:

RemoteControlMBS.MacMouseClick(x as Double, y as Double, updateMouseCursorPosition as boolean, MouseButton1 as boolean, MouseButton2 as boolean) as boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Remote Control MBS ComputerControl Plugin 8.4 ✅ Yes ❌ No ❌ No ❌ No Desktop, Console & Web
Clicks the mouse buttons on the given position.
Example
// do a right click:

dim x,y as Integer
x=System.MouseX
y=System.MouseY

call RemoteControlMBS.MacMouseClick x, y, true, false, true
call RemoteControlMBS.MacMouseClick x, y, true, false, false

Returns true on success.
If updateMouseCursorPosition is true the mouse position is updated on screen.

Be aware that the user may get into trouble if you forget to release a mouse button you pressed before. So always call this method another time to release the mouse buttons.

See also:

RemoteControlMBS.MacMouseClick(x as Double, y as Double, updateMouseCursorPosition as boolean, MouseButton1 as boolean, MouseButton2 as boolean, MouseButton3 as boolean) as boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Remote Control MBS ComputerControl Plugin 8.4 ✅ Yes ❌ No ❌ No ❌ No Desktop, Console & Web
Clicks the mouse buttons on the given position.

Returns true on success.
If updateMouseCursorPosition is true the mouse position is updated on screen.

Be aware that the user may get into trouble if you forget to release a mouse button you pressed before. So always call this method another time to release the mouse buttons.

See also:

RemoteControlMBS.MacMousePositionX as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Remote Control MBS ComputerControl Plugin 8.4 ✅ Yes ❌ No ❌ No ❌ No Desktop, Console & Web
Queries the current mouse position.

RemoteControlMBS.MacMousePositionY as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Remote Control MBS ComputerControl Plugin 8.4 ✅ Yes ❌ No ❌ No ❌ No Desktop, Console & Web
Queries the current mouse position.

RemoteControlMBS.MacMouseWheel(wheel1 as Integer) as boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Remote Control MBS ComputerControl Plugin 8.4 ✅ Yes ❌ No ❌ No ❌ No Desktop, Console & Web
Performs a wheel event.
Example
call RemoteControlMBS.MacMouseWheel 1

Returns true on success.
A typical value for the wheel changes are in range from -10 to 10.

See also:

RemoteControlMBS.MacMouseWheel(wheel1 as Integer, wheel2 as Integer) as boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Remote Control MBS ComputerControl Plugin 8.4 ✅ Yes ❌ No ❌ No ❌ No Desktop, Console & Web
Performs a wheel event.
Example
call RemoteControlMBS.MacMouseWheel 10,5

Returns true on success.
A typical value for the wheel changes are in range from -10 to 10.

See also:

RemoteControlMBS.MacMoveMouse(x as Double, y as Double) as boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Remote Control MBS ComputerControl Plugin 8.4 ✅ Yes ❌ No ❌ No ❌ No Desktop, Console & Web
Moves the mouse to the given position.
Example
call RemoteControlMBS.MacMoveMouse(100,100)

Returns true on success.
On Mac does not generate mouse events.

Some examples using this method:

RemoteControlMBS.MacPressCommandKey(keydown as boolean) as boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Remote Control MBS ComputerControl Plugin 8.4 ✅ Yes ❌ No ❌ No ❌ No Desktop, Console & Web
Presses the command key.

Returns true on success.

Be aware that the user may get into trouble if you forget to release a key you pressed before. So always call this method another time to release the key.

RemoteControlMBS.MacPressControlKey(keydown as boolean) as boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Remote Control MBS ComputerControl Plugin 8.4 ✅ Yes ❌ No ❌ No ❌ No Desktop, Console & Web
Presses the ctrl key.

Returns true on success.

Be aware that the user may get into trouble if you forget to release a key you pressed before. So always call this method another time to release the key.

RemoteControlMBS.MacPressKey(keychar as Integer, virtualkey as Integer) as boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Remote Control MBS ComputerControl Plugin 8.4 ✅ Yes ❌ No ❌ No ❌ No Desktop, Console & Web
Presses the given key.

keychar is the ASCII code of the key you press and virtualkey is the key code.
Returns true on success.
Peforms a key down and a key up event.

See also:

Some examples using this method:

RemoteControlMBS.MacPressKey(keychar as Integer, virtualkey as Integer, keydown as boolean) as boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Remote Control MBS ComputerControl Plugin 8.4 ✅ Yes ❌ No ❌ No ❌ No Desktop, Console & Web
Presses the given key.

keychar is the ASCII code of the key you press and virtualkey is the key code.
Returns true on success.

Be aware that the user may get into trouble if you forget to release a key you pressed before. So always call this method another time to release the key.

See also:

RemoteControlMBS.MacPressOptionKey(keydown as boolean) as boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Remote Control MBS ComputerControl Plugin 8.4 ✅ Yes ❌ No ❌ No ❌ No Desktop, Console & Web
Presses the option key. (labeled with alt)

Returns true on success.

Be aware that the user may get into trouble if you forget to release a key you pressed before. So always call this method another time to release the key.

RemoteControlMBS.MacPressShiftKey(keydown as boolean) as boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Remote Control MBS ComputerControl Plugin 8.4 ✅ Yes ❌ No ❌ No ❌ No Desktop, Console & Web
Presses the shift key.

Returns true on success.

Be aware that the user may get into trouble if you forget to release a key you pressed before. So always call this method another time to release the key.

Some examples using this method:

RemoteControlMBS.MacProcessCount as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Remote Control MBS ComputerControl Plugin 8.4 ✅ Yes ❌ No ❌ No ❌ No Desktop, Console & Web
Counts the high level processes.
Example
msgBox str(remoteControlMBS.macprocessCount)

RemoteControlMBS.MacProcessName(index as Integer) as string

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Remote Control MBS ComputerControl Plugin 8.4 ✅ Yes ❌ No ❌ No ❌ No Desktop, Console & Web
The name of the process with the given index.
Example
dim i,c as Integer

// search iChat and make it visible
c=remoteControlMBS.macprocesscount
for i=0 to c-1
if remoteControlMBS.macprocessname(i)="iChat" then
remoteControlMBS.macprocessVisible(i)=true
end if
next

Index is from 0 to MacProcessCount-1.

RemoteControlMBS.MacProcessVisible(index as Integer) as boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Remote Control MBS ComputerControl Plugin 8.4 ✅ Yes ❌ No ❌ No ❌ No Desktop, Console & Web
Whether a process is visible or not.
Example
dim i,c as Integer

// search Safari and make it invisible
c=remoteControlMBS.macprocesscount
for i=0 to c-1
if remoteControlMBS.macprocessname(i)="Safari" then
remoteControlMBS.macprocessVisible(i)=false
end if
next

Index is from 0 to MacProcessCount-1.
(Read and Write computed property)

RemoteControlMBS.MacTextForKeyCode(keycode as Integer, KeyAction as Integer, ModifierState as Integer) as string

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Remote Control MBS ComputerControl Plugin 8.4 ✅ Yes ❌ No ❌ No ❌ No Desktop, Console & Web
Translates a keycode to a string.
Example
// try some keycodes like e, E, € or é
dim key as string = "@"

const kCommandKey = 1
const kShift = 2
const kCapsLock = 4
const kOption = 8
const kControl = 16

// with no modifiers
for i as Integer = 0 to 127

dim s as string = RemoteControlMBS.MacTextForKeyCode(i, 3, 0)

if StrComp(key, s, 0) = 0 then
MsgBox "Found with keycode "+str(i)
Return
end if

next

// with shift
for i as Integer = 0 to 127

dim s as string = RemoteControlMBS.MacTextForKeyCode(i, 3, kShift)

if StrComp(key, s, 0) = 0 then
MsgBox "Found with keycode "+str(i)+" with Shift"
Return
end if

next

// with option
for i as Integer = 0 to 127

dim s as string = RemoteControlMBS.MacTextForKeyCode(i, 3, kOption)

if StrComp(key, s, 0) = 0 then
MsgBox "Found with keycode "+str(i)+" with Option"
Return
end if

next

Works only with Unicode keyboard layouts which need Mac OS X 10.5.

Modifier values:
Command Key1
Shift2
CapsLock4
Option8
Control16

Possible constants for the Key Action:
kUCKeyActionDown0The user is pressing the key.
kUCKeyActionUp1The user is releasing the key.
kUCKeyActionAutoKey2The user has the key in an "auto-key" pressed state that is, the user is holding down the key for an extended period of time and is thereby generating multiple key strokes from the single key.
kUCKeyActionDisplay3The user is requesting information for key display, as in the Key Caps application.

Some examples using this method:

RemoteControlMBS.MouseClick(x as Integer, y as Integer, down as boolean) as boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Remote Control MBS ComputerControl Plugin 8.4 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
Performs a mouse click.

The mouse cursor is moved to the given position and the first mouse button is pressed.
Returns true on success.

RemoteControlMBS.MousePositionX as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Remote Control MBS ComputerControl Plugin 12.3 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
Queries the current mouse position.

RemoteControlMBS.MousePositionY as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Remote Control MBS ComputerControl Plugin 12.3 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
Queries the current mouse position.

RemoteControlMBS.MoveMouse(x as Integer, y as Integer) as boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Remote Control MBS ComputerControl Plugin 8.4 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
Moves the mouse to the given location.

Returns true on success.
On Mac does not generate mouse events.

RemoteControlMBS.PressControlKey(keydown as boolean) as boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Remote Control MBS ComputerControl Plugin 8.4 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
Presses the ctrl key.

Returns true on success.

Next items

The items on this page are in the following plugins: MBS ComputerControl Plugin.


The biggest plugin in space...