41 lines
3.2 KiB
Markdown
41 lines
3.2 KiB
Markdown
|
---
|
|||
|
|
source_files:
|
|||
|
|
- DataPRO/Modules/DatabaseImporter/DatabaseImport/Converters/EnumDescriptionTypeConverter.cs
|
|||
|
|
generated_at: "2026-04-16T04:29:54.553980+00:00"
|
|||
|
|
model: "Qwen/Qwen3-Coder-Next-FP8"
|
|||
|
|
schema_version: 1
|
|||
|
|
sha256: "60faab8710c59a2c"
|
|||
|
|
---
|
|||
|
|
|
|||
|
|
# Converters
|
|||
|
|
|
|||
|
|
## Documentation: `EnumDescriptionTypeConverter`
|
|||
|
|
|
|||
|
|
### 1. Purpose
|
|||
|
|
This module provides a custom type converter for .NET enums that enables WPF data binding to display human-readable descriptions (via `DescriptionAttribute`) instead of the raw enum names or underlying values. It extends `System.ComponentModel.EnumConverter` to support scenarios where enum members are decorated with `[Description("...")]`, allowing UI frameworks like WPF to render meaningful labels (e.g., "Active User" instead of `ActiveUser`) during data binding operations. Its role is to bridge the gap between enum definitions and user-facing text in UI contexts.
|
|||
|
|
|
|||
|
|
### 2. Public Interface
|
|||
|
|
- **`EnumDescriptionTypeConverter(Type type)`**
|
|||
|
|
*Constructor.* Initializes a new instance of `EnumDescriptionTypeConverter` for the specified `enum` type.
|
|||
|
|
- **Parameters:**
|
|||
|
|
- `type`: The `Type` of the enum to convert (must be an enum type).
|
|||
|
|
- **Behavior:** Delegates to the base `EnumConverter` constructor. No additional logic is implemented in this class beyond inheritance.
|
|||
|
|
|
|||
|
|
### 3. Invariants
|
|||
|
|
- The `type` parameter passed to the constructor **must** be an enum type (i.e., `Type.IsEnum == true`); otherwise, the base `EnumConverter` constructor will throw an `ArgumentException`.
|
|||
|
|
- The converter does **not** validate or modify the enum type itself—it relies on the base `EnumConverter`’s behavior for parsing and formatting.
|
|||
|
|
- No runtime validation of `[DescriptionAttribute]` presence is performed; missing attributes fall back to the enum member’s name (handled by the base class).
|
|||
|
|
|
|||
|
|
### 4. Dependencies
|
|||
|
|
- **Depends on:**
|
|||
|
|
- `System.ComponentModel.EnumConverter` (base class).
|
|||
|
|
- `System.DescriptionAttribute` (implicitly, via the base class’s expected usage pattern—though not explicitly referenced in this file).
|
|||
|
|
- **Used by:**
|
|||
|
|
- WPF data binding infrastructure (e.g., via `TypeConverterAttribute` applied to enum types or properties).
|
|||
|
|
- Likely referenced by other modules in `DatabaseImport` namespace that bind enums to UI controls (e.g., comboboxes, labels).
|
|||
|
|
|
|||
|
|
### 5. Gotchas
|
|||
|
|
- **No custom logic implemented:** Despite the class name and summary comment, this implementation **does not override** `ConvertTo`/`ConvertFrom` methods. As written, it behaves identically to `EnumConverter` and will **not** automatically use `[DescriptionAttribute]` values. To achieve the described behavior, overrides for `ConvertTo` (and possibly `ConvertFrom`) are required but absent in the source.
|
|||
|
|
- **Documentation mismatch:** The referenced blog post (`http://brianlagunas.com/...`) likely contains the intended implementation pattern, but the current code is incomplete.
|
|||
|
|
- **Common mistake:** Developers may assume this converter enables `DescriptionAttribute` support out-of-the-box, leading to incorrect expectations about UI rendering.
|
|||
|
|
- **None identified from source alone** regarding other behaviors, but the lack of overrides is a critical gap.
|