Status: Validated

The Editor Perspective Panel

When the Editor Perspective tab is selected, the Studio Editor Perspective panel is displayed:

Editor Perspective panel

This panel consists of:

The Script Tree (2) Tool Window displays all the script files included in the current project. It can be used to open scripts for editing.




Any number of scripts can be open simultaneously.
Each script is loaded in its own document editor that is independent of the others.

The 'Document Selector' helps to manage open documents.
Document selector

It consists of:

  • Document tabs (1),(2),(3), and so forth, one per open document.
    One of these document tabs is highlighted (4), indicating the document currently being edited,
  • A Selector menu (5).

Document Tab

The document tabs let you:

  • Change the document being edited by clicking on its tab,
  • Close the document currently being edited by clicking on the cross on the right of its tab,
  • Change the tab order by dragging one tab and dropping it at a new location in the Selector,
  • Split the Perspective panel to display two (or more) documents at the same time (see Docking Management).


Selector Menu

Document Selector Selector Menu The Selector menu is useful when we have opened more documents than the number of tabs that the Selector can display.

It lets you view all the open documents and select one for editing.




Code Editor

The Code Editor is used to edit:

  • Script files,
  • XML blocks.

The Code Editor panel consists of:



The Editor

The Editor is a powerful text editing control that is packed with features for efficient code editing, including syntax highlighting, code outlining, block selection, IntelliPrompt, split views, zooming, and more.

Here is a detailed list of the Editor's features:

Editing Features

  • Unlimited undo/redo with support for batch-replace operations,
  • Block indent/outdent,
  • Automated line modification tracking,
  • Block (rectangular) selection and ability to prevent certain selection methods (select with Alt key pressed),
  • Edit multiple lines at the same time via block selection,
  • Line selection in the selection margin,
  • Clipboard operations and drag/drop natively supported (cut, copy, paste), with support for any DataObject,
  • Over 100 edit actions, including everything provided by Visual Studio, such as caret movement, selection, indenting, tabification, transposition, and more,
  • Block, none, and customizable smart auto-indent modes when pressing Enter,
  • Current line and delimiter (bracket) highlighting,
  • Delimiter (bracket) auto-completion,
  • Auto-case correct,
  • Code block selection (expansion/contraction),
  • Scrolling accelerates the longer scrollbar buttons are depressed.

Appearance Features

  • Syntax highlighting,
  • Word wrap,
  • Whitespace display,
  • Optional line number, selection, outlining, ruler, and word wrap glyph margins,
  • Indicators (bookmarks, breakpoints, current statement, etc.),
  • Four-way or two-way split views,
  • Animated zoom in and out, with mouse wheel support,
  • Squiggle lines for marking errors and spelling mistakes,
  • Complete support for both automatic and manual code outlining (folding), with customizable outlining node options,
  • Collapse (hide) regions of text independently of the outlining feature,
  • Indentation guides.

IntelliPrompt Features

  • Completion lists that improve editing productivity and support complete word functionality (see Help Features),
  • Completion lists support filters (tabs/buttons), multiple matching algorithm options, ability to create custom matching algorithms, matched text highlights, description tips, and much more,
  • Quick info tips that can show detailed information about what is under the mouse, with automated mouse hover tracking (see Help Features),
  • Parameter info tips that can show multiple signature overloads and track the current parameter,
  • Code snippets that allow pre-defined text fragments to be inserted into the editor, and declared fields edited (see Help Features).

See Code Editor Commands.



Code Editor Margins

Indicator margin

The Indicator margin displays various indicators:

  • Bookmark indicators,
  • Breakpoint indicators,
  • Todo indicators,
  • Running Line indicator.

Margin visibility can be modified via the 'Is Indicator Margin Visible' setting (see Editor Perspective Settings).


Line Number margin

The Line Number margin displays the code line numbers.

Margin visibility can be modified via the 'Is Line Number Margin Visible' setting (see Editor Perspective Settings).


Selection margin

The Selection margin displays colored bars where code has been modified:

  • Yellow colored bar: indicates modified code that has not yet been saved,
  • Green colored bar: indicates modified code that has been saved.

Margin visibility can be modified via the 'Is Selection Margin Visible' setting (see Editor Perspective Settings).


Outlining margin

The Outlining margin displays the code outlining (folding) node tree. It lets you expand and collapse nodes:

  • '+' expands node,
  • '-' collapses node.

Margin visibility can be modified via the 'Is Outlining Margin Visible' setting (see Editor Perspective Settings).




Script Tree

The script tree contains all the script files included in the current project.
It contains the following node types:

Folder Node
Framework or Library Script
Project Script

Each script (SDK or project) node contains subnodes displaying a first-level Code map
(see Navigation using Code Map).

Each tree node has a shortcut menu providing the main associated functions (see Command Reference).

It lets you:




Project Tree

The project tree contains all of the processes, applications, pages, and items declared in the current project.

In Projects, it lets you:

Each tree node has a shortcut menu with the main associated functions (see Command Reference).

This window consists of the following panels:

  • The Filter panel (1),
  • The project tree (2) itself.

The Filter panel lets you filter the elements displayed in the project tree.

The Filter Panel

The Filter panel lets you:

  • Add a new filter,
  • Apply an existing filter,
  • Update an existing filter,
  • Delete a filter.

Add a New Filter

To add a new filter:

  • Click the Create a new Filter button,
  • The project tree is modified to display checkboxes near each node and the 'Edit Filter' panel is displayed ,
  • Check the nodes to include in the filter,
  • Enter the filter name in the 'Edit Filter editbox',
  • Save the filter by clicking on the button (to cancel, click on the button),
  • The project tree is now filtered to reflect the latest selection.


Update an existing Filter

To update an existing filter:

  • Select the desired filter in the Filter panel combobox,
  • The project tree is filtered with the selected filter ,
  • Click on the Edit Filter button,
  • The project tree is modified to display checkboxes near each node and the 'Edit Filter' panel is displayed,
  • Check or uncheck the nodes as needed,
  • If necessary, edit the filter name in the 'Edit Filter editbox',
  • To save changes, click the button (to cancel, click the button),
  • The project tree is now filtered using the updated filter.




The Editor Perspective contains the following Tool Windows:

Navigation

Find / Replace

Compilation

Debugging




The Editor Perspective Layout is a DockSite made of:

  • Four Tool window zones, on the left, top, right and bottom sides,
  • One Document zone in the center. This Documents zone can be split in several Document zones.

The Editor Perspective Layout can be modified by:

  • Docking Document Editor instances in split Document zones,
  • Docking tool windows in the various Tool window zones, or in the split Document zones.

You can also open a Linked DockSite (via the 'View\Open linked docksite' menu item in the MainWindow Menu Bar).
This a second DockSite where and from where you can dock Document Editor instances and tool windows.

To do this:

  • Drag the Code Editor tab or the Tool window tab,
  • The Docking Guide is automatically displayed,
  • Drop the dragged Tab on the desired Docking Guide Part.


Dock Document Editor Instances

To dock a Document Editor instance, drag its Document Editor Tab over one Document Zone.

Docking Guide The following Docking Guide is displayed.
It consists of the following targets:

  • One Central Guide (1),
  • Four Splitting Guides: (2),(3),(4),(5).

If you drop:

  • On one of the 'Splitting Guides', that split the 'Documents zone' and moves the dragged 'Document Editor instance' to the newly created 'Document Zone',
  • On the 'Central Guide', that moves the dragged 'Document Editor instance' to the corresponding 'Document Zone',
  • Outside the 'Docking Guide', that makes the dragged 'Document Editor instance' a floating instance.

Note:

  • If you double-click the titlebar of a floating 'Document Editor instance', you move it back to its 'Document Zone',
  • The Control key can be used to prevent the Docking Guide from being displayed,
  • Similarly, the Shift key can be used to “lock” the Docking Guide, so it is not changed/removed as you move the mouse around.


Docking Tool Windows

To dock a Tool window, drag its Tool window tab or its titlebar over one Document Zone.

Docking Guide The following Docking Guide is displayed.
It consists of the following targets:

  • One 'Document Guide' (1),
  • Four 'Tool window zones Guides': (2),(3),(4),(5),
  • Four 'Splitting Guides': (6),(7),(8),(9).

If you drop:

  • On the 'Document Guide', that moves the dragged 'Tool window' as a Document to the corresponding 'Documents Zone' (see Dock Document Editor Instances),
  • On one of the 'Tool window zones Guides', that moves the dragged 'Tool window' tothe corresponding 'Tool window zone',
  • On one of the 'Splitting Guides', that splits the 'Tool window zone' and moves the dragged 'Tool window' to the newly created 'Tool window zone',
  • Outside the 'Docking Guide', that makes the dragged 'Tool window' a floating window.

Until the new layout is saved, you can restore the previously saved layout (see Layout Management).

Note:

  • You can lock/unlock a Tool window in opened mode using the and buttons of its titlebar,
  • Some Tool windows can be closed using the button of their titlebar,
  • All available Tool windows are listed in the 'View\Tool Windows' main menu.
    By checking/unchecking one Tool window, you can show/hide it.
  • Double-click the titlebar of a floating 'Tool window' to move it back to its 'Tool window zone',
  • Drag a Tool window tab to drag a single Tool window.
    Drag a Tool window Titlebar to drag the whole Tool window Group.


Layout Management

You can save the layout using the View\Layout\Save menu item in the MainWindow Menu Bar.
This layout will then be restored the next time the Studio is launched.

To restore this layout without restarting the Studio, use the View\Layout\Restore menu item in the MainWindow Menu Bar.

Note:

  • The Editor Perspective manages two independent layouts: one for Debugging mode and one for Editing mode.
    If you save the layout while the project is running, the Debugging layout is modified.
    Otherwise, you modify the Editing layout.