JetBrains Rider
 
2024.3
Shortcuts: Visual Studio 2022 (Windows)
Get JetBrains Rider
  1. Create and edit code
  2. Code generation
  3. Generate type members
  4. Generate Properties

Generate Properties

Last modified: 25 September 2024

Code | Generate | Properties / Read-only Properties

AltInsert | Properties / Read-only Properties

JetBrains Rider will help you generate properties for all fields that you want to expose.

In the example below, this command is used to generate properties for _radius and _center fields.

Before generation

After generation

class Circle
{
    int _radius;
    readonly Point _center;

    public Circle(int radius, Point center)
    {
        _radius = radius;
        _center = center;
    }
}
class Circle
{
    int _radius;
    readonly Point _center;

    public int Radius
    {
        get { return _radius; }
        set { _radius = value; }
    }

    public Point Center
    {
        get { return _center; }
    }

    public Circle(int radius, Point center)
    {
        _radius = radius;
        _center = center;
    }
}

tip

You can also transform fields into properties with the Encapsulate Field refactoring - place the caret to a field and press AltEnter and then choose Encapsulate Field.

Generate properties that will expose selected fields

  1. In the editor, place the caret at the type name or within a type at the line where you want to insert properties that will expose selected fields. If the caret is on the type name, the generated code will be added in the beginning of the type declaration.

  2. Press AltInsert or choose Code | Generate... from the main menu. Alternatively, you can press Ctrl0Q, start typing the command name in the popup, and then choose it there.

  3. In the Generate popup, select Properties / Read-only Properties.

  4. In the Generate dialog that appears, select fields to generate properties for.

    Generating properties with JetBrains Rider

  5. Optionally, use the following controls that are applied to all generated properties:

    Access Rights

    defines access rights modifiers for generated properties.

    Read-only

    defines whether to generate properties as read-only or not. If you choose Automatic, JetBrains Rider will generate only getters for read-only fields, and both getters and setters for any other fields.

    If you have selected Read-only Properties in the Generate popup, the selector is set to Yes, but you can change it if necessary.

    Virtual

    (if applicable) adds the virtual modifier to generated properties.

    Notify on property changes

    (if applicable) If your class implements the INotifyPropertyChanged or inherits from a class that supports property change notifications (for example, Prism’s NotificationObject) and the method that notify property change is decorated with the [NotifyPropertyChangedInvocator] attribute, you can choose to implement properties with change notification calls.

  6. Click OK to complete the wizard.

This command generates properties leaving the original fields intact. If necessary, you can convert the generated properties to auto-implemented properties by pressing AltEnter on any of the properties:

'Convert to auto-property' quick-fix

See also

Procedures

External Links