ReSharper 2020.2 Help

Choose Macro dialog

ReSharper | Tools | Templates Explorer [template type] | [template] | Edit Template | [template parameter] | Choose Macro (Change Macro)

This dialog helps specify a template macro that ReSharper should use to suggest or guess values for each template parameter. You will use this dialog when you declare or edit template parameters.

ReSharper: Choose macro dialog

The dialog contains a set of template macros described below.

ExpressionDescriptionDetails
guessElementType()Guess element type of collection represented by variableAnalyzes code and guesses type of element of a collection.

Macro parameters:

  • variable - reference to another parameter in the template

suggestIndexVariable()Suggest name for an index variableSuggests non-used name which can be used for an index variable at the evaluation point.
    getAlphaNumericMainFileNameWithoutExtension()Name of the primary file without extension with all non-alphanumeric replaced with underscoresEvaluates primary file name without extension with all non-alphanumeric replaced with underscores
      typeRef()Containing type referenceEvaluates to reference of the most inner containing type.
        getUpperCaseAlphaNumericFileName()Current file name in upper case with all non-alphanumeric replaced with underscoresEvaluates current file name in upper case with all non-alphanumeric replaced with underscores
          getFileNameWithoutExtension()Current file name without extensionEvaluates current file name without extension
            getCreationTime()Date and time when the file was created in specified formatEvaluates file creation date and time

            Macro parameters:

            • format - text string

            list()Comma-delimited list of valuesDisplays the specified list of values.

            Macro parameters:

            • Comma-delimited list of values - text string

            To add the comma (,) as a value to the list, escape it with the backslash (\).

            spacestounderstrokes()Value of another variable, where spaces will be replaced with '_'Changes spaces to '_' (i.e. "do something useful" into "do_something_useful"

            Macro parameters:

            • another variable - reference to another parameter in the template

            arrayVariable()Suggest an array variableSuggests variable which type is array type
              fixedTypeName()Insert reference to typeEvaluates to the selected type name.

              Macro parameters:

              • type - type

              capitalize()Value of another variable with the first letter in upper caseCapitalizes string value (i.e. changes case of the first letter to upper)

              Macro parameters:

              • another variable - reference to another parameter in the template

              clipboard()Clipboard contentEvaluates to current textual clipboard content
                complete()Execute basic completionShow basic code completion list at the point where the variable is evaluated
                  completeSmart()Execute smart completionShow smart code completion list at the point where the variable is evaluated
                    completeType()Execute type completionShow type completion list at the point where the variable is evaluated
                      constant()Constant valueEvaluates to the specified constant value.

                      Macro parameters:

                      • Constant value - text string

                      typeMember()Containing type member nameEvaluates to short name of the most inner containing type member (e.g. method or property).
                        typeName()Containing type nameEvaluates to short name of the most inner containing type.
                          context()Provides list of items describing current contextProvides list of items describing current context. This includes file name, containing type name, namespace name, etc.
                            getCurrentDate()Current date in specified formatEvaluates current date

                            Macro parameters:

                            • format - text string

                            getCurrentTime()Current date and time in specified formatEvaluates current date

                            Macro parameters:

                            • format - text string

                            getCurrentNamespace()Containing namespaceEvaluates name of the containing namespace
                              decapitalize()Value of another variable with the first character in lower caseDecapitalizes string value (i.e. changes case of the first letter to lower)

                              Macro parameters:

                              • another variable - reference to another parameter in the template

                              getDefaultNamespace()Default namespaceGets default namespace for the current project
                                fileDefaultNamespace()Default namespace for current fileGets default namespace for the current file
                                  getFileName()Current file nameEvaluates current file name
                                    getAlphaNumericFileNameWithoutExtension()Current file name without extension with all non-alphanumeric replaced with underscoresEvaluates current file name without extension with all non-alphanumeric replaced with underscores
                                      getFullUserName()Full user name of the current userEvaluates full name of the current user
                                        guessExpectedElementType()Guess element type for expected collection typeGuess element type if a collection type is expected at this point
                                          guessExpectedType()Guess type expected at this pointGuess type expected at this point
                                            guid()New GUIDGenerates new Globally Unique Identifier (GUID)
                                              lineNumber()Current line numberEvaluates to number of the line macro is evaluated at.
                                                getOutputName()Current project output assembly nameEvaluates output assembly name for the current project
                                                  parameterOfType()Suggest parameter of typeSuggests parameters of the specified type.

                                                  Macro parameters:

                                                  • type - type

                                                  getProjectName()Name of the current projectEvaluates current project name
                                                    getSolutionName()Current solution nameEvaluates current solution name
                                                      enumerableVariable()Suggest enumerable variableSuggests visible variable that can be enumerated (that is, used in foreach loop as collection)
                                                        suggestVariableName()Suggest name for a variableWhen executed in variable declaration (where variable name should stand), suggests name for the variable.
                                                          variableOfType()Suggest variable of typeSuggests variables of the specified type.

                                                          Macro parameters:

                                                          • type - type

                                                          suggestVariableType()Suggest type for a new variableSuggest type for a new variable declared in the template
                                                            getUserName()Short name of the current userEvaluates current user name
                                                              dependencyPropertyType()DependencyProperty typeEvaluates to dependency property type specific to current framework
                                                                fullTagName()Full tag nameInserts full name of containing tag
                                                                  suggestXmlAttributeNameByTag()Suggests XML attribute name by tagSuggests XML attribute name used in the same tags in current document
                                                                    suggestAttributeName()Suggests XML attribute nameSuggests XML attribute name used in current document
                                                                      suggestXmlTagName()Suggests XML tag nameSuggests XML tag name used in current document
                                                                        tagName()Tag nameInserts name of containing tag without namespace
                                                                          tagNamespace()Tag namespaceInserts namespace of containing tag
                                                                            castToLeftSideType()Cast to the required type (if the cast is necessary)Inserts (if required) cast to the type which is expected at the left side of assignment expression.
                                                                              fileheader()File headerInserts the file header specified in the ReSharper options.
                                                                                suggestAttributeNameByTag()Suggests attribute name by tagSuggests attribute name used in the same tags in current document
                                                                                  suggestAttributeValue()Suggest attribute valueSuggest attribute value for current html tag attribute
                                                                                    suggestTagName()Suggest tag nameSuggest tag name used in current document
                                                                                      AspMasterpageContentGenerator()ASP.NET Masterpage content generatorGenerate content for masterpage content placeholders at the point where the variable is evaluated
                                                                                        AspMvcAction()ASP.NET MVC ActionShow completion list with available ASP.NET MVC Actions at the point where the variable is evaluated
                                                                                          AspMvcController()ASP.NET MVC ControllerShow completion list with available ASP.NET MVC Controllers at the point where the variable is evaluated
                                                                                            runAtServer()Insert runat="server" if server-side tag selectedInsert runat="server" if server-side tag selected
                                                                                              cppEnumToStringEnumerator()Enum to string: enumerator nameDuplicates the containing template line for each enumerator and evaluates to the name of the enumerator.
                                                                                                cppEnumToStringEnumeratorName()Enum to string: enumerator name as a stringDuplicates the containing template line for each enumerator and evaluates to a string with the name of the enumerator.
                                                                                                  cppEnumToStringEnum()Enum to string: enum nameThe name of the enum that the action is invoked on.
                                                                                                    cppFileheader()File headerInserts the file header specified in the ReSharper options.
                                                                                                      cppFunctionParameter()Documentation: function parameter type with nameDuplicates the containing template line for each function parameter and evaluates to the parameter type with name
                                                                                                        cppFunctionParameterName()Documentation: function parameter nameDuplicates the containing template line for each function parameter and evaluates to the parameter name
                                                                                                          cppFunctionParameterType()Documentation: function parameter typeDuplicates the containing template line for each function parameter and evaluates to the parameter type
                                                                                                            cppFunctionReturnValue()Documentation: function return valueKeeps the containing template line only if the function return type is non-void
                                                                                                              cppTemplateParameterName()Documentation: template parameter nameDuplicates the containing template line for each template parameter and evaluates to the template parameter name
                                                                                                                cppMacroParameterName()Documentation: macro parameter nameDuplicates the containing template line for each macro parameter and evaluates to the macro parameter name
                                                                                                                  cppFunctionReturnType()Documentation: function return typeEvaluates to the function return type
                                                                                                                    cppEntityShortName()Documentation: entity short nameEvaluates to the short name of the entity that is being documented
                                                                                                                      cppEntityQualifiedName()Documentation: entity qualified nameEvaluates to the qualified name of the entity that is being documented
                                                                                                                        cppPchIncludeDirective()Precompiled header file include directiveEvaluates to an include directive for the precompiled header file or to an empty string if the project does not use precompiled headers.
                                                                                                                          constTypeName()Containing type name with constEvaluates to the short name of the most inner containing type with a const specifier.
                                                                                                                            Last modified: 08 May 2020