Topics   All   MacOS (Only)   Windows (Only)   Linux (Only, Not)   iOS (Only, Not)  
Components   Crossplatform Mac & Win   Server   Client   Old   Deprecated   Guides   Examples   Videos
New in version: 9.3   9.4   9.5   10.0   10.1   10.2   10.3   10.4   10.5   10.6    Statistic    FMM    Blog  

HotKey.SetEvaluate

Sets expression to be run when hotkey is pressed.

Component Version macOS Windows Linux Server FileMaker iOS SDK
HotKey 6.1 Yes Yes No No No
MBS( "HotKey.SetEvaluate"; HotKeyRef; Expression )   More

Parameters

Parameter Description Example
HotKeyRef The reference value for the hotkey as returned by HotKey.Register function. $hotkey
Expression The expression to evaluate.
Can be in local language of FileMaker Pro or english.
For Server must always be in english.		 "Let ( $$Done = 1 ; 1 )"

Result

Returns OK or error.

Description

Sets expression to be run when hotkey is pressed.
In the expression the text $$ID$$ will be replaced when evaluated with the hotkey reference, so you can pass it to other functions if needed.

Examples

Sets expression to run when hotkey is pressed:

Set Variable [ $result ; Value: MBS( "HotKey.SetEvaluate"; $curl; "Let ( $$Cancelled = 1 ; 1 )" ) ]

Set to write to a log file when a key is pressed:

MBS( "HotKey.SetEvaluate"; $hotkey; "MBS(\"Text.AppendTextFile\"; Get(CurrentHostTimeStamp) & \": Key F5 pressed¶\"; \"/Users/cs/Desktop/hotkey.txt\"; \"native\")")

Register Control-F5 for showing/hiding data viewer:

Set Variable [$hotkey; Value:MBS("HotKey.Register"; "F5"; "control")]
Set Variable [$r; Value:MBS( "HotKey.SetEvaluate"; $hotkey; "MBS(\"Menubar.RunMenuCommand\"; 49297)" )]

Register Control-F5 to write text file on desktop with content of data viewer:

MBS( "HotKey.SetEvaluate";
    MBS("HotKey.Register"; "F5"; "control");
    "MBS( \"Text.WriteTextFile\";
        MBS( \"FM.DataViewerContent\" );
        MBS( \"Path.AddPathComponent\";
            MBS( \"Folders.UserDesktop\" );
            \"Data Viewer \" & substitute(substitute(Get(CurrentTimestamp); \":\"; \"-\"); \"/\"; \"-\") & \".txt\" );
        \"UTF-8\"
    )"
)

Register Control-F6 to write current script a text file to desktop:

MBS( "HotKey.SetEvaluate";
    MBS("HotKey.Register"; "F6"; "control");
    "MBS( \"Text.WriteTextFile\";
        MBS( \"ScriptWorkspace.ScriptText\" );
        MBS( \"Path.AddPathComponent\";
            MBS( \"Folders.UserDesktop\" );
            \"Script \" & substitute(substitute(MBS( \"ScriptWorkspace.CurrentTab\" ); \":\"; \"-\"); \"/\"; \"-\") & \".txt\" );
        \"UTF-8\"
    )"
)

See also

Blog Entries

FileMaker Magazin

Created 4th March 2016, last changed 16th December 2020


HotKey.SetEnabled   -   HotKey.SetIgnoreOnModal

Feedback: Report problem or ask question.



Links
MBS FileMaker blog

Start Chat