55 lines
4.3 KiB
Markdown
55 lines
4.3 KiB
Markdown
|
---
|
||
|
|
source_files:
|
||
|
|
- DataPRO/Modules/PreviousDBVersions/Version57/DatabaseExport/Classes/TabPage/TabPageCommon.cs
|
||
|
|
- DataPRO/Modules/PreviousDBVersions/Version57/DatabaseExport/Classes/TabPage/TabPage.cs
|
||
|
|
generated_at: "2026-04-16T04:59:00.585426+00:00"
|
||
|
|
model: "Qwen/Qwen3-Coder-Next-FP8"
|
||
|
|
schema_version: 1
|
||
|
|
sha256: "2bb1e521c729f483"
|
||
|
|
---
|
||
|
|
|
||
|
|
# TabPage
|
||
|
|
|
||
|
|
## Documentation: `TabPageCommon` and Related Types
|
||
|
|
|
||
|
|
### 1. Purpose
|
||
|
|
This module defines a lightweight, hierarchical data model for representing UI tab structures during database export operations in legacy (Version 57) contexts. It provides base abstractions (`TabPageCommon`, `TabPageItem`, `TabPageItemGroup`) to encapsulate tab content and grouping, and a singleton `TabPageSource` to expose a global collection of tab groups. The model is intended for *data export* (e.g., serialization, reporting), not runtime UI rendering—though it references `UserControl`, suggesting it may originate from or interface with WPF UI components.
|
||
|
|
|
||
|
|
### 2. Public Interface
|
||
|
|
- **`TabPageCommon`** (abstract class)
|
||
|
|
- `public virtual string GetName()` → Returns the value of `UniqueId`.
|
||
|
|
- `public string UniqueId { get; set; }` → A string identifier; defaults to `string.Empty`. Used as the logical name via `GetName()`.
|
||
|
|
|
||
|
|
- **`TabPageItem`** (class, inherits `TabPageCommon`)
|
||
|
|
- `public UserControl Content { get; set; }` → Holds the WPF UI content for the tab (nullable). Represents a single tab page.
|
||
|
|
|
||
|
|
- **`TabPageItemGroup`** (class, inherits `TabPageCommon`)
|
||
|
|
- `public ObservableCollection<TabPageItem> Items { get; }` → A mutable collection of `TabPageItem` instances belonging to this group. Initialized lazily (non-null).
|
||
|
|
|
||
|
|
- **`TabPageSource`** (static singleton class)
|
||
|
|
- `public ObservableCollection<TabPageItemGroup> AllGroups { get; }` → Global collection of tab groups.
|
||
|
|
- `public static IEnumerable<TabPageItemGroup> GetGroups(string uniqueid)` → Returns `_source.AllGroups` *only if* `uniqueid == "AllGroups"`; otherwise throws `ArgumentException`.
|
||
|
|
- *Note:* The method name and parameter suggest extensibility (e.g., filtering by ID), but only one value is currently supported.
|
||
|
|
|
||
|
|
### 3. Invariants
|
||
|
|
- `TabPageCommon.UniqueId` must be set to a non-null, non-whitespace string for meaningful identification (though not enforced by code).
|
||
|
|
- `TabPageItem.Content` may be `null`, but no validation prevents this.
|
||
|
|
- `TabPageItemGroup.Items` is never `null` (initialized inline) and uses `ObservableCollection<T>`, implying change notifications are expected.
|
||
|
|
- `TabPageSource.GetGroups()` enforces a strict invariant: **only** `"AllGroups"` is accepted as `uniqueid`; any other value throws `ArgumentException`.
|
||
|
|
- `TabPageSource` is a singleton: `_source` is initialized once and reused.
|
||
|
|
|
||
|
|
### 4. Dependencies
|
||
|
|
- **Depends on**:
|
||
|
|
- `System` (core types: `ArgumentException`, `IEnumerable<T>`, `ObservableCollection<T>`)
|
||
|
|
- `System.Collections.Generic` (`IEnumerable<T>`)
|
||
|
|
- `System.Collections.ObjectModel` (`ObservableCollection<T>`)
|
||
|
|
- `System.Windows.Controls` (`UserControl`)
|
||
|
|
- **Depended on by**:
|
||
|
|
- Unknown from source alone. Given the namespace `DatabaseExport`, this module is likely consumed by export-specific logic (e.g., serialization to XML/JSON, reporting tools). No explicit references to consumers are present.
|
||
|
|
|
||
|
|
### 5. Gotchas
|
||
|
|
- **Misleading `GetGroups` signature**: Despite accepting a `uniqueid` parameter, it only supports `"AllGroups"`. This suggests incomplete implementation or legacy design—future extensions may break callers if they assume filtering capability.
|
||
|
|
- **`GetName()` is trivial**: It directly returns `UniqueId` without normalization or fallback logic. Callers must ensure `UniqueId` is set meaningfully.
|
||
|
|
- **`UserControl` coupling**: Using `System.Windows.Controls.UserControl` ties this module to WPF, despite being in a *database export* context. This may cause issues if reused in non-UI or cross-platform scenarios.
|
||
|
|
- **No immutability guarantees**: `AllGroups` and `Items` are mutable collections. External code can modify them (add/remove groups/items), which may lead to race conditions if accessed concurrently (though no threading model is specified).
|
||
|
|
- **No documentation on lifecycle**: It is unclear how `TabPageSource.AllGroups` is populated—no initialization methods or event hooks are visible.
|