This shows you the differences between two versions of the page.
Both sides previous revision Previous revision Next revision | Previous revision Last revision Both sides next revision | ||
action:Custom_HTML_Prompt [2021/10/15 04:32] peternlewis [Using JavaScript] |
action:Custom_HTML_Prompt [2021/12/07 00:52] peternlewis |
||
---|---|---|---|
Line 21: | Line 21: | ||
By default, the window floats above all others, but you can optionally turn off *Floating* (v8+) in the gear BUTTON{{{⚙}}} menu. | By default, the window floats above all others, but you can optionally turn off *Floating* (v8+) in the gear BUTTON{{{⚙}}} menu. | ||
- | You can optionally turn on *Resizable* (v8+) in the gear BUTTON{{{⚙}}} menu. | + | You can optionally turn on *Resizable* (v8+), make the window *Transparent* (v10.0+), or turn off the *Window Title Bar* (v10.0+) in the gear BUTTON{{{⚙}}} menu. |
You design the HTML form using standard HTML code, which can be stored in either a file or as text in the Action. You can, of course, use any Web/HTML editor you like. If you'd like some suggestions, see the [[Custom_HTML_Prompt#WebHTML_Editors|Web/HTML Editors]] section at the bottom of this page for editors that others have found useful. | You design the HTML form using standard HTML code, which can be stored in either a file or as text in the Action. You can, of course, use any Web/HTML editor you like. If you'd like some suggestions, see the [[Custom_HTML_Prompt#WebHTML_Editors|Web/HTML Editors]] section at the bottom of this page for editors that others have found useful. | ||
Line 114: | Line 114: | ||
^ Function ^ Called ^ | ^ Function ^ Called ^ | ||
- | | KMInit() | to initialize fields or other features| | + | | `KMInit()` | to initialize fields or other features| |
- | | KMWindow() | to return the desired size or frame of the window as a string| | + | | `KMWindow()` | to return the desired size or frame of the window as a string| |
- | | KMWillShowWindow() | when the window will be shown| | + | | `KMWillShowWindow()` | when the window will be shown| |
- | | KMDidShowWindow() | when the window was just shown (v7.1+) | | + | | `KMDidShowWindow()` | when the window was just shown (v7.1+) | |
- | | KMHandleSchemes() | to return the schemes you wish to handle within the web page (v8+) | | + | | `KMHandleSchemes()` | to return the schemes you wish to handle within the web page (v8+) | |
- | | KMWillCloseWindow() | called when the window is about to be closed (v8.0.3+) | | + | | `KMWillCloseWindow()` | called when the window is about to be closed (v8.0.3+) | |
From within the window, you can call the following functions: | From within the window, you can call the following functions: | ||
^ Function ^ Purpose ^ | ^ Function ^ Purpose ^ | ||
- | | window.KeyboardMaestro.Submit( buttonName ) | submit the form and write the *Keyboard Maestro Variables* | | + | | `window.KeyboardMaestro.Submit( buttonName )` | submit the form and write the *Keyboard Maestro Variables* | |
- | | window.KeyboardMaestro.Cancel( buttonName ) | close the window, do not write the *Keyboard Maestro Variables* | | + | | `window.KeyboardMaestro.Cancel( buttonName )` | close the window, do not write the *Keyboard Maestro Variables* | |
- | | window.KeyboardMaestro.ResizeWindow( "1,2,3,4" ) | resize the window to the specified size or frame as a string with commas ("width,height" or "left,top,width,height")\\ Also see [Resizing Window Using Current Position](https://forum.keyboardmaestro.com/t/resizing-html-window-with-javascript-keyboardmaestro-resizewindow-moves-it/21579/7) | | + | | `window.KeyboardMaestro.ResizeWindow( "1,2,3,4" )` | resize the window to the specified size or frame as a string with commas ("width,height" or "left,top,width,height")\\ Also see [Resizing Window Using Current Position](https://forum.keyboardmaestro.com/t/resizing-html-window-with-javascript-keyboardmaestro-resizewindow-moves-it/21579/7) | |
- | | window.KeyboardMaestro.GetVariable( 'KMVariableName' ) | returns the value of a variable | | + | | `window.KeyboardMaestro.GetVariable( 'KMVariableName' )` | returns the value of a variable | |
- | | window.KeyboardMaestro.SetVariable( 'KMVariableName', 'value' ) | sets the value of a variable | | + | | `window.KeyboardMaestro.SetVariable( 'KMVariableName', 'value' )` | sets the value of a variable | |
- | | window.KeyboardMaestro.GetDictionary( 'Dictionary', 'Key' ) | returns the value of a dictionary entry | | + | | `window.KeyboardMaestro.GetDictionary( 'Dictionary', 'Key' )` | returns the value of a dictionary entry | |
- | | window.KeyboardMaestro.SetDictionary( 'Dictionary', 'Key', 'value' ) | sets the value of a dictionary entry | | + | | `window.KeyboardMaestro.SetDictionary( 'Dictionary', 'Key', 'value' )` | sets the value of a dictionary entry | |
- | | window.KeyboardMaestro.ProcessTokens( '%ShortDate%' ) | returns the text token expansion | | + | | `window.KeyboardMaestro.ProcessTokens( '%ShortDate%' )` | returns the text token expansion | |
- | | window.KeyboardMaestro.ProcessAppleScript( 'tell app "Finder" to activate' ) | executes the AppleScript and returns the result (v10.0+) | | + | | `window.KeyboardMaestro.ProcessAppleScript( 'tell app "Finder" to activate' )` | executes the AppleScript and returns the result (v10.0+) | |
- | | window.KeyboardMaestro.Calculate( '10 + 32' ) | returns the result of the calculation | | + | | `window.KeyboardMaestro.Calculate( '10 + 32' )` | returns the result of the calculation | |
- | | window.KeyboardMaestro.Trigger( macro, value ) | triggers the specified macro (7.1+) | | + | | `window.KeyboardMaestro.Trigger( macro, value )` | triggers the specified macro (7.1+) | |
+ | | `window.KeyboardMaestro.Log( 'Message' )` | log a message in the Engine.log file (10.0.2+) | | ||
Prior to version 7.1, using SetVariable to set a value to something other than a string can [corrupt the variable](https://forum.keyboardmaestro.com/t/corrupted-variables-after-custom-html-setvariable-update-i-fixed-it-please-read/2881). | Prior to version 7.1, using SetVariable to set a value to something other than a string can [corrupt the variable](https://forum.keyboardmaestro.com/t/corrupted-variables-after-custom-html-setvariable-update-i-fixed-it-please-read/2881). | ||
Line 165: | Line 166: | ||
* [[action:Get_Touch_Bar_Selection|Get Touch Bar Selection]] action | * [[action:Get_Touch_Bar_Selection|Get Touch Bar Selection]] action | ||
* [[action:Show_Palette_of_Macros|Show Palette of Macros]] action | * [[action:Show_Palette_of_Macros|Show Palette of Macros]] action | ||
+ | * [[action:Display_Progress|Display Progress]] action | ||
* [[:Actions|See all Actions]] | * [[:Actions|See all Actions]] | ||