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

Document Viewer

Control GrooperReview.DocView

Displays documents using a variety of viewers and editors, automatically selecting the most appropriate interface based on the document's type.

Remarks

The Document Viewer control provides a unified interface for viewing, searching, and editing documents in the Grooper web client. It automatically selects the best viewer or editor for each document, supporting a wide range of file types and interactive features.

Purpose

  • View, search, and edit documents of various types, including images, text, code, HTML, email, ZIP archives, and more.
  • Switch between different document renditions and pages.
  • Search document text and interact with content using specialized viewers.

Main Features

  • Automatic Viewer Selection:
    The control inspects the document's type and content, then loads the most suitable viewer/editor:
    • Page Viewer: For paginated image documents (e.g., scanned PDFs, TIFFs).
    • Text Editor: For text, code, XML, JSON, and similar files, with syntax highlighting and completion.
    • HTML Viewer: For HTML documents.
    • Mail Viewer: For email files.
    • ZIP Viewer: For ZIP archives.
    • NdJson Editor: For newline-delimited JSON files.
    • Null Viewer: For unsupported or empty documents.
  • Document Searcher:
    Provides search functionality for the text content of the current document.
  • Rendition Management:
    Detects available renditions and selects the most appropriate one based on user input and available types.
  • Dynamic UI:
    The viewer/editor is switched automatically by inspecting the file extension and MIME type of the active rendition.
  • Contextual Properties:
    Properties such as 'Caption', 'Has Processed Text', and 'Is Paginated' provide context for the UI and enable advanced features.

Interactive Components

  • Inputs:
    • Document selection (by name/type)
    • Page navigation (for paginated documents)
    • Search box for text content
  • Buttons:
    • Viewer-specific actions (e.g., page navigation, search, edit, download)
    • Context menu commands for document operations
  • Child Controls:
    • {ContentViewer}: Displays the main document content using the appropriate viewer/editor.
    • {DocumentSearcher}: Enables searching within the document text.

Notes

  • For unsupported or empty documents, a placeholder viewer is shown.
  • Keyboard shortcuts and context menu commands may be available depending on the active viewer/editor.
  • The control is intended for use in document review, editing, and processing workflows within Grooper.

Child Controls

NameTypeSummary
Content Viewer Content Viewer

The content viewer used to display the current document's content.

Document Searcher Document Searcher

Controls for searching the text content of the document.

Used By

Notification