Custom Function Editor

The Custom Function Editor allows you to define and maintain custom functions without having to edit HTML and JavaScript files. Using the Custom Function Editor, you can add or delete a custom function. You can then go to the Keyboard Remap dialog, choose Custom Functions from the Category list, and your defined custom functions will appear in the list available for remapping. You can also assign a toolbar button to a custom function from the Keystroke page of the Customize Toolbar dialog.

To add a custom function:

1. Start from a host session window.
   • Click Edit > Preferences > Keyboard. From the Key Assignment tab, select the Custom Functions button.
     or
   • Click Edit > Preferences > Toolbar > Add Button. From the Add Button panel, select the Keystroke tab and then select the Custom Functions button.
2. The Custom Function Editor dialog will be displayed.
3. Select Add to display the Add a Custom Function dialog.
4. Enter a name and data for the custom function (for example, you could specify to automate a logout by entering Logout in the Name field and logout[enter] in the Data field).

   The Name value displays in the Keyboard Remap and Customize Toolbar function list box. The Data value is what the emulator processes when the remapped key or toolbar button is pressed.

   See below for more information on the Data value.

5. Select OK.
6. After you have successfully assigned all the custom functions you want, select OK.

   Selecting OK causes all data to be stored, and your defined custom functions will appear in the Custom Functions Category list on the Keyboard Remap and Customize Toolbar dialogs.

To delete a custom function:

1. Start from a host session window.
   • Click Edit > Preferences > Keyboard. From the Key Assignment tab, select the Custom Functions button.
     or
   • Click Edit > Preferences > Toolbar > Add Button. From the Add Button panel, select the Keystroke tab and then select the Custom Functions button.
2. The Custom Function Editor dialog will be displayed.
3. Select a custom function from the Custom Function list, and select Delete. A Confirm Deletion dialog will appear.
4. Select OK.
5. After you have successfully deleted all the custom functions you want, select OK.

   Selecting OK causes all data to be saved, and your selected custom functions will be deleted from the Custom Functions Category list on the Keyboard Remap and Customize Toolbar dialogs.

There are three rules to keep in mind when specifying the Data value.

• Bracket encoding
  Host On-Demand supports the ability to process SendKeys mnemonics, so to send a bracket, you must use all double brackets [[ ]]. Single open and close brackets [ ] are translated as field boundaries for SendKeys mnemonics.

  For more information, refer to SendKeys mnemonics.

• Carat encoding
  The carat (^) is used to send characters that cannot be displayed. Place a ^ in front of any character with a value greater than or equal to A (hex 41, decimal 65) to translate to that value minus hex 40 or decimal 64; for example, "^A" = = hex 01, "^B = = hex 02, and so on. The only way to get a ^ into the datastream is to double it. In other words, ^^ is equal to ^ in the datastream.

• Unicode encoding
  You can use Unicode encoding to put displayable and non-displayable characters into the datastream. Unicode encoding uses the format \uxxxx where xxxx is two hex bytes. The value for the escape character is \u001b.

Related topics: