init
This commit is contained in:
@@ -0,0 +1,60 @@
|
||||
---
|
||||
source_files:
|
||||
- Common/DTS.CommonCore/Interface/Channels/ChannelCodes/IChannelCodesListView.cs
|
||||
- Common/DTS.CommonCore/Interface/Channels/ChannelCodes/IChannelCodesListViewModel.cs
|
||||
- Common/DTS.CommonCore/Interface/Channels/ChannelCodes/IChannelCode.cs
|
||||
generated_at: "2026-04-17T16:35:31.488668+00:00"
|
||||
model: "zai-org/GLM-5-FP8"
|
||||
schema_version: 1
|
||||
sha256: "c5ac64d4a1bfdb6b"
|
||||
---
|
||||
|
||||
# Documentation: DTS.Common.Interface.Channels.ChannelCodes
|
||||
|
||||
## 1. Purpose
|
||||
|
||||
This module defines the contract for a channel code management UI component within the DTS system. It provides interfaces for displaying, editing, and validating both ISO-standard and user-defined channel codes through a list-based view. The module separates concerns between the view (`IChannelCodesListView`), the view model (`IChannelCodesListViewModel`), and the individual data items (`IChannelCode`), enabling a Model-View-ViewModel (MVVM) architecture for channel code configuration.
|
||||
|
||||
---
|
||||
|
||||
## 2. Public Interface
|
||||
|
||||
### `IChannelCodesListView`
|
||||
**Signature:** `public interface IChannelCodesListView : IBaseView`
|
||||
|
||||
A marker interface extending `IBaseView` with no additional members. Represents the view abstraction for the channel codes list UI.
|
||||
|
||||
---
|
||||
|
||||
### `IChannelCodesListViewModel`
|
||||
**Signature:** `public interface IChannelCodesListViewModel : IBaseViewModel`
|
||||
|
||||
The primary interface for managing channel code lists.
|
||||
|
||||
**Properties:**
|
||||
|
||||
| Property | Type | Description |
|
||||
|----------|------|-------------|
|
||||
| `View` | `IChannelCodesListView` | Gets or sets the associated view instance. |
|
||||
| `ISOChannelCodes` | `ObservableCollection<IChannelCode>` | Collection of ISO channel codes displayed in the UI. |
|
||||
| `UserChannelCodes` | `ObservableCollection<IChannelCode>` | Collection of user-defined channel codes displayed in the UI. |
|
||||
| `ChannelCodesFunc` | `Func<IList<IChannelCode>>` | A function delegate that returns a list of channel codes. |
|
||||
| `ShowISOStringBuilder` | `bool` | Controls visibility of the ISO string builder UI element. |
|
||||
| `UniqueISOCodesRequired` | `bool` | Indicates whether ISO codes must be unique. |
|
||||
| `ShowChannelCodeLookupHelper` | `bool` | Controls visibility of the channel code lookup helper UI element. |
|
||||
| `IsReadOnly` | `bool` | Controls whether the UI is in read-only mode. |
|
||||
| `SelectedCodes` | `IChannelCode[]` | Returns an array of currently selected channel codes. |
|
||||
|
||||
**Methods:**
|
||||
|
||||
| Method | Signature | Description |
|
||||
|--------|-----------|-------------|
|
||||
| `Unset` | `void Unset()` | Clears or resets the view model state. |
|
||||
| `SetPage` | `void SetPage(object page)` | Associates a page object with the view model. |
|
||||
| `OnSetActive` | `void OnSetActive()` | Called when the view becomes active. |
|
||||
| `Save` | `bool Save()` | Persists changes; returns success status. |
|
||||
| `Validate` | `bool Validate(bool bDisplayWindow)` | Validates the current state; `bDisplayWindow` controls whether validation errors are shown in a UI window. |
|
||||
| `CopySelected` | `void CopySelected()` | Copies the currently selected channel codes. |
|
||||
| `DeleteSelected` | `void DeleteSelected()` | Deletes the currently selected channel codes. |
|
||||
| `Filter` | `void Filter(object columnTag, string searchTerm)` | Filters the displayed items based on a column tag and search term. |
|
||||
| `Sort` |
|
||||
Reference in New Issue
Block a user