82 lines
2.6 KiB
Markdown
82 lines
2.6 KiB
Markdown
|
---
|
||
|
|
source_files:
|
||
|
|
- Common/DTS.CommonCore/Interface/StatusAndProgressBar/IStatusAndProgressBarView.cs
|
||
|
|
- Common/DTS.CommonCore/Interface/StatusAndProgressBar/IStatusAndProgressFooterView.cs
|
||
|
|
- Common/DTS.CommonCore/Interface/StatusAndProgressBar/IStatusAndProgressBarFooterViewModel.cs
|
||
|
|
- Common/DTS.CommonCore/Interface/StatusAndProgressBar/IStatusAndProgressBarViewModel.cs
|
||
|
|
- Common/DTS.CommonCore/Interface/StatusAndProgressBar/StatusAndProgressDelegates.cs
|
||
|
|
generated_at: "2026-04-17T16:34:19.320352+00:00"
|
||
|
|
model: "zai-org/GLM-5-FP8"
|
||
|
|
schema_version: 1
|
||
|
|
sha256: "b789755888677236"
|
||
|
|
---
|
||
|
|
|
||
|
|
# Documentation: Status and Progress Bar Interfaces
|
||
|
|
|
||
|
|
## 1. Purpose
|
||
|
|
|
||
|
|
This module defines the contract interfaces and delegate types for a status and progress bar component within a View-ViewModel architecture. It provides the abstraction layer for displaying progress indicators and status information, supporting both standard and "footer" style presentations. The module enables decoupled communication between views and view models for progress reporting functionality.
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
## 2. Public Interface
|
||
|
|
|
||
|
|
### Interfaces
|
||
|
|
|
||
|
|
#### `IStatusAndProgressBarView`
|
||
|
|
**Namespace:** `DTS.Common.Interface`
|
||
|
|
**Inherits:** `IBaseView`
|
||
|
|
|
||
|
|
An empty marker interface extending `IBaseView`. No members defined.
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
#### `IStatusAndProgressFooterView`
|
||
|
|
**Namespace:** `DTS.Common.Interface`
|
||
|
|
**Inherits:** `IBaseView`
|
||
|
|
|
||
|
|
An empty marker interface extending `IBaseView`. No members defined.
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
#### `IStatusAndProgressBarFooterViewModel`
|
||
|
|
**Namespace:** `DTS.Common.Interface`
|
||
|
|
**Inherits:** `IBaseViewModel`
|
||
|
|
|
||
|
|
| Property | Type | Accessor |
|
||
|
|
|----------|------|----------|
|
||
|
|
| `View` | `IStatusAndProgressFooterView` | `get; set;` |
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
#### `IStatusAndProgressBarViewModel`
|
||
|
|
**Namespace:** `DTS.Common.Interface`
|
||
|
|
**Inherits:** `IBaseViewModel`
|
||
|
|
|
||
|
|
| Property | Type | Accessor |
|
||
|
|
|----------|------|----------|
|
||
|
|
| `View` | `IBaseView` | `get; set;` |
|
||
|
|
| `Parent` | `IBaseViewModel` | `get; set;` |
|
||
|
|
| `ProgressBarName` | `string` | `get; set;` |
|
||
|
|
| `ContextSearchRegion` | `object` | `get; set;` |
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
### Delegates
|
||
|
|
|
||
|
|
**Namespace:** `DTS.Common.Interface.StatusAndProgressBar`
|
||
|
|
|
||
|
|
| Delegate Name | Signature |
|
||
|
|
|---------------|-----------|
|
||
|
|
| `SetProgressValueDelegate` | `void (double value)` |
|
||
|
|
| `SetStatusTextDelegate` | `void (string text)` |
|
||
|
|
| `SetProgressVisibilityDelegate` | `void (bool bVisible)` |
|
||
|
|
| `SetStatusColorDelegate` | `void (Color color)` |
|
||
|
|
| `ActionCompleteDelegate` | `void ()` |
|
||
|
|
| `StatusIntDelegate` | `void (int status)` |
|
||
|
|
| `StatusExIntDelegate` | `void (int status, params object[] extra)` |
|
||
|
|
| `ErrorCallback` | `DialogResult (string errorString, string unit)` |
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
## 3. Invariants
|