Insert and configure a custom widget

Use the Custom Widget command to select and insert an instance of custom widget in a project screen, and then configure the object properties of that instance.

Remember that all instances of a widget share the same basic properties and events, as you defined them when you created the widget and added it to your project's library, but you can customize these properties and events for each instance of the widget. Specifically, you can configure the object properties of an instance in order to associate tags with properties and attach scripts to events.

To insert and configure a custom widget:

1. Make sure you have the correct project screen open in the Screen/Worksheet editor.

2. On the Draw tab of the ribbon, in the Libraries group, click Custom Widget.

   The Custom Widgets dialog box is displayed. This dialog box lists all of the widgets that have been added to your project's library.

3. In the list, select the custom widget that you want to insert into the project screen, and then click OK.

   The dialog box is closed and the a new instance of the widget is inserted.

4. Use the standard screen editing tools to adjust the size and position of the widget, if necessary.

5. To open the widget's object properties, do one of the following:

   • Select the widget/object, and then on the Draw tab of the ribbon, in the Editing group, click Properties.

   • Right-click the widget/object, and then on the shortcut menu, click Properties.

   • Double-click the widget/object.

   The Object Properties dialog box for that widget is displayed. The name of the master widget is displayed in the Custom Widget box, and the name of this instance of the widget is displayed in the Name box.

6. Click Members.

   The Members dialog box is displayed. It shows all of the properties and events that you defined when you created the custom widget and added it to your project's library.

7. Click the Properties tab, and then for each property in the list, type the tag/expression that should be associated with the property.

   Whenever the value of the tag/expression changes, it updates the value of the property in the widget's web files. Whenever the value of the property changes, it updates the associated tag.

   Tip: You can double-click in the Tag/Expression box in order to open the Object Finder and use it to compose the tag/expression.

8. Click the Events tab, and then for each event in the list, attach a script:

   1. In the Script box, click the … button.

      A standard script editor is displayed.

   2. Compose the script as you would in any other VBScript interface in Studio.

      Note: Only VBScript is supported at this time.

   3. Click OK to save the script and close the script editor.

   Whenever the specified event is received from the widget's web files, it causes the script to be executed.

9. Click OK to close the Members dialog box.

10. Close the Object Properties dialog box.