Status : :

Navigation Features

Navigation features make it easy to navigate through Desktop Studio code.


Code Map Tool Window The Code Map tool window in the Editor Perspective displays the 'Code structure' of the script or the XML block edited in the Code Editor that has the focus.

It lets you:

  • Navigate to the code from the 'Code map' by selecting the desired 'Map entry'.
    The 'Code editor' automatically scrolls to the first line of the corresponding 'Code block'.
  • Navigate from the code to the 'Code map' by right-clicking within the 'Code editor' and selecting the 'Show in code map' context menu item.
    The 'Code map tree' automatically scrolls to the corresponding 'Map entry' and selects it.

Script Code map

The tree displays all the functions coded in the script, including the callback functions:

Scenario
Step
Event Handler
Function
Callback


XML Block Code map

The tree displays XML nodes, depending on the XML Block being edited:

Edited Block XML nodes Displayed
SCENARII Scenario, Steps, Step, Handler
ACTIONS ACTION
EVENTS EVENT
CONTEXT STRUCTUREDON
Other blocks First-level child nodes


Bookmarks are navigation marks that can be set anywhere in the code.
Setting a bookmark on a line of code makes it easy to return to this line later.

Manage Bookmarks

To toggle a bookmark on a line, move the caret on this line in the Code Editor and click on the button in the Navigation Toolbar.
If there is no bookmark on the line, a bookmark is set and is displayed in the Code Editor Margins.
Otherwise, the bookmark is removed.

Clicking on the button in the Navigation Toolbar removes all the bookmarks.


Bookmark Tool Window
Navigate to a Bookmark

The Bookmark tool window in the Editor Perspective displays all the project bookmarks.
By double-clicking a line, you can directly navigate to the marked line in the script file or XML block.

You can also navigate between bookmarks using the Navigation Toolbar:

  • To navigate to the next bookmark, click the button,
  • To navigate to the previous bookmark, click the button.


Todo items help you set reminders in the code.

Manage Todo Items

To set a todo item in a Script or an XML block, simply type a comment line containing the word TODO.
When saved, the corresponding line is shown like this:

To remove a todo item, simply remove the word 'TODO' and save.


Todo List ToWl window
Navigate to a Todo Item

The Todo List Tool Window of the Editor Perspective displays the project's 'Todo items'.

By double-clicking a line, you can directly navigate to the corresponding line in the script file or the XML block.


Desktop Studio stores all the Navigation actions in a Navigation history.
This lets you navigate backwards and forwards within this history.

Navigation History

Desktop Studio stores a navigation point every time:

  • You navigate using the navigation methods described,
  • You navigate from one document to another (see Editor Perspective).


Navigate Backwards and Forwards

You can navigate within the history using the Navigation Toolbar:

  • To navigate backwards, click the button,
  • To navigate forwards, click the button.

Notes:

  • You cannot navigate forwards until you have navigated backwards,
  • If you navigate backwards and then navigate manually, you can no longer navigate forwards.


Desktop Studio lets you navigate from a Code Editor to a statement definition.

The meaning of 'statement definition' depends on the statement. A statement is:

  • The application / page / item definition, for an application / page / item name,
  • The function implementation, for a function name.

To navigate from a Code Editor to a statement definition:

  • Right-click the statement and select the Goto Definition context menu item,
  • Or move the caret to the desired statement and hit the F12 key.

Depending on the respective statement, you automatically navigate:


Code Tree Tool Window The Code Tree tool window in the Editor Perspective displays the Javascript parsing tree of the script being edited in the Code Editor that has the focus.

It is available for internal development purposes only.