Control documentation standard
Use this structure when authoring or upgrading topics under Documents/Toolkit/Controls/.
Required sections
- Title — control type name (
# KryptonDataGridView) - Overview — purpose,
Namespace,Assembly, inheritance chain - Key features — grouped bullets (palette, behavior, designer)
- Class hierarchy —
texttree - Constructor — signature and default behavior
- Properties — Krypton-specific and notable overrides; each important member:
### PropertyNamecsharpsignature- Category, default, description, remarks, short example
- Methods — public API not inherited from base
- Events — Krypton-specific events
- Usage / feature guides — designer walkthroughs, figures, scenarios (legacy tutorial content belongs here)
- Best practices
- See also — related controls,
TestFormdemos, Microsoft docs for base types
Conventions
- Match existing repo voice: complete sentences, italics for designer property paths in prose,
`csharp`for types and members in API blocks. - Document hidden WinForms properties when users migrating from
DataGridViewneed to know palette replaces them. - Cross-link related topics with relative paths (
[KryptonGroup](KryptonGroup.md)). - Screenshots live in
Documents/Toolkit/Images/; reference as../Images/.... - Prefer accuracy from source (
Source/Krypton Components/Krypton.Toolkit) over memory. - V110+ assembly moves: note
Krypton.Toolkit.Utilitieswhen applicable.
Coverage status
See Controls.md for the index and per-topic coverage tier (comprehensive / legacy / needs work).