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

Text Editor

Content Viewer GrooperReview.DocView

Displays text documents and optionally allows the text content to be edited.

Remarks

The Text Editor control provides an interactive interface for viewing and editing text files within the Grooper UI. It supports syntax highlighting, code completion, and navigation for large documents, making it suitable for editing scripts, configuration files, logs, and other structured or plain text content.

Overview

  • Presents text documents in a multi-part, paginated view for efficient handling of large files.
  • Allows users to edit text content directly, with support for syntax highlighting and code completion.
  • Includes toolbar buttons for downloading, viewing file info, saving changes, and canceling edits.
  • Integrates a page navigator for moving between document sections.
  • Displays a code editor area with advanced editing features.

Interactive Components

  • Title Bar:
    • Shows the document caption, page navigation controls, and toolbar buttons.
    • Toolbar includes {download}, {info}, {save}, and {cancel} buttons.
  • Page Navigator:
    • Enables navigation between parts of large text documents.
    • Disables navigation while edits are unsaved to prevent data loss.
  • Code Editor:
    • Provides syntax highlighting, code completion, and editing commands.
    • Supports toggling word wrap and control character visibility.
    • Keyboard shortcuts for editing actions (see below).
  • Toolbar Buttons:
    • {download}: Download the current text document.
    • {info}: Display metadata and information about the document.
    • {save}: Save changes to the document (enabled when edits are made).
    • {cancel}: Revert unsaved changes and reload the current part.

Usage Guidance

Use the Text Editor control to view and edit text files in Grooper.

  • Navigate between document parts using the page navigator.
  • Edit content in the code editor area; syntax highlighting and completion are available for supported formats.
  • Use toolbar buttons to download, view info, save, or cancel changes.
  • Unsaved changes disable navigation to prevent accidental data loss.
  • Keyboard shortcuts are available for efficient editing:
    • Ctrl + A: Select all
    • Ctrl + Shift + Space: Show completion
    • Alt + W: Toggle word wrap
    • Alt + S: Toggle control character visibility
    • Alt + Backspace: Undo
    • Alt + K: Comment selection
    • Alt + Shift + K: Uncomment selection

Example

┌───────────────────────────────────────────────────────────────────────┐
│ {Caption} {Page Navigator}             {save}{cancel}{download}{info} │
├───────────────────────────────────────────────────────────────────────┤
│                                                                       │
│                            {Code Editor}                              │
│                                                                       │
└───────────────────────────────────────────────────────────────────────┘

The layout includes a title bar with caption and toolbar buttons, a page navigator for document navigation, and a code editor area for viewing and editing text content. Buttons and controls are labeled using curly braces.

Command Buttons

ButtonShortcut KeySummary

Child Controls

NameTypeSummary

Used By

Notification