Scripting Reference

• System Scripting Reference
• Plug-In Scripting Reference

The DreamFactory language has two types of commands and functions: system and plug-in. The system commands are universally available core routines that manage nodes and perform other generally useful functions. The plug-in commands are associated with a specific plug-in and usually control the appearance of the node. This Scripting Reference guide documents the system and plug-in commands and functions available in DreamFactory. All of this information is also provided in-context and on-line in the DreamFactory software environment as well. Type Control-slash on Windows or Command-slash on Macintosh to invoke the Help System.

System Scripting Reference

The system routines are native DreamFactory commands and functions that can be used with any node. The routines are grouped by name and function. The link below will take you to the System Scripting Reference:

System Scripting Reference

Project Messages: projectopen, projectidle, projectclose

Mouse Messages: mousedown, mouseup, mousemove, mouseenter, mouseexit, mousedoubleclick

Keyboard Messages: keydown, keyup, keyrepeat, keyenter, keyexit, keycommand, keydata

Node Messages: nodeopen, nodeclose, nodeshow, nodehide, noderesize

Network Messages: webtransferdone, servertransaction

Plug-In Scripting Reference

The Plug-In Scripting Reference provides an overview of the commands and functions for the 17 standard DreamFactory plug-ins. These commands and functions are normally preceded by the plug-in's name. For example, the "draw" plug-in command "styleset" would normally be used as:

draw.styleset("mynodename", "oval")

As soon as you type "draw" you will be prompted with all of the possible draw plug-in commands and functions, check the information bar at the top of the Script Editing Window or at the bottom of the Message Box to see this information. You can also omit the plug-in name like this:

styleset("mynodename", "oval")

In this case the plug-in name is calculated dynamically at runtime. Including the plug-in name allows the scripting language to pre-bind to the desired plug-in, and also allows for syntax hiliting, prompting, and auto-correction of typing. Most plug-in commands and functions can also be used as methods or even properties. All of the following are legal language constructions:

mynodename.style = "oval"
mynodename.draw.style = "oval"
mynodename.styleset("oval")
mynodename.draw.styleset("oval")

The first argument is the destination object, which can be a raw node name, a variable holding a node name, or the reserved words "me", "target", "hit", or "this." The plug-in name is optional as described above. The string "oval" and any other simple name can be used with or without quotes, single unquoted names are recognized as strings unless there is a variable by that name.

Border Plug-In Scripting Reference

Button Plug-In Scripting Reference

Chart Plug-In Scripting Reference

Draw Plug-In Scripting Reference

Desktop Plug-In Scripting Reference

Guage Plug-In Scripting Reference

Icon Plug-In Scripting Reference

List Plug-In Scripting Reference

Menu Plug-In Scripting Reference

Movie Plug-In Scripting Reference

Picture Plug-In Scripting Reference

Sound Plug-In Scripting Reference

Slider Plug-In Scripting Reference

Sprite Plug-In Scripting Reference

Text Plug-In Scripting Reference

Table Plug-In Scripting Reference

Window Plug-In Scripting Reference

XML Plug-In Scripting Reference