Status: Validated

Code Editor Help Features


IntelliPrompt displays a list of available words while you type code within the Code Editor.

IntelliPrompt display

The IntelliPrompt list consists of the following parts:

  • The list itself (1),
  • The list filter (2),
  • The 'QuickInfo tooltip' (3).

IntelliPrompt List Filtering

The suggested List is filtered by:

  • The context of the code (for example: Mantis),
  • The word typed (for example: pa).
    The filtering is updated while the word is typed,
  • The list filter (2).

In this exemple, the list displays all the properties and methods of Mantis starting with pa.

The list filter (2) lets you:

  • include/exclude properties from the list ,
  • include/exclude methods from the list .


IntelliPrompt Validation

To validate a list entry:

  • Select the desired entry,
  • Hit the Enter or Tab key.

The word entered is replaced by the selected list entry.

To cancel and close the list entry, hit the Escape key.


QuickInfo Tooltip

The QuickInfo tooltip (3) is associated with the list selection.
For a full description of its content, see QuickInfo.


QuickInfo displays a Help tooltip when the mouse cursor is on a statement in the Code Editor. QuickInfo tooltip

This tooltip consists of:

  • The statement syntax (1),
  • A brief description of how the statement is used (2),
  • A description of each parameter, including its type (3).

Note:


Snippets are predefined code blocks that can be inserted into the code.
For a complete list of snippets, see the Snippet Reference.

Insert a Snippet:

A snippet can be inserted in a Code Editor in various ways:


Complete a Snippet:

Most of the snippets contain variable names that can be replaced with custom names after insertion.

The snippet code block is inserted in Editing mode so that it can be completed:
Snippet Edition mode
In this mode:

  • Variable names are highlighted in yellow,
  • You can navigate from one variable name to another using the tab key,
  • Once the cursor is on a variable name, you can replace its default name with a custom name.
    All other occurences of the name are automatically replaced.
  • Hit the Enter or Escape key to exit Editing mode.

Notes:

  • You cannot return to Editing mode once you have exited,
  • Some automatic completion (application / page / item names) can be performed by Desktop Studio when inserting snippets from the Page Viewer Tool Window.


You can insert application / page / item names in a Code Editor by drag & drop from various Editor Perspective Tool Windows:


Page Viewer tool window The Page Viewer tool window in the Editor Perspective displays a page capture.

It consists of the following panels:

  • The Breadcrumb (1),
  • The Capture selector (2),
  • The Captures toolbar (3),
  • The Action toolbar (4),
  • The Resize Panel (5),
  • The Display panel (6).



Breadcrumb (1)

The Breadcrumb lets you select the application / page / item displayed.

  • To display an application mosaic (see Application View):
    • Click the current application (2),
    • Or click the first selector (1) to display a list of all declared applications.
  • To display a page capture:
    • Click the current page (4),
    • Or click the second selector (3) to display a list of all declared pages of the current application (2).
  • To select an item:
    • Click the third selector (5) to display a list of the declared items of the current page (4).


Capture Selector (2)

The Capture selector lets you select the capture that is currently displayed.


Capture Toolbar (3)

The Capture toolbar lets you perform actions on the captures:

  • Make a new capture: adds a new capture (or replaces the current one),
  • Lock/Unlock capture: useful for locking the selected capture during recognition,
  • Delete capture: deletes the current capture,
  • Edit capture properties:
    • Change the capture comment shown as a tooltip on the capture tab in the Capture selector (1),
    • Select the capture(s) shown in the Application View.


Action Toolbar (4)

The Action toolbar lets zou:

  • Copy the whole screen capture to the clipboard,
  • Display an Image Selector.

The Image Selector lets you:

  • Crop the screen capture,
  • Copy part of the screen capture to the clipboard.

You will find a full description of the Image Selector in the Explorer Perspective.


Resize Panel (5)

The Resize Panel lets you change the zoom level of the screen capture:

  • Using the Slider,
  • Using the Zoom to fit button to fill the display panel with the screen capture.


Display Panel (6)

The Display Panel displays the current screen capture.

In this view, only the non-technical recognized items (1,2,3,4,5) are clickable (see Set Item parameters).
They are higlighted with a green rectangle.

Once selected by clicking on it, this type of item is highlighted with an orange rectangle (1).

The Breadcrumb selection is updated to reflect the item currently selected.

By right-clicking within the Display panel, you can:

  • Edit the page: automatically navigate to the Explorer Perspective to edit the current page / item,
  • Copy the capture screen to the clipboard,
  • Insert a snippet in the current 'Code Editor' (see Help Features).