Work with classes

Use the procedure in this topic to work with classes in your project.

When working with classes, you can add, rename, move using cut and paste, move using drag-and-drop, and delete classes as needed.

Procedure

  1. Open the Project Tree window if it is not already open.
  2. Depending on your requirements, do one of the following:

    Action

    Steps

    Add a class

    Defining a new document type requires a class. Once the class is created, you can define classification and separation techniques, extraction settings, and validation behavior. The actions available are determined by the Project Tree selection and the selection behavior.

    1. Expand the tree and select the location for the new class.

    2. On the Design tab, from the Create group, select Add Class Add Class icon.

      A new class is added to a project with a default name that you can edit immediately.

    3. Enter a descriptive name for the class, following the supported naming conventions.

    Rename a class

    1. Expand the project and select the class to rename.

    2. On the Design tab, in the Edit group, select Rename Rename icon.

      The class name in the Project Tree is now editable.

    3. Rename the class, following the supported naming conventions.

    Move a class using cut and Paste

    You can move a class by cutting a class from one location and pasting it to another location. Use this method if you are working with a large project that has many classes, and where moving a class using drag-and-drop is difficult because you cannot see the entire project and its classes.

    For example, a parent class has three child classes that are variations of an application form for a loan. A new loan form is initially created as a standalone class. The form creator later decides the new class is actually a variation of the parent application form and should be moved.

    1. Expand the Project Tree and select the class to move.

    2. On the Ribbon Design tab, in the Edit group, select Cut Cut icon.

    3. On the Project Tree, select the new position within the class hierarchy.

    4. On the Ribbon Design tab, in the Edit group, select Paste Paste icon.

      The class is displayed in the new location only.

    Move a class using drag-and-drop

    You can move a class using drag-and-drop. This method provides a quick and easy way of reorganizing your Project Tree. For the best results, use this method for smaller projects where the source class is visible at the same time as the destination location without the need to scroll up or down in the Project Tree. If you cannot see both locations, use cut and paste to move the class.

    1. Expand the Project Tree and select the class to move.

    2. Select the class and drag it to the new position in the class hierarchy.

      A grey overlay is displayed when you drag the class over the tree, and an arrow indicates where you are allowed to drop the class. This ensures that you can pinpoint the new location for the class.

    Delete a class

    When a class is no longer needed, the best practice is to remove it from the project. Review your entire project once you delete a class to ensure there are no unused global settings such as formatters or validation methods specific to that class. Removing unused elements ensures that your project is as efficient as possible and takes up less disk space.

    When you delete a class, you also delete all of its contents, including child classes, locators, fields, validation rules, structure rules, instructions, validation forms, and associated scripts.

    1. Expand the Project Tree and select the class to delete.

    2. On the Design tab, in the Edit group, select Delete Delete icon.

    3. When prompted, select OK to confirm the deletion.

  3. Save the changes to your project.