Property Help

Displays contextual help and documentation for the currently selected property in the Property Grid.

Remarks

Overview

The Property Help control provides rich, contextual documentation for the property currently selected in the Property Grid. It helps users understand the purpose, valid values, configuration options, and best practices for each property, making configuration and troubleshooting easier and more accurate.

UI Components

• Help Window:
  • Shows the summary and detailed remarks for the selected property.
  • Displays the property's display name, type, default value, and value range.
  • May include formatted text, code examples, and SVG diagrams.
  • Provides links to related documentation, wiki pages, or help topics.
• Converter Information:
  • If the property uses a custom converter, additional help and summary for the converter are displayed.
• See Also Section:
  • Lists related types and controls, helping users explore similar or dependent properties.
• Value Choices:
  • Shows a list of valid choices for properties with predefined value lists.

Interactive Features

• Dynamic Content:
  • Updates automatically as the user selects different properties in the grid.
  • If no property is selected, the help window may display class-level help instead.
• 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 Property Help window to learn about the property you are configuring, including its role in Grooper, valid values, 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 properties.
• Review remarks and examples before making significant configuration changes.
• Use links to explore related objects, properties, or advanced topics.
• For properties with value lists, review the available choices and their descriptions.

Accessibility

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

Example

┌───────────── Property Help ─────────────┐
│ Property: Name                          │
│ Type: String                            │
│ Default: (empty)                        │
│ Remarks:                                │
│   - The name identifies the object.     │
│   - Must be unique within its parent.   │
│ See Also:  Batch Folder, Project        │
│ Choices:                                │
│   - (none)                              │
└─────────────────────────────────────────┘

Used By

Property Grid