About the native Script Editor debugging tools

The native script editor (Edit Form/Global Script dialog box) provides several basic debugging tools you can use to help troubleshoot problems with scripts. These tools are represented by three tabs located in the lower left corner of the Windows client script editor.

Note: These tools are for very basic debugging only. To do more serious troubleshooting and debugging, including the setting of breakpoints, the ability to step through the code, and so on, we recommend the use of Visual Studio.

The Error List tab

The Error List tab lists and describes syntax and build errors as they occur. So, when a squiggly red underline appears in the code, this is often the first and most useful tool to figure out what the error is. Until a build of the code is at least attempted, no build errors display in this list.

The Error List tab displays the total number of errors currently present in the script next to the tab label, enclosed in parentheses ( ).

When you click the tab, the notebook expands and displays the list of errors. You can then pin this tab open, if you wish. Along with the basic error description, the line entry also shows which line, which character in the line, and what type of error it is.

When you double-click an entry in the list, the Script window moves the cursor and the focus to the error location.

The Output tab

The Output tab contains content only after a build has been at least attempted. After a build has been attempted, whether it was successful or not, this tab displays a log of the build results. Especially when a build fails, this can also be a valuable tool to aid in troubleshooting build errors.

This display includes the results only of the last build attempt.

The References tab

The References tab displays a list of all references to any DLLs or other .NET assemblies used in the current script project.

This list includes any references to .NET assemblies made within the script itself, using the //<Ref> assemblyName </Ref> syntax, where assemblyName is the name of the .NET assembly you want to include. As you develop your script, the script editor constantly monitors for any //<Ref> assemblyName </Ref> syntax, looking for any references that have been added or removed, so as to keep this list current.

Any references made with the //<Ref> assemblyName </Ref> syntax are identified in the list by an asterisk in parentheses (*). You can locate the reference for such an assembly by double-clicking the reference entry in the list. This highlights the line where the reference is made.

About the Compile for Debug option

Note: You must have Visual Studio installed on your system to use this feature.

The Options tab includes a Compile for Debug option. When selected, this option enables the Debug option on the Script menu. When the Debug option is selected, WinStudio opens the Editing Script in Visual Studio dialog box with the Compile for Debug option selected, and then it opens the script in a Visual Studio IDE window. This allows you to set break points and debug your script in the Visual Studio environment.