Application Event Types Editor

Reference documentation for the Application Event Types Editor

Overview

Application Event Types Editor

The Application Event Types property allows developers to define and manage a list of custom application-level events for the current solution. These events can then be referenced programmatically, offering greater flexibility and maintainability across the solution.

Accessing the Editor

In the Solution Explorer, click the solution name (e.g., demo) and open the Properties view. Under the Properties section, locate the eventTypes field. Clicking on the [] button opens the Event Types Editor.

Sections : Editor Structure

Event Type List (Left Panel)

This panel displays all current custom event types as a vertical list of identifiers, one per line. Event names follow JavaScript naming conventions and must be unique. Clicking on the event name gives the user the possibility to edit it.

Description Area (Right Panel)

When an event is selected from the list, a description area is shown on the right side. Developers can enter text to document the purpose of the selected event.

Sections : Buttons and UI Elements

Per-Event Buttons

• Delete Icon: Appears next to each event type in the list. Clicking this removes the corresponding event.

Global Buttons

• Add New Event Type: Opens a dialog that prompts for a new event name.

  • Fields:

    • Event Name: Text input to define the new event.

  • Buttons:

    • OK: Confirms and adds the event.

    • Cancel: Closes the dialog without changes.

• OK (in the editor footer): Confirms changes and closes the editor.

• Cancel (in the editor footer): Discards changes and closes the editor.

How to Use the Editor

Here are the steps for using the Application Event Types Editor:

1. Opening the Editor

   • Go to the Solution Explorer and click the solution name.
   • In the Properties view, locate the eventTypes property

   • Click the [ ] icon to open the Application Event Types Editor.

2. Adding a New Event Type

   • Click the Add New Event Type button.

   • In the prompt dialog:

     • Enter a unique name for the event (e.g., onBeforeDataSync).

     • Click OK.

   • The new event will appear in the list.

3. Editing an Event Description

   • Select an event from the list.

   • Type a description in the right panel. This helps document what the event does or when it should be triggered.

4. Deleting an Event

   • Click the Delete icon next to the event you wish to remove.

5. Saving or Discarding Changes

   • Click OK to save your edits and close the editor.

   • Click Cancel to close the editor without saving.