getWorksheetOptions

Parameters

pWorksheet—a simple Struct with following members:

• title—worksheet title to be displayed in the editor's worksheet tabs; mandatory.
• tooltip—text of tooltip to be displayed when the user hovers over the worksheet title; can be empty.

Description

The Uniface IDE calls this operation when it starts an editor that has been configured to have a worksheet plug-in. It uses the information to populate the editor's worksheet tab strip, so the worksheet plug-in must implement this operation. Otherwise an error is returned.

Note: If you change the title or tooltip after adding a worksheet to an editor, the IDE does not detect these changes. You need to restart the editor for the changes to take effect.

Example

For example, the following code builds the simple Struct for the output parameter. For more information, see Structs.

operation getWorkSheetOptions
  params
    struct pWorkSheet : out
  endparams

  pWorkSheet = $newstruct
  pWorkSheet->title = "Export"
  pWorkSheet->tooltip = "Use this worksheet to export updated sources from the current Project"
				
end ; getWorkSheetOptions