Grooper Help - Version 25.0
25.0.0017 2,127
  • Overview
  • Help Status

Property Grid

Control GrooperReview.Controls.PropertyGrid

Displays the viewable properties of an object and allows user editing in a categorized, interactive grid.

Remarks

The Property Grid control provides a structured, interactive interface for viewing and editing the properties of Grooper objects. It is used throughout the Grooper UI to configure nodes, embedded objects, commands, and other configurable items. Properties are presented in a categorized grid, with support for inline editing, drop-down lists, expandable child properties, and contextual help.

UI Components

  • Property List:
    • Displays properties grouped by category, with each property shown as a row containing its name, value, and optional description.
    • Supports expandable properties for complex types, allowing users to drill down into nested objects.
    • Editable fields include text boxes, drop-down lists, checkboxes, color pickers, and custom editors.
  • Help Window:
    • Shows contextual help for the selected property, including descriptions, usage guidance, and validation messages.
    • When a category label is focused, the help window displays help for the object type being edited.
  • Validation Indicators:
    • Properties with errors are visually marked, and error messages are shown in the help window.
    • The grid updates validation status in real time as values are changed.
  • Context Menu:
    • Right-click to access commands such as Clear, Reset, Copy, Paste, and other workflow-specific actions.
    • Menu adapts to the selected property and object type.

Interactive Features

  • Editing:
    • Click a property value to edit it inline or open a custom editor.
    • Drop-down lists allow selection from predefined values; some editors support both selection and direct entry.
  • Expandable Properties:
    • Properties representing complex or list types can be expanded to reveal child properties.
    • Expand/collapse state is remembered per session.
  • Keyboard Navigation:
    • Up/Down: Move between properties.
    • Left/Right: Expand/collapse properties or cycle drop-down values.
    • Ctrl + Left/Right: Cycle drop-down values for editable properties.
    • Down or Space: Open property editor.
    • Enter a letter or digit to jump to drop-down values starting with that character.
  • Multi-Property Selection:
    • Use Ctrl + click or Shift + click to select multiple properties for batch operations.

Usage Scenarios

  • Object Configuration:
  • Validation and Error Correction:
    • Review and resolve validation errors before deploying or processing objects.
  • Bulk Editing:
    • Select multiple properties to clear, reset, copy, or paste values in bulk.
  • Contextual Help:
    • Access detailed help and usage guidance for each property and object type.

Accessibility and Usability

  • Fully navigable by keyboard and mouse.
  • Screen reader support for property names, values, and help content.
  • Validation errors and help messages are clearly presented.
  • Tooltips and icons provide additional context for editors and commands.

Example

┌───────────── Property Grid ─────────────┐  
│ Category: General                       │  
│ ─ Name: {Text Box}                      │  
│ ─ Type: {Drop-down}                     │  
│ Category: Advanced                      │  
│ ─ Enabled: {Checkbox}                   │  
│ ─ Color: {Color Picker}                 │  
│ ─ Details: {Expandable}                 │  
│ ────────────── Help Window ──────────── │  
│   Description and usage guidance        │  
└─────────────────────────────────────────┘

Child Controls

NameTypeSummary

Used By

Notification