FormIt Plugin API  v23.0.0 (2023.0.0)
FormIt.Commands API

Description

Functions

json FormIt.Commands.GetCommands ()
 Get the list of commands in FormIt. More...
 
json FormIt.Commands.DoCommand (command)
 Execute given command. More...
 
json FormIt.Commands.RegisterJSCommand (command)
 Register the given command which will show up in the list of shortcuts. More...
 

Function Documentation

json FormIt.Commands.DoCommand ( command  )

Execute given command.

FormIt.Commands.GetCommands returns the list of available commands.

Parameters
[in]commandString
Returns
bool Success
json FormIt.Commands.GetCommands ( )

Get the list of commands in FormIt.

Commands are used to execute features in FormIt.

Returns
An array of FormIt Commands.
json FormIt.Commands.RegisterJSCommand ( command  )

Register the given command which will show up in the list of shortcuts.

RegisterJSCommand just takes a string that is the JS function to call. FormIt.Commands.DoCommand will call the given 'command' that is passed in.

ToolbarPlugin = {};
ToolbarPlugin.Button = function()
{
console.log("Toolbar Plugin button clicked!!");
}
FormIt.Commands.RegisterJSCommand("ToolbarPlugin.Button");
Parameters
[in]commandString
Returns
JSON_UNDEFINED