108 lines
6.6 KiB
Markdown
108 lines
6.6 KiB
Markdown
---
|
||
source_files:
|
||
- DataPRO/Modules/SystemSettings/TestSettings/ViewModel/TestSettingsViewModel.cs
|
||
generated_at: "2026-04-16T04:43:11.486742+00:00"
|
||
model: "Qwen/Qwen3-Coder-Next-FP8"
|
||
schema_version: 1
|
||
sha256: "c0f752d14370c409"
|
||
---
|
||
|
||
# ViewModel
|
||
|
||
### **1. Purpose**
|
||
This module implements the `TestSettingsViewModel`, a Prism-based MVVM view model responsible for managing the UI state and interaction patterns for the Test Settings feature within the application. It acts as the data context for `ITestSettingsView`, coordinates with the Prism infrastructure (region management, event aggregation, Unity container), and exposes interaction requests for displaying notifications and confirmation dialogs. Though named `TestSettingsViewModel`, the current implementation is largely skeletal—providing boilerplate lifecycle hooks and property change notifications—but does not yet contain domain-specific logic for test settings.
|
||
|
||
---
|
||
|
||
### **2. Public Interface**
|
||
|
||
#### **Properties**
|
||
- `bool IsDirty { get; private set; }`
|
||
A read-only property indicating whether the view model’s state has unsaved changes. Currently always `false` (no implementation to set it).
|
||
|
||
- `bool IsBusy { get; set; }`
|
||
Gets or sets a flag indicating whether the UI is in a busy state (e.g., processing). Raises `PropertyChanged` for `"IsBusy"` on change.
|
||
|
||
- `bool IsMenuIncluded { get; set; }`
|
||
Gets or sets whether the menu UI element should be included. Raises `PropertyChanged` for `"IsMenuIncluded"` on change. Defaults to `false`.
|
||
|
||
- `bool IsNavigationIncluded { get; set; }`
|
||
Gets or sets whether the navigation UI element should be included. Raises `PropertyChanged` for `"IsNavigationIncluded"` on change. Defaults to `false`.
|
||
|
||
- `string HeaderInfo { get; }`
|
||
Returns the hardcoded string `"MainRegion"`—used as a header identifier (likely for region naming or layout).
|
||
|
||
#### **Interaction Requests**
|
||
- `InteractionRequest<Notification> NotificationRequest { get; }`
|
||
Exposes a Prism `InteractionRequest` for triggering notification popups (e.g., informational messages). Used by `OnRaiseNotification`.
|
||
|
||
- `InteractionRequest<Confirmation> ConfirmationRequest { get; }`
|
||
Exposes a Prism `InteractionRequest` for confirmation dialogs (e.g., yes/no prompts). Currently unused in the source.
|
||
|
||
#### **Methods**
|
||
- `void Cleanup()`
|
||
Lifecycle hook for cleanup. Currently empty.
|
||
|
||
- `Task CleanupAsync()`
|
||
Async version of `Cleanup()`. Returns `Task.CompletedTask`.
|
||
|
||
- `void Initialize()`
|
||
Parameterless initialization hook. Currently empty.
|
||
|
||
- `void Initialize(object parameter)`
|
||
Initialization with a single parameter. Currently empty.
|
||
|
||
- `void Initialize(object parameter, object model)`
|
||
Initialization with parameter and model. Currently empty.
|
||
|
||
- `Task InitializeAsync()`
|
||
Async initialization without parameters. Returns `Task.CompletedTask`.
|
||
|
||
- `Task InitializeAsync(object parameter)`
|
||
Async initialization with parameter. Returns `Task.CompletedTask`.
|
||
|
||
- `void Activated()`
|
||
Lifecycle hook called when the view is activated. Currently empty.
|
||
|
||
---
|
||
|
||
### **3. Invariants**
|
||
- `IsBusy` must always be set via the property setter to ensure `OnPropertyChanged("IsBusy")` is raised. Direct field access bypasses change notification.
|
||
- `IsMenuIncluded` and `IsNavigationIncluded` follow the same invariant: changes must go through the property setter to notify UI.
|
||
- `HeaderInfo` is a constant `"MainRegion"` and never changes.
|
||
- `NotificationRequest` and `ConfirmationRequest` are initialized in the constructor and never reassigned.
|
||
- The `OnPropertyChanged` method is invoked only via the property setters or `OnRaiseNotification`/`OnBusyIndicatorNotification` handlers.
|
||
|
||
---
|
||
|
||
### **4. Dependencies**
|
||
|
||
#### **Imports / Dependencies Used**
|
||
- **Prism Libraries**:
|
||
- `Prism.Events.IEventAggregator` — for subscribing to events like `RaiseNotification` and `BusyIndicatorChangeNotification`.
|
||
- `Prism.Regions.IRegionManager` — for region management (used in constructor but not yet utilized in logic).
|
||
- `Prism.Interactivity.InteractionRequest<Notification/Confirmation>` — for UI interaction patterns.
|
||
- **Unity Container**:
|
||
- `Unity.IUnityContainer` — injected via constructor, likely for service resolution (not used beyond storage).
|
||
- **Custom DTS Common Libraries**:
|
||
- `DTS.Common.Base` — base types (e.g., `IBasePropertyChanged`).
|
||
- `DTS.Common.Events` — defines `RaiseNotification`, `BusyIndicatorChangeNotification`, and `NotificationContentEventArgs`.
|
||
- `DTS.Common.Interactivity` — likely contains `Notification`, `NotificationContentEventArgs`, and `Confirmation` types.
|
||
- `DTS.Common.Interface` — defines `ITestSettingsView` and `ITestSettingsViewModel`.
|
||
|
||
#### **Consumers / Dependents**
|
||
- The view `ITestSettingsView` (likely XAML) binds to this view model’s properties (`IsBusy`, `IsMenuIncluded`, etc.) and interaction requests.
|
||
- Event publishers (e.g., `RaiseNotification` and `BusyIndicatorChangeNotification` events) depend on this view model subscribing to them.
|
||
|
||
---
|
||
|
||
### **5. Gotchas**
|
||
- **`SetProperty` throws `NotImplementedException`**: The `SetProperty<T>` method (likely intended for use with `INotifyPropertyChanged` helpers) is unimplemented and will crash if called. This suggests incomplete migration from a base class or missing refactoring.
|
||
- **`IBasePropertyChanged.OnPropertyChanged` is implemented explicitly**: While `OnPropertyChanged` is public, the explicit interface implementation may cause confusion if callers expect to invoke it via the interface directly without casting.
|
||
- **`NotificationRequest` expects `NotificationContentEventArgsWithoutTitle` internally**: The `OnRaiseNotification` handler constructs a new `NotificationContentEventArgs` with empty strings for title and footer, but the XML comment incorrectly refers to `NotificationContentEventArgsWithoutTitle` (which does not appear in the source). This may indicate a mismatch between documentation and actual types.
|
||
- **`HeaderInfo` is hardcoded**: Its value `"MainRegion"` suggests it may be used as a region name, but this is not validated or enforced—misuse could cause region resolution issues.
|
||
- **No actual test settings logic**: Despite the name, the view model contains no domain-specific behavior. This may be intentional (stubbed for future work) or a naming artifact.
|
||
- **`IsDirty` is never set**: Though declared, there is no logic to track dirty state—any UI expecting this to drive save-button states will be non-functional.
|
||
- **`Cleanup`/`Initialize` methods are empty**: These lifecycle hooks are standard in Prism but currently serve no purpose—could lead to confusion if consumers expect side effects.
|
||
|
||
*None identified beyond the above.* |