IDE Worksheet Plug-Ins

Worksheet plug-ins are contained forms that can be added as user-defined worksheets to editors for main development objects, such as the entity editor and the component editor. It is possible to define multiple worksheets for each type of editor.

You can add a worksheet that is applicable to all objects to each editor, and add object-specific worksheets only to the applicable editor. They let you integrate functionality that is specific to your environment or workflow into the IDE. For example, you could add worksheets for customized exports or source code control integration.

The Worksheet API describes operations to be implemented in each worksheet plug-in. The IDE instantiates each worksheet plug-in the first time the applicable editor is started. It then calls these operations when you open an object editor, select the worksheet or select another worksheet, rename the current object, or when the editor is refreshed.

The IDE provides a callback API component (IDE_API_1) which the worksheet can activate when it needs to have the IDE to perform an action, such as refreshing one or more editors or sending a message to the Messages tab.

To plug in the worksheet components, you need to configure the IDE so it knows which worksheets to include in each editor, and where to find the worksheet components. For example:

[RESOURCES]
;specify the location of resources that the IDE needs			
usys:customWorksheets.uar
;D:\unifaceData\10301\project\resources\
usys:ide.uar
usys:ide_messages.uar	
...

[LOGICALS]
;worksheet logicals
IDE_DEFINE_WORKSHEETS_PRJ=MY_EXPORT
IDE_DEFINE_WORKSHEETS_CPT=MY_STATS,MY_EXPORT			
...

For more information, see Logicals for IDE Menu and Worksheet Plug-Ins.

User-defined worksheets

User-defined worksheets 'Statistics'and 'Export', added to component editor.

Related Topics