Add User-Defined Worksheets to IDE Editors

To integrate custom functionality into the Uniface IDE, you can use the Worksheet Plug-In API to create forms that can be added as worksheets to IDE editors. You must then add the components to the Uniface IDE resources and configure the IDE to use them.

Create a Form component that provides the functionality you want to add to an IDE editor. For more information, see Constructing Forms and Reports.
Set the Form's Window Type property to contained.
Implement the following mandatory operations plug-in operations:
For more information, see Worksheet Plug-In Operations
Optionally, implement the following operations, which enable the component to respond to IDE events:
For more information, see Worksheet Plug-In Operations
If the worksheet is used to modify objects, call IDE API operations to request the IDE to refresh objects and/or editors. For more information, see IDE API Operations.
Optionally, package your custom components into a Uniface archive file.
In the Uniface IDE assignment file, specify the location of the components in the [RESOURCES] section. You can specify a UAR, or the resources directory where the compiled components are located. For example:
```
[RESOURCES]
; D:\unifaceData\project\resources ; dir where IDE puts compiled components
D:\uniface10\project\USERWORKSHEETS.UAR 
usys:ide.uar
usys:ide_messages.uar
```
In the [LOGICALS] section of the Uniface IDE assignment file, define worksheet logicals to specify the editor and its custom worksheets. For example:
```
[LOGICALS]
;worksheet logicals
IDE_DEFINE_WORKSHEETS_PRJ=MY_VIEW, MY_EXPORT
IDE_DEFINE_WORKSHEETS_CPT=MY_VIEW			
...
```
If you have modified a worksheet’s logical definition, the IDE detects this and restarts the editor involved.
For more information, see Logicals for IDE Menu and Worksheet Plug-Ins.

Note: The IDE does not detect changes made to the title and tooltip (in the getWorksheetOptions operation). If you change these, you need to restart your Editor for the changes to take effect.