User Tools

Site Tools


action:Custom_HTML_Prompt

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
Last revision Both sides next revision
action:Custom_HTML_Prompt [2021/03/03 10:26]
JMichaelTX [Using JavaScript] Add link to Forum Resizing post
action:Custom_HTML_Prompt [2021/12/07 00:52]
peternlewis
Line 1: Line 1:
-{{:​action:​html-form-icon.png?​nolink|}} 
 ====== Custom HTML Prompt Action ====== ====== Custom HTML Prompt Action ======
  
Line 14: Line 13:
   - If you want default values in the form, set these //​Variables//​ in a [[action:​Set_Variable_to_Text|Set Variable to Text]] Action   - If you want default values in the form, set these //​Variables//​ in a [[action:​Set_Variable_to_Text|Set Variable to Text]] Action
   - Execute the //Custom HTML Prompt// Action   - Execute the //Custom HTML Prompt// Action
-    * The HTML code can be in a file, or as text in the Action+    * The HTML code can be in a ''​.html'' ​file, or as text (html code) in the Action
   - When the User clicks on the OK button, the //Keyboard Maestro Variables// will be updated   - When the User clicks on the OK button, the //Keyboard Maestro Variables// will be updated
   - Use these //​Variables//​ in any other Actions you need   - Use these //​Variables//​ in any other Actions you need
Line 22: 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 115: 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/​6) | +`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.Calculate( '10 + 32' ) | returns the result of the calculation | +`window.KeyboardMaestro.ProcessAppleScript( 'tell app "​Finder"​ to activate'​ )` | executes the AppleScript and returns the result (v10.0+) | 
-| window.KeyboardMaestro.Trigger( macro, value ) | triggers the specified macro (7.1+) |+| `window.KeyboardMaestro.Calculate( '10 + 32' )| returns the result of the calculation | 
 +`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 161: Line 162:
 * [[action:​Prompt_for_User_Input|Prompt for User Input]] * [[action:​Prompt_for_User_Input|Prompt for User Input]]
 * [[action:​Prompt_With_List|Prompt With List]] action * [[action:​Prompt_With_List|Prompt With List]] action
 +* [[action:​Prompt_for_Screen_Rectangle|Prompt for Screen Rectangle]] action
 * [[action:​Prompt_for_File|Prompt for File]] action * [[action:​Prompt_for_File|Prompt for File]] action
 * [[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]]
  
Line 180: Line 183:
 - [[https://​forum.keyboardmaestro.com/​t/​corrupted-variables-after-custom-html-setvariable-update-i-fixed-it-please-read/​2881|Corrupted Variables after Custom HTML SetVariable (Update: I fixed it)]] - [[https://​forum.keyboardmaestro.com/​t/​corrupted-variables-after-custom-html-setvariable-update-i-fixed-it-please-read/​2881|Corrupted Variables after Custom HTML SetVariable (Update: I fixed it)]]
 - [[https://​forum.keyboardmaestro.com/​t/​custom-html-result-button-value-when-prompt-is-closed/​3213/​2|Custom HTML Result Button value when prompt is closed]] - [[https://​forum.keyboardmaestro.com/​t/​custom-html-result-button-value-when-prompt-is-closed/​3213/​2|Custom HTML Result Button value when prompt is closed]]
 +- [Resizing Window Using Current Position](https://​forum.keyboardmaestro.com/​t/​resizing-html-window-with-javascript-keyboardmaestro-resizewindow-moves-it/​21579/​7)
 - [[https://​forum.keyboardmaestro.com/​t/​png-optimizer/​3282|PNG Optimizer]] - [[https://​forum.keyboardmaestro.com/​t/​png-optimizer/​3282|PNG Optimizer]]
 - [[https://​forum.keyboardmaestro.com/​search?​q=Custom%20HTML%20Prompt%20action|Keyboard Maestro Forum topics about Custom HTML Prompt action]] - [[https://​forum.keyboardmaestro.com/​search?​q=Custom%20HTML%20Prompt%20action|Keyboard Maestro Forum topics about Custom HTML Prompt action]]
Line 191: Line 195:
   * [Atom](https://​atom.io/​) -- A hackable text editor for the 21st Century. ​ It is a free and open-source text and source code editor for macOS, Linux, and Microsoft Windows with support for plug-ins written in JavaScript, and embedded Git Control, developed by GitHub.   * [Atom](https://​atom.io/​) -- A hackable text editor for the 21st Century. ​ It is a free and open-source text and source code editor for macOS, Linux, and Microsoft Windows with support for plug-ins written in JavaScript, and embedded Git Control, developed by GitHub.
   * [Visual Studio Code](https://​code.visualstudio.com/​) -- a freeware source-code editor made by Microsoft for Windows, Linux and macOS. Features include support for debugging, syntax highlighting,​ intelligent code completion, snippets, code refactoring,​ and embedded Git. Users can change the theme, keyboard shortcuts, preferences,​ and install extensions that add additional functionality   * [Visual Studio Code](https://​code.visualstudio.com/​) -- a freeware source-code editor made by Microsoft for Windows, Linux and macOS. Features include support for debugging, syntax highlighting,​ intelligent code completion, snippets, code refactoring,​ and embedded Git. Users can change the theme, keyboard shortcuts, preferences,​ and install extensions that add additional functionality
-  * FIXME  Wiki editors: ​ please add HTML editors you have found that work well. 
  
  
action/Custom_HTML_Prompt.txt · Last modified: 2021/12/11 10:14 by peternlewis