ReSharper
 
2022.1
Shortcuts: Visual Studio
Get ReSharper
You are viewing the documentation for an earlier version of ReSharper.
  1. Code templates
  2. Apply templates
  3. Surround code fragments with templates

Surround code fragments with templates

Last modified: 21 July 2022

ReSharper | Edit | Surround With Template…

Ctrl+E U (ReSharper_SurroundWith)

tip

If you only want to surround code with braces or parentheses, you can select a code block or an expression, then type an opening { or a closing } brace to put the selection inside braces, or type an opening ( or a closing ) parenthesis to put the selection inside parentheses.

Surround templates are used to quickly enclose an expression, a single statement, or an arbitrary block of code with if...else, try...catch or other code constructs. As the template expands, ReSharper intelligently reformats the code, adjusts the selection, and/or repositions the caret at the end so that you could continue typing from a handy position.

Apply a surround template

  1. In the editor, select a block of code that you want to surround with a template.

  2. Do one of the following:

    • As soon as the surround action indicator Themed icon surround template screen gray appears to the left of the selected code block, press Alt+Enter or click the indicator and choose the desired surround template in the action list:

      ReSharper: Surround templates in the action list (Alt+Enter)

      Note that only templates with a specified mnemonic digit appear under Surround with....

    • Press Ctrl+E U or choose ReSharper | Edit | Surround With Template… in the main menu. In the Surround With popup that appears, choose one the desired template or start typing the template name to narrow down the list.

    • Just start typing the template name when the selection is made. Of course, the selection will disappear at first, but as soon as you choose the template in the completion list and press Enter, the selection surrounded with the template will reappear:

      https://resources.jetbrains.com/help/img/dotnet/2022.1/surround_completion.png
      Gif

    tip

    If necessary, you can remove surround actions and surround templates from the action list. To do so, open the Code Editing | Context Actions page of ReSharper options (Alt+R, O) and then clear the Surround items checkbox.

  3. If the template has editable parameters (that is, requires user input), ReSharper deploys a hot spot session in the editor and sets the input position at the first parameter. Then you can do the following:

    • If ReSharper suggests some values for the current parameter, use Up and Down arrow keys to navigate through the list of suggested values, or just type in a desired value.

    • Press Tab or Enter to accept the value and move to the input position of the next parameter. If this is the last parameter, the hot spot session completes and the caret moves to the end position defined for the session.

    • Press Shift+Tab to move the input focus to the input position of the previous parameter.

    • Press Esc to exit the hot spot session. In this case, all session parameters will be initialized with default values.

Consider the following code fragment:

var fileStream = new FileStream("file.txt", FileMode.Open);

We would like to enclose the statement in a using directive. ReSharper conveniently offers the corresponding predefined template to streamline this operation. Pressing Ctrl+E U after selecting this code block opens a list with available templates:

ReSharper: Surrounding statments with 'using'

To choose the using template, you can do one of the following:

  • Click it with the mouse.

  • Go down to the corresponding menu item using arrow keys and press Enter.

  • Start typing usi... when the popup is open.

  • Press a key corresponding to the template mnemonic digit, which is shown next to the template.

ReSharper will insert the template code and deploy a Hot spot session in the editor so that you could provide values for the parameters of the template:

ReSharper: Surrounding statments with 'using'

We supply the desired disposable resource at the first parameter and press Tab or Enter to complete the hot spot session. The caret and selection are moved to the positions specified by the template designer, so that you can continue typing inside the created using statement.

tip

To get the most out of templates, you can edit the existing templates or create new templates so that the set of your templates will best fit your development practices.

This feature is supported in the following languages and technologies:

Language: C#

Language: VB.NET

Language: C++

Language: HTML

Language: ASP.NET

Language: Razor

Language: JavaScript

Language: TypeScript

Language: CSS

Language: XML

Language: XAML

Language: Resx

Language: Build Scripts

Language: Protobuf

Language: JSON

Feature is available in C#

Feature is available in Visual Basic .NET

Feature is available in C++

Feature is available in HTML

Feature is available in ASP.NET

Feature is available in Razor

Feature is available in JavaScript

Feature is available in TypeScript

Feature is available in CSS

Feature is available in XML

Feature is available in XAML

Feature is available in Resource files

Feature is available in build script files

Feature is not available in Protobuf

Feature is not available in JSON

The instructions and examples given here address the use of the feature in C#. For details specific to other languages, see corresponding topics in the ReSharper by language section.

See also

Concepts

Procedures

Reference

External Links