Collections and methods

This chapter shows you how to create a user code collection, fill it with methods, and make it accessible to other users. This way, team members without coding skills can profit from user code methods.

A user code collection is defined as a collection of user code methods that belong together logically. All user code collections together make up the user code library.

To create a new collection:

1. Click File > New > File...

2. Click User code collection and enter a name

3. Click Create
   

Alternatively, you can also create a collection in the following ways:

a. Click the Add user code collection symbol in the Ranorex Studio toolbar, confirm the save location, and enter a name.

b. Right-click in the projects view and click Add > New item…

A new user code collection has the following code structure:

1. Inclusion of the required program libraries

2. Definition of the namespace

3. Class definition of the user code collection. This is where you define the user code methods.

The user code collection also appears in the Projects view as a file. You can add multiple user code collections per solution and organize their files in folders.

1. Opened user code collection file in Ranorex Studio.

2. The user code collection file in the Projects view.

User code collections only become useful once you add user code methods to them. Others can then access these methods in the project the user code collection is part of.

To add a user code method:

1. In the class definition of the user code collection, right-click where you want to add the new method.

2. Click Insert new user code method…

3. Name the method and click OK.

4. The code construct for the method is inserted.
   

Note: The code construct of the method will be inserted wherever you right-clicked. Always make sure the method has been inserted at the correct position, i.e. in the class definition.

Ranorex Studio only inserts a code snippet. You then have to add your custom code along with a good description of what the method does.

Here’s an example of a finished user code method:

1. Instantiation of the repository in the class (optional)

2. Method description: This short description is displayed when selecting the user code method in the library. It makes it easier for users to find out what the method does. This is why you should always make sure to add a short, but meaningful description.

3. Custom code: In this example, the first name “John” is entered into a text field that is represented by the repository item FirstName.

Reference: Addressing repository items in code modules is explained in Access the repository.

Note: Instead of instantiating a repository in the class of a user code collection, you can also pass a repository to a method as a parameter. Available argument types are listed in User code actions.