This commit is contained in:
2026-04-17 14:55:32 -04:00
commit bc3ac1d4c9
18017 changed files with 4371742 additions and 0 deletions

View File

@@ -0,0 +1,122 @@
---
source_files:
- Common/DTS.CommonCore/Events/LoginUserEvent.cs
- Common/DTS.CommonCore/Events/TextPastedEvent.cs
- Common/DTS.CommonCore/Events/BusyIndicatorChangeNotification.cs
- Common/DTS.CommonCore/Events/ComActiveEvent.cs
- Common/DTS.CommonCore/Events/CloseApplicationRequested.cs
- Common/DTS.CommonCore/Events/TabControlSelectionChanged.cs
- Common/DTS.CommonCore/Events/RaiseNotification.cs
- Common/DTS.CommonCore/Events/PageSetActiveEvent.cs
- Common/DTS.CommonCore/Events/GroupTemplateChangeNotification.cs
- Common/DTS.CommonCore/Events/DatabaseVersionChangedEvent.cs
- Common/DTS.CommonCore/Events/SetSaveButton.cs
- Common/DTS.CommonCore/Events/DBConnectionEvent.cs
- Common/DTS.CommonCore/Events/AutomaticModeStatusEvent.cs
- Common/DTS.CommonCore/Events/SetPageVisibilityEvent.cs
- Common/DTS.CommonCore/Events/LogoutUserEvent.cs
- Common/DTS.CommonCore/Events/PageNameEvent.cs
- Common/DTS.CommonCore/Events/TestEvent.cs
- Common/DTS.CommonCore/Events/PageSelectionChanged.cs
- Common/DTS.CommonCore/Events/UserEvent.cs
- Common/DTS.CommonCore/Events/ListViewStatusEvent.cs
- Common/DTS.CommonCore/Events/HelpTextEvent.cs
- Common/DTS.CommonCore/Events/PageModifiedEvent.cs
- Common/DTS.CommonCore/Events/FeedbackEvent.cs
- Common/DTS.CommonCore/Events/AssemblyListNotification.cs
- Common/DTS.CommonCore/Events/CancelProcess.cs
- Common/DTS.CommonCore/Events/TabControlSelectionEventArgs.cs
- Common/DTS.CommonCore/Events/SLICE6MulticastPropertyEvent.cs
- Common/DTS.CommonCore/Events/AppStatusEvent.cs
- Common/DTS.CommonCore/Events/PageErrorEvent.cs
- Common/DTS.CommonCore/Events/PageNavigationRequestEvent.cs
- Common/DTS.CommonCore/Events/ProgressBarEvent.cs
- Common/DTS.CommonCore/Events/NotificationContentEventArgs.cs
- Common/DTS.CommonCore/Events/ShowStatus.cs
generated_at: "2026-04-17T15:26:58.440755+00:00"
model: "zai-org/GLM-5-FP8"
schema_version: 1
sha256: "c17782c70c9f76dc"
---
# DTS.Common.Events Module Documentation
## 1. Purpose
This module defines the event aggregation layer for the DTS application using the Prism Framework's `CompositePresentationEvent<T>` pattern. It provides a loosely-coupled pub/sub messaging system enabling communication between application components without direct references. The events cover user authentication lifecycle, database connectivity, UI state management (busy indicators, save buttons, progress bars), page navigation and modification tracking, tab control operations, and hardware communication status (COM ports, SLICE6 multicast properties).
---
## 2. Public Interface
### Authentication Events
**`LoginUserEvent`** : `CompositePresentationEvent<LoginUserArg>`
- Published when a user logs in. Payload contains `UserName`.
**`LogoutUserEvent`** : `CompositePresentationEvent<LogoutUserArg>`
- Published when a user logs out. `LogoutUserArg.Reason` uses enum `Reasons` (value: `DatabaseSwitch`).
### Database Events
**`DBConnectionEvent`** : `CompositePresentationEvent<DBConnectionArg>`
- Notifies subscribers of database connection state changes.
- `DBConnectionArg` properties: `Connected` (bool), `DBName` (string), `Server` (string).
**`DatabaseVersionChangedEvent`** : `CompositePresentationEvent<DatabaseVersionChangedEventArgs>`
- Notifies subscribers when database version changes.
- `DatabaseVersionChangedEventArgs.Version` (string, defaults to `string.Empty`).
### Application Lifecycle Events
**`CloseApplicationRequested`** : `CompositePresentationEvent<object>`
- Published when application closure is requested.
**`AppStatusEvent`** : `CompositePresentationEvent<AppStatusArg>`
- Notifies application busy/available state.
- `AppStatusArg` enum values: `Busy`, `Available`, `Shutdown`, `Close`, `UserLogout`.
**`AppStatusExEvent`** : `CompositePresentationEvent<AppStatusExArg>`
- Extended app status with additional process name.
- `AppStatusExArg` properties: `Status` (AppStatusArg), `Name` (string).
**`BusyIndicatorChangeNotification`** : `CompositePresentationEvent<bool>`
- Controls busy indicator visibility. Payload is boolean state.
### UI Control Events
**`SetSaveButton`** : `CompositePresentationEvent<SaveButtonUsability>`
- Enables/disables save button.
- `SaveButtonUsability.IsUsable` (bool).
**`TabControlSelectionChanged`** : `CompositePresentationEvent<TabControlSelectionEventArgs>`
- Notifies tab control changes.
- `TabControlSelectionEventArgs` constructor: `(TabControlOperation operation, object item)`.
- Properties: `Operation`, `Item`.
**`SetPageHeaderVisibilityEvent`** : `CompositePresentationEvent<SetPageHeaderVisibilityEventArgs>`
- Controls page header visibility.
- Properties: `SetVisiblity` (bool), `Visibility` (System.Windows.Visibility).
**`ProgressBarEvent`** : `CompositePresentationEvent<ProgressBarEventArg>`
- Controls progress bar state.
- `ProgressBarEventArg` properties: `ProgressBarName`, `ProgressBarColor`, `SetPercentage`, `ProgressBarPercentage`, `SetText`, `ProgressBarText`, `SetVisibility`, `ProgressBarVisibility`.
- Default constructor sets `ProgressBarName` to `"Footer"`.
**`RaiseNotification`** : `CompositePresentationEvent<NotificationContentEventArgs>`
- Displays notification popup.
- `NotificationContentEventArgs` constructor: `(string message, string messageDetails = "", PopupWindowImage image = PopupWindowImage.Error, string title = "")`.
- Properties: `Message`, `MessageDetails`, `Image`, `Title`.
**`NotificationContentEventArgsWithoutTitle`**
- Variant without title property. Constructor: `(string message, string messageDetails = "", PopupWindowImage image = PopupWindowImage.Error)`.
### Page Events
**`PageSetActiveEvent`** : `CompositePresentationEvent<PageSetActiveEventArg>`
- Notifies when a page becomes active.
- `PageSetActiveEventArg.Page` (type: `IDataPROPage`).
**`PageNameEvent`** : `CompositePresentationEvent<PageNameEventArg>`
- Notifies page name updates.
- Constructor