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,154 @@
---
source_files:
- Common/DTS.Common/obj/x86/Debug/Controls/RoundedBox.g.i.cs
- Common/DTS.Common/obj/x86/Debug/Controls/RoundedBox.g.cs
- Common/DTS.Common/obj/x86/Debug/Controls/TestIDView.g.cs
- Common/DTS.Common/obj/x86/Debug/Controls/TestIDView.g.i.cs
- Common/DTS.Common/obj/x86/Debug/Controls/TestIDControl.g.cs
- Common/DTS.Common/obj/x86/Debug/Controls/TestIDControl.g.i.cs
- Common/DTS.Common/obj/x86/Debug/Controls/CommonStatusRibbon.g.i.cs
- Common/DTS.Common/obj/x86/Debug/Controls/CommonStatusRibbon.g.cs
- Common/DTS.Common/obj/x86/Debug/Controls/TestIDTestBox.g.cs
- Common/DTS.Common/obj/x86/Debug/Controls/TestIDTestBox.g.i.cs
- Common/DTS.Common/obj/x86/Debug/Controls/LookupPopup.g.cs
- Common/DTS.Common/obj/x86/Debug/Controls/LookupPopup.g.i.cs
- Common/DTS.Common/obj/x86/Debug/Controls/checkbox.g.cs
- Common/DTS.Common/obj/x86/Debug/Controls/checkbox.g.i.cs
- Common/DTS.Common/obj/x86/Debug/Controls/GridViewColumnHeaderSearchable.g.cs
generated_at: "2026-04-17T15:26:23.476067+00:00"
model: "zai-org/GLM-5-FP8"
schema_version: 1
sha256: "a1206f2f96436583"
---
# Documentation: DTS.Common.Controls (Auto-Generated WPF Components)
## 1. Purpose
This module contains auto-generated partial classes produced by the WPF build process (PresentationBuildTasks) from XAML files in the `DTS.Common` assembly. These generated files provide the code-behind infrastructure for loading XAML resources at runtime via `Application.LoadComponent`. The controls defined here are UI components in the `DTS.Common.Controls` namespace, including custom user controls, a popup dialog, and a resource dictionary for checkbox styling. **Note:** These are intermediate build outputs located in `obj/x86/Debug/Controls/`, not source files; the actual implementation logic resides in companion `.xaml` files and corresponding hand-written partial class files not provided here.
---
## 2. Public Interface
### Classes
#### `RoundedBox`
- **Inherits:** `System.Windows.Controls.UserControl`
- **Implements:** `System.Windows.Markup.IComponentConnector`
- **Public Methods:**
- `void InitializeComponent()` — Loads the XAML resource from `/DTS.Common;component/controls/roundedbox.xaml`. Guards against multiple initialization via `_contentLoaded` flag.
#### `TestIDView`
- **Inherits:** `System.Windows.Controls.UserControl`
- **Implements:** `System.Windows.Markup.IComponentConnector`
- **Public Methods:**
- `void InitializeComponent()` — Loads the XAML resource from `/DTS.Common;component/controls/testidview.xaml`.
#### `TestIdControl`
- **Inherits:** `System.Windows.Controls.UserControl`
- **Implements:** `System.Windows.Markup.IComponentConnector`
- **Internal Fields:**
- `TestIdInfo` (`DTS.Common.Controls.TestIdControl`) — Self-referencing field bound at XAML line 6.
- **Public Methods:**
- `void InitializeComponent()` — Loads the XAML resource from `/DTS.Common;component/controls/testidcontrol.xaml`.
#### `CommonStatusRibbon`
- **Inherits:** `System.Windows.Controls.UserControl`
- **Implements:** `System.Windows.Markup.IComponentConnector`
- **Internal Fields:**
- `commonStatusRibbon` (`DTS.Common.Controls.CommonStatusRibbon`) — Self-referencing field bound at XAML line 6.
- `lblAggregateStatusText` (`System.Windows.Controls.TextBlock`) — Bound at XAML line 80.
- **Public Methods:**
- `void InitializeComponent()` — Loads the XAML resource from `/DTS.Common;component/controls/commonstatusribbon.xaml`.
#### `TestIDTextBox`
- **Inherits:** `System.Windows.Controls.UserControl`
- **Implements:** `System.Windows.Markup.IComponentConnector`
- **Internal Fields:**
- `TestIdTextBoxControl` (`DTS.Common.Controls.TestIDTextBox`) — Self-referencing field bound at XAML line 10.
- `tbTestId` (`System.Windows.Controls.TextBox`) — Bound at XAML line 14.
- **Event Handlers (referenced but not defined in generated code):**
- `tbTestId_PreviewTextInput` — Wired to `PreviewTextInput` event on `tbTestId`.
- **Public Methods:**
- `void InitializeComponent()` — Loads the XAML resource from `/DTS.Common;component/controls/testidtestbox.xaml`.
#### `LookupPopup`
- **Inherits:** `System.Windows.Controls.Primitives.Popup` (not UserControl)
- **Implements:** `System.Windows.Markup.IComponentConnector`
- **Internal Fields:**
- `lookupPopup` (`DTS.Common.Controls.LookupPopup`) — Self-referencing field bound at XAML line 12.
- `possibleChannels` (`System.Windows.Controls.DataGrid`) — Bound at XAML line 42.
- **Event Handlers (referenced but not defined in generated code):**
- `LookupPopup_OnOpenedClosed` — Wired to both `Opened` and `Closed` events.
- `PossibleChannels_OnMouseDoubleClick` — Wired to `MouseDoubleClick` on `possibleChannels`.
- **Public Methods:**
- `void InitializeComponent()` — Loads the XAML resource from `/DTS.Common;component/controls/lookuppopup.xaml`.
#### `checkbox`
- **Inherits:** `System.Windows.ResourceDictionary`
- **Implements:** `System.Windows.Markup.IComponentConnector`, `System.Windows.Markup.IStyleConnector`
- **Event Handlers (referenced but not defined in generated code):**
- `ToolTipEventHandler` — Wired to `ToolTipOpeningEvent` in two styles (connectionId 1 at line 84, connectionId 2 at line 95).
- **Public Methods:**
- `void InitializeComponent()` — Loads the XAML resource from `/DTS.Common;component/controls/checkbox.xaml`.
#### `GridViewColumnHeaderSearchable`
- **Inherits:** `System.Windows.Controls.UserControl`
- **Implements:** `System.Windows.Markup.IComponentConnector`
- **Internal Fields:**
- `dtsGridViewColumnHeader` (`DTS.Common.Controls.GridViewColumnHeaderSearchable`) — Self-referencing field bound at XAML line 8.
- `mainGrid` (`System.Windows.Controls.Grid`) — Bound at XAML line 19.
- `TogglePopupButton` (`System.Windows.Controls.Primitives.ToggleButton`) — Bound at XAML line 28.
- `BtnArrow` (`System.Windows.Shapes.Path`) — Bound at XAML line 30.
- `ToggledPopup` (`System.Windows.Controls.Primitives.Popup`) — Bound at XAML line 33.
- **Event Handlers (referenced but not defined in generated code):**
- `PreviewLeftButtonUp` — Wired to `PreviewMouseLeftButtonDown` on `dtsGridViewColumnHeader`.
- `HeaderSearchTerm_KeyDown` — Wired to `KeyUp` on an unnamed TextBox at line 41.
- **Public Methods:**
- `void InitializeComponent()` — Loads the XAML resource from `/DTS.Common;component/controls/gridviewcolumnheadersearchable.xaml`.
---
## 3. Invariants
1. **Single Initialization Guarantee:** `InitializeComponent()` uses the `_contentLoaded` boolean flag to ensure XAML resource loading occurs exactly once per instance. Subsequent calls return early without re-loading.
2. **Partial Class Contract:** All classes are declared `partial` and must have corresponding hand-written code-behind files (not provided) that complete the implementation, including event handlers referenced in `Connect()` methods.
3. **Resource URI Format:** All XAML resources follow the pack URI format `/DTS.Common;component/controls/{filename}.xaml` with `UriKind.Relative`.
4. **Thread Affinity:** As WPF controls, all instances must be created and accessed on the UI thread (implied by inheritance from `DispatcherObject` via `DependencyObject`).
5. **IComponentConnector Contract:** The explicit interface implementation `Connect(int connectionId, object target)` is marked `void` and is used by the WPF parser to wire up named elements and events during XAML parsing.
---
## 4. Dependencies
### External Dependencies (from imports)
- `System.Windows.*` namespaces (WPF core): `System.Windows`, `System.Windows.Controls`, `System.Windows.Controls.Primitives`, `System.Windows.Data`, `System.Windows.Documents`, `System.Windows.Input`, `System.Windows.Markup`, `System.Windows.Media`, `System.Windows.Shapes`, `System.Windows.Navigation`, `System.Windows.Automation`, `System.Windows.Ink`, `System.Windows.Media.Animation`, `System.Windows.Media.Effects`, `System.Windows.Media.Imaging`, `System.Windows.Media.Media3D`, `System.Windows.Media.TextFormatting`, `System.Windows.Shell`
- `Microsoft.Windows.Controls` — Indicates dependency on a custom or extended WPF control library (possibly WPF Toolkit or custom assembly).
- `DTS.Common.Strings` — Referenced in `LookupPopup`, indicating a string resource or localization dependency.
### Internal Dependencies
- `DTS.Common.Controls` — Self-referential; controls reference each other within the same namespace.
### Consumers
- Unknown from provided source alone. These controls are likely consumed by other assemblies/projects referencing `DTS.Common`.
---
## 5. Gotchas
1. **Auto-Generated Files:** These files are located in `obj/x86/Debug/Controls/` and are regenerated on each build. **Do not edit these files directly.** Changes will be lost. The actual source is the corresponding `.xaml` and `.xaml.cs` files in `Controls/`.
2. **Missing Implementation:** Event handlers such as `tbTestId_PreviewTextInput`, `LookupPopup_OnOpenedClosed`, `PossibleChannels_OnMouseDoubleClick`, `ToolTipEventHandler`, `PreviewLeftButtonUp`, and `HeaderSearchTerm_KeyDown` are referenced but not defined in these generated files. They must exist in the hand-written partial class files.
3. **Self-Referencing Fields:** Several controls (`TestIdControl`, `CommonStatusRibbon`, `TestIDTextBox`, `LookupPopup`, `GridViewColumnHeaderSearchable`) have internal fields referencing their own type. This pattern suggests the XAML contains a named element matching the control type (possibly a root element with `x:Name`). The purpose is unclear from generated code alone.
4. **Naming Inconsistency:** The file `TestIDTestBox.g.cs` defines class `TestIDTextBox` (note: "TextBox" vs "TestBox" in filename). The XAML resource path is `testidtestbox.xaml`. This discrepancy may cause confusion.
5. **Event Naming Mismatch:** In `GridViewColumnHeaderSearchable`, the event handler `PreviewLeftButtonUp` is wired to the `PreviewMouseLeftButtonDown` event. The handler name suggests "Up" while the event is "Down" — this may be intentional or a bug in the hand-written code.
6. **Debug Build Configuration:** These files are from an x86 Debug build. Release builds or different platform targets may produce different generated code.