Class Help

Displays contextual help and documentation for the object type currently being edited in the Property Grid.

Remarks

Overview

The Class Help control provides rich, contextual documentation for the type of object being configured in the Property Grid. It is designed to help users understand the purpose, configuration options, and best practices for the selected object type.

UI Components

• Help Window:
  • Shows the summary and detailed remarks for the current object type.
  • May include formatted text, code examples, and SVG diagrams.
  • Displays links to related documentation, wiki pages, or help topics.
• See Also Section:
  • Lists related types and controls, helping users explore similar or dependent objects.
• Used By Section:
  • Shows which other types reference or use the current type, providing insight into relationships and dependencies.
• Wiki Links:
  • Provides direct links to relevant wiki pages for deeper exploration.

Interactive Features

• Dynamic Content:
  • Updates automatically when the Property Grid is focused on a new object type or when a category label is selected.
  • If a property is focused, the help window may show property-specific help; otherwise, it displays class-level help.
• Help Links:
  • Clickable links to related topics, wiki pages, or external documentation.
  • Links are automatically replaced and formatted for the current application context.
• Remarks and Examples:
  • Detailed remarks provide background, configuration tips, and usage scenarios.
  • Examples and diagrams help clarify complex concepts.

Usage Guidance

Use the Class Help window to learn about the object type you are configuring, including its role in Grooper, available properties, and recommended practices. Refer to the provided links and examples for deeper understanding or troubleshooting.

• The help window is especially useful for new users or when working with unfamiliar object types.
• Review remarks and examples before making significant configuration changes.
• Use links to explore related objects, properties, or advanced topics.

Accessibility

• Fully accessible via keyboard and screen reader.
• Content is formatted for readability and clarity.

Example

┌───────────── Class Help ─────────────┐
│ Type: Batch Folder                   │
│ Summary: Represents a folder in a    │
│   batch, containing pages and data.  │
│ Remarks:                             │
│   - Used to organize batch content.  │
│   - Supports file storage.           │
│ See Also: Batch, Batch Page          │
│ Used By: Batch Process Step          │
└──────────────────────────────────────┘

Used By

Code Property EditorProperty Grid