Scripting Interface

To use the Scripting Interface, follow the steps below.

1. Click on Plugins on the PlanSwift Main Menu Ribbon Bar (Figure 1).
   
   
                 Figure 1
   
   
2. Click on the Tools Manager on the Plugins Ribbon-bar Menu (Figure 2).
   
   
               Figure 2
   
   
3. In the Tools Manager window (Figure 3), click on the green plus (+). Note that the yellow folder icon allows a new folder to be created for storage of plugins. The blue gear icon allows the viewing of properties for any plugin in the window below. The red "X" icon allows for a plugin to be deleted. The green triangular icon allows a selected plugin to be executed.
   
   
               Figure 3
   
   
4. In the Properties - [New Plugin] window, give the new plugin a name, such as "Stucco" or whatever name you choose for the new plugin (Figure 4).
   
   
                  Figure 4
   
   
5. Select the Plugin Type by clicking on the Plugin Type selection arrow and then selecting Script Code from the drop-down menu (Figure 5).
   
   
                Figure 5
   
   
   
6. The Plugin Type is now displayed as Script Code (arrow 1 in Figure 6). Doubleclicking on the Icon (arrow 1) or the LargeIcon (arrow 2) allows the selection of a small Icon or a LargeIcon. Double-click on the LargeIcon (arrow 3).
   
   
   
                Figure 6
   
   
   
7. This opens an Explorer window (Figure 7) allowing the selection of an icon. From here, it is possible to navigate to a different directory and select an icon, then click on Open to use that selected icon; but, for now, select Cancel to retain the default green puzzle-piece icon.
   
   
                 Figure 7
   
   
   
8. The next step is to select where you want the new icon to appear: OnStartup, On Image Menu, or On Ribbon Bar. For this exercise, select On Ribbon Bar (arrow 1), select Tools from the Ribbon Tab drop-down (arrow 2), select Takeoff Item from the Ribbon Group drop-down (arrow 3), and then click on Ok. 
   
   
               Figure 8
   
   
   
9. Click on the Tools tab on the Main Ribbon-bar, and you will see the new "Stucco" plugin displayed in the Takeoff Item group (Figure 9).
   
   
                  Figure 9
   
   
10. Double-click on the Stucco plugin in the Tools Manager window to re-open the Properties - [Stucco] window (Figure 10). Click on Edit.
    
    
              Figure 10
    
    
11. This opens the Script Code - Script Editor window (Figure 11). The large Script Editor window on the right is where plugin code is written. The Code Explorer window will list variables and procedures as they are coded into the Script Editor window. The Help window contains the COM Object Model and Scripting selections available to use in the Script Editor window. Clicking on the "+" symbol opens the folder and subfolders. Click on the "+" left of COM Object Model, then click on the "+" left of the IPlanswift folder. 
    
    
                   Figure 11
    
    
    
12. The COM Object Model selections are now available in the Help window (Figure 12). Click on Current Version, then click on the circled question mark directly below the Help label.
    
    
                 Figure 12
    
    
    
13. Clicking on CurrentVersion (arrow 1 of Figure 13), then clicking on the question mark (arrow 2), opens the CurrentVersion window (arrow 3), which provides the Declaration form of the item selected and a Source Code Example. Source code may be copied and pasted into the Script Editor window and then modified as needed, or the CurrentVersion selection can be double-clicked on and will appear in the Script Editor window at the cursor's last position. The Close Script, Run Script, Debug Script, Break Points, and Script Parameter sections provide the code editing functions useful in programming API's.
    
    
                 Figure 13