A user-defined worksheet is a contained form component that implements worksheet operations, which can be called by the Uniface IDE. These operations ensure that the worksheet can respond appropriately to IDE events.
Your worksheet component must implement the following operations:
- getVersion—return the version number of the API that the worksheet uses.
- getWorksheetOptions—return a Struct containing the worksheet title and tooltip.
- ws_activate—start the component with the context provided by the IDE.
Note: If you don't define all three operations, warnings are displayed in the Message Output tab.
To enable the component to respond to IDE events, it can implement the following optional operations :
- ws_getsVisible—activated after ws_activate, and when the worksheet is selected and becomes visible.
- ws_getsInvisible—activated when another worksheet or editor is selected and the current worksheet becomes invisible.
- ws_objectRenamed—activated when the current Main Development Object is renamed.
- ws_refresh—activated when the IDE issues a request to refresh the current editor.
Note: The operations ws_getsVisible and ws_getsInvisible are fired asynchronously. It therefore is not guaranteed that the ws_getsVisible operation is always fired after the ws_getsInvisible operation when switching between two IDE Editors and user-defined worksheets.
