Topics   All   Mac OS X (Only)   Windows (Only)   Linux (Only, Not)   iOS (Only, Not)  
Components   Crossplatform Mac & Win   Server (Not)   Client   Old   Guides   Examples
New in version: 6.2   6.3   6.4   6.5   7.0   7.1   7.2   7.3   7.4   7.5    Statistic  

HotKey.SetScript

Sets which script to call if hotkey is pressed.

Component Version macOS Windows Server FileMaker Cloud FileMaker iOS SDK
HotKey 5.0 Yes Yes No No No

MBS( "HotKey.SetScript"; HotKeyRef; Filename; ScriptName )

Parameters

Parameter Description Example value
HotKeyRef The reference value for the hotkey as returned by HotKey.Register function. $hotkey
Filename The database file name where the script is located. "test.fmp12"
ScriptName The script name. "MyScript"

Result

Returns OK or error.

Description

Sets which script to call if hotkey is pressed.

With plugin version 6.0 or newer the script name can be a script ID number. In that case the plugin queries the script name for the given script ID. This allows to call scripts by ID and avoid problems if scripts are later renamed.

Examples

Register Control-F5:

Set Field [HotKeys::HotKey ID; MBS("HotKey.Register"; "F5"; "control")]
Set Variable [$r; Value:MBS("HotKey.SetScript"; HotKeys::HotKey ID; Get(FileName); "HotkeyAction")]

See also

Example Databases


HotKey.SetName   -   HotKey.SetTag

Feedback: Report problem or ask question.




Links
MBS Xojo Plugins