DevExpress IDE Tools terminology/key concepts
Here is a list of terms often used when talking about IDE tools (including CodeRush, DXCore and Refactor!) for a better understanding of these products. The list is not complete and it is going to be updated from time to time.
Actions associate a name with functionality, which can be triggered using either a keyboard shortcut or a mouse button, and/or placed within a Visual Studio menu. Some actions accept parameters that can change their behavior.
Action hints inform new users about IDE tools features, as they occur by pointing to a location on-screen with a large colored arrow, displaying a short text message.
Adornment represents a graphical object inside VisualStudio code editor.
Alias (RegEx Alias)
A number of solutions in IDE tools rely upon regular expressions to match a text. DXCore extends the regular expression engine by adding aliases – the ability to replace a complex regular expression with a human-readable alias. DXCore includes a number of predefined aliases (e.g. Identifier, Argument, Param, Initialization, StringConstant, Typecast, etc).
Big hints are large tool tips which describe an active feature or provide other helpful information.
Billboard hinting briefly displays a large message that clearly communicates a significant state change. While the billboard hint is on screen, you can continue to work.
Code modification providers that intended to declare new source code language structures, e.g. new types, members, variables.
Also known as Code Analysis feature, that performs a static code analysis to find issues in your source code. It marks found issues with colored wavy lines and allows you to perform a fix immediately. The following issues can be found: errors, warnings, hints (suggestions), dead code and code smells.
Code Preview Window shows the syntax-highlighted source code. It is used in refactoring previews and some tool windows.
Code Provider represents a code modification operation provider (similar to a Refactoring Provider), which may change program behavior.
CodeRush is a powerful Visual Studio .NET add-in that enhances the developer experience by accelerating developer and team productivity via an integrated suite of technologies.
CodeRush Xpress is a completely free version of CodeRush Pro available to all Visual Studio 2008 and 2010 CSharp and Visual Basic developers, and offers a comprehensive suite of tools that enable you and your team to simplify and shape complex code – making it easier to read and less costly to maintain.
The context determines if a particular feature is appropriate for use when working inside Visual Studio IDE by specifying a collection of boolean states (e.g. “Caret is inside method” or “Menu is active“). It is useful for distinguishing conditions where a feature should be available.
The DecoupledStorage object is used to handle storage for your DXCore plug-ins data.
Dynamic List represents a named list of mnemonics and its values that are used in the CodeRush Templates Engine for increasing the amount of possible template variations.
DXCore provides services, wizards, and a visual extensibility framework designed to make it easy to extend Visual Studio. All products like CodeRush and Refactor! were designed on the DXCore Framework.
Editor caret is a text cursor representing a current position in the Visual Studio code editor.
The Code Embedding feature allows you to surround the selected block of code or text into an appropriate block.
Feature UI (also known as the “What Happened?” window) appears in the bottom right corner each time a particular IDE tools’ feature is activated to inform you about what’s going on inside Visual Studio IDE. In the majority of cases, the window is used to simplify learning of the CodeRush specific features.
Highlighting usually represents one of the CodeRush visualization features intended to visually concentrate and indicate particular source code elements.
The discoverability elements to help you learn more about features in IDE tools, such as Action Hints, Big Hints, Shortcut Hints, Billboard Hints.
IDE tools bundle includes the following Visual Studio productivity add-ins: DXCore, CodeRush Pro, CodeRush Xpress, Refactor! Pro, Refactor! for C++, Refactor! for ASP.NET.
Intellassist feature auto-completes text at the editor caret with appropriate suggestions like an in-scope identifier, enumeration elements and others.
Selection inversions take an existing selection and replace it with code that is essentially the opposite of the original. You can use it to swap assignment statements, invert the logic in boolean assignments to true or false, change the iteration direction on for-loops and more.
LanguageElement is the main base class for a rich variety of classes that denote a construct occurring in the source code and present a corresponding node in the abstract source tree built by DXCore Framework.
Linked Identifiers are a built-in feature of DXCore, which allows you to simultaneously change similar pieces of the text (code) located in different places. If you change one linked identifier, the others that are associated with it will automatically be changed as well.
Markers are navigation placeholders that remember important locations inside your source code you’ll need to move to in the future.
Message Log is a diagnostic tool window with valuable information, which can be helpful to troubleshoot issues appearing in IDE tools. It is available via the DevExpress | Tool Windows | Diagnostics | Messages menu item.
Navigation Fields allow you to quickly navigate between related code fragments. They highlight related fragments and allow you to easily tab through them in both directions.
Navigation Links allow you to quickly navigate between related pieces of code. They highlight particular code fragments and allow you to easily tab through them in both directions.
Provides a navigation operation intended for quick moving inside your source code.
Most of the aspects of the IDE tools (CodeRush and/or Refactor!) functionality can be customized using the Options dialog.
Options page allows users to easily customize the features of IDE tools and other custom plug-ins. Options pages are automatically integrated into the Option Dialog.
A plug-in is a special class that resides in an assembly that is loaded into the Visual Studio environment when DXCore starts-up. DXCore plug-in enhances the functionality of IDE tools.
Plug-in wizards are simplifying the process of creating DXCore plug-ins, such as tool windows, standard plug-ins and options pages. These wizards lay down the framework upon which your plug-ins will grow.
Refactor! Popup menu is a drop-down menu that lists all currently available refactoring/code operations for the current editor caret position and/or code selection.
Represents a particular refactoring operation for the restructuring of an existing code block, altering its internal structure without changing its external behavior in order to improve readability and the maintainability of the source code.
Service is a set of a DXCore related functionality that you can use when developing plug-ins.
A shortcut binding assigns a key to an action or to a Visual Studio command. Both actions and commands can be assigned keystrokes in both Visual Studio’s options dialog and in the DevExpress options dialog.
Shortcut hints list available shortcuts for the active state. Shortcut hints usually appear in response to a newly activated in-source user interface.
Smart tag is small glyph that indicates the availability of refactorings or code provider operations.
String providers are functions that return strings, and can be used to provide calculated information (e.g., date/time stamps, user names, active file name, etc.).
The target indicator shows where the caret will be positioned when you press Num Enter or Enter to accept last active text field.
Code templates are blocks of code that expand from short abbreviations typed into the code editor. Using code templates decreases code creation time, because it avoids having to type the entire code manually and allows creating regular code sections with only a few keystrokes.
Text commands are participating in the CodeRush code modification engine to perform a specific operation, e.g. move the editor caret, add an assembly reference, paste clipboard contents, invoke the Intellisense, etc.
Text document represents an opened source code file in the Visual Studio code editor.
Text expansion is a dynamic text containing encoded text commands and/or string providers, which is expanded into a block of code (text) with various elements of user/code interaction.
Text fields allow you to enter data and then press Num Enter or Enter to quickly move to the next field. Text fields are highlighted in the editor and usually have a tooltip below them describing the nature of the data expected.
The text view represents a view into a text document. Visual Studio may offer several views by splitting the main text document window horizontally or vertically. Text views are useful for painting on the editor and also for working with selections and the editor caret.
Tiles are rectangular regions on a text view designed to interact using the mouse. For example, CodeRush’s Flow Break Icons feature is implemented with this technology.
Tools windows are child windows of the Visual Studio integrated development environment that are used to display information or provide a different kind of IDE functionality. For example, there are: CodeRush tool window and User Guide tool window.
The User Guide tool window documents DXCore and dependent products, such as CodeRush and/or Refactor! if they’re installed. It also includes documentation covering Visual Studio extensibility using DXCore Framework.
The Visualize Toolbar is similar to all other standard Visual Studio toolbars and contains a group of toggle buttons, allowing you to quickly turn off commands or controls that are typically related in their function.—– Products: all Versions: all VS IDEs: any Updated: Aug/14/2012 ID: T039