studio
2023.10
false
Studio User Guide
Last updated Nov 4, 2024

Studio IDE

The Studio IDE interface consists of a dedicated code editor, file tabs, and breadcrumbs for easy navigation. This layout enables you to manage your files, explore project structures, edit your code, version projects, run, and publish your automations.

Code Editor

The code editor displays your current automation project, enables you to make changes to it, and provides highlighting for errors found inside your code. You can use the Code Editor like you would use any other code editor tool.

The Context Menu - when you right-click a line in your coded automation, the Context Menu appears. You can also perform the actions inside the Context Menu using keyboard shortcuts.

Table 1. Field descriptions for the Context Menu
OptionKeyboard shortcutDescription
Quick ActionsCtrl + .Refactor, generate, or modify code elements with an action displayed automatically.

An example of a quick action can be Introduce parameter for X → into new overload.

RenameF2Rename the code element that you have selected. The change applies to all references of the element inside the entire project.
Go to DefinitionF12Navigate to the source of a type or member, and displays the result in a new file tab.
Go to ImplementationCtrl + F12Navigate to the implementation of a symbol:
  • Interfaces - go to all implementors of the interface.
  • Abstract methods - go to the concrete implementations of the method.
Go to LineCtrl + GEnter the number of the line you want to move the cursor to.
Toggle BreakpointF9Set a breakpoint on the line you have selected. The breakpoint appears as a red dot on the left side of the Code designer panel.
Find All ReferencesShift + F12Find where a particular code element is referenced throughout the opened file.
Format DocumentCtrl + K, Ctrl + DSet the appropriate indentation, spacing and wrapping.
Show DocumentationF1Go to the corresponding documentation of the feature or API.
CommentCtrl + K, Ctrl + CComment out the line you have selected.
UncommentCtrl + K, Ctrl + UUncomment the line you have selected.
CutCtrl + XCut the line you have selected.
CopyCtrl + CCopy the line you have selected.
PasteCtrl + vPaste.
DeleteDeleteDelete the line you have selected.
Select AllCtrl + ASelect all lines in the file.

For keyboard shortcuts that you generally use in Studio, not specifically for coded automations, visit Keyboard Shortcuts

Code Editor Settings

To personalize the built-in Studio code editor, navigate to Settings and Code Editor



The table below describes each code editor setting.

SettingDescription
FontChoose the font of the code.
Font SizeSet the size of the font.
Tab SizeSet the size of the tab.
View WhitespaceHighlight the spaces created when you press Space on your keyboard.
Highlight Current LineHighlight the line where you have your cursor on.
Show Structure Guide LinesEnables dotted structure guide lines on your code, to identify individual blocks.
Show Error SquigglesShow a red squiggle that indicates a compiler error or warning.
Show Line NumbersShow the number of each line on the code that you're working on.
Auto Convert Tabs to SpacesCreate 4 spaces when using the Tab key.
Show Selection MarginShow a margin next to the line of code that you're editing.
Show Selection MatchesFind and highlight all the matching strings for the range of characters you selected.
Highlight ReferencesHighlight references to the object your cursor is on. Only objects that match the current context are highlighed.
Enable Source DecompilationDecompile source code when you view the definition of an object using Go to Definition. Enable this to navigate to the definitions available in the CodedWorkflowBase class. Visit Base class for more information.

Tabs

The code editor opens files inside your project with tabs, in the editor's header.

When you open a file, a new tab is displayed for it.



Breadcrumbs

In the code editor header, you can navigate through classes and methods inside a file, using breadcrumbs.



Versioning

You can version Coded Automation projects like any other project in Studio. You can version projects when you publish them to Orchestrator, or if you use source control systems, such as GIT or SVN.
  • Publish versioning - Projects in Studio can be versioned using either the semantic or legacy versioning scheme. The semantic versioning scheme has the format Major.Minor.Patch[-Suffix] and the legacy versioning scheme has the format M.m.bbbb.rrrrr. The project's semantic version can be modified from the project.json file or the Publish window. The suggested version number in the Publish window is generated based on the project's previous versioning scheme. Visit Setting the Project Version to learn how to version your projects in Studio.
  • Source control versioning - You can version your coded automations projects using source control systems such as GIT, TFS, or SVN. Visit About Version Control to learn how to version your projects using source control systems.

Find and Replace

To open the Find and Replace dialog, use the keyboard shortcuts below:

  • Ctrl + Shift + F - opens the Find and Replace dialog in the Find In Files tab.
  • Ctrl + Shift + H - opens the Find and Replace dialog on the Replace in Files tab.

Find in Files

  1. Type the characters you want to search in the Search bar.
  2. Select one of the search options in the Search bar:
    1. Match case
    2. Match whole word
    3. Regular Expression
  3. From the Project dropdown select the place where to search for the characters:
    1. Project - search in current project.
    2. Opened Documents - search in the opened documents.
    3. Documents - search in all documents inside the project.
  4. Click Open in Find Panel to open the search results in Studio.
  5. Click Find Previous to find the previous result and Find Next to find the next result.


Replace in Files

  1. Type the characters you want to replace in the Search bar.
  2. Type the characters that you want to replace with in the Replace bar.
  3. Select one of the search options in the Search bar:
    1. Match case
    2. Match whole word
    3. Regular Expression
  4. From the Project dropdown select the place where to search for the characters:
    1. Project - search in current project.
    2. Opened Documents - search in the opened documents.
    3. Documents - search in all documents inside the project.
  5. Click Open in Find Panel to open the search results in Studio.
  6. Click Replace Next to replace the next iteration or Replace All to replace all iterations.
  • Code Editor
  • Code Editor Settings
  • Tabs
  • Breadcrumbs
  • Versioning
  • Find and Replace

Was this page helpful?

Support and Services
Get The Help You Need
UiPath Academy
Learning RPA - Automation Courses
UiPath Forum
UiPath Community Forum
Uipath Logo White
Trust and Security
Terms of Use
Privacy Policy
Cookies Policy
© 2005-2024 UiPath. All rights reserved.