Jump to main content
Brainware Intelligent Capture Scripting
Brainware Intelligent Capture Scripting
 Foundation 23.1
  • Documentation Notice
  • About Scripting
  • ScriptModule Events
  • Cedar DocClass Event Interface
  • Cedar [FieldName] Event Interface
  • Working with Workdoc Objects (SCBCdrWKDOCLib)
  • SCBCdrPROJLib
  • Working with the Associative Search Engine (CDRADSLib)
  • Working with the Check Analysis Engine (SCBCdrParaCheckLib)
  • Working with the Format Analysis Engine (SCBCdrFormatEngine)
  • Working with Format Settings (SCBCdrFormatSettings)
  • Working with Batches (SCBCdrBATCHLib)
  • Comparing Strings (SCBCdrSTRCOMPLib)
  • Working with Images (SCBCroIMGLib)
  • Working with CI Documents (SCBCroCiDocLib)
  • Working with Cairo Projects (SCBCroPROJLib)
  • Working with Collections (SCBCroCollLib)
  • Working with Worktext Objects (SCBCroWorktextLib)
  • Working with Verification Forms (DISTILLERVERIFIERCOMPLib)
  • Printing Documents (SCBCroPrintLib)
  • Error Handling
  • Troubleshooting Scripting Issues
  • Encryption
  1. Home
  2. Working with Images (SCBCroIMGLib)
  3. Viewer Object SCBCroViewer

    The component SCBCroViewer provides methods and properties to display various objects, such as images, text documents, annotations, or OCR and scanning results.

  4. SCBCroViewer Properties

    This object provides the following properties.

  • Documentation Notice
  • About Scripting
  • ScriptModule Events
  • Cedar DocClass Event Interface
  • Cedar [FieldName] Event Interface
  • Working with Workdoc Objects (SCBCdrWKDOCLib)
  • SCBCdrPROJLib
  • Working with the Associative Search Engine (CDRADSLib)
  • Working with the Check Analysis Engine (SCBCdrParaCheckLib)
  • Working with the Format Analysis Engine (SCBCdrFormatEngine)
  • Working with Format Settings (SCBCdrFormatSettings)
  • Working with Batches (SCBCdrBATCHLib)
  • Comparing Strings (SCBCdrSTRCOMPLib)
  • Working with Images (SCBCroIMGLib)
    • SCBCroIMGLib Type Definitions

      The SCBCroImage object provides the following type definitions.

    • Image Object SCBCroImage

      The component SCBCroImage provides methods and properties to load, modify, and save image files.

    • Viewer Object SCBCroViewer

      The component SCBCroViewer provides methods and properties to display various objects, such as images, text documents, annotations, or OCR and scanning results.

      • SCBCroViewer Methods

        This object provides the following methods.

      • SCBCroViewer Properties

        This object provides the following properties.

        • AlignmentX

          This property sets or returns the alignment the displayed object, if its displayed width is smaller than the viewer window’s width.

        • AlignmentY

          This property sets or returns the alignment the displayed object, if its displayed height is smaller than the viewer window’s height.

        • BackColor

          This property sets or returns the back color of the viewer.

        • BorderColor

          This property sets or returns the color of the border.

        • BorderStyle

          This property sets or returns the style of the border.

        • BorderWidth

          This property sets or returns the width of the border

        • Brightness

          This read-only property returns the brightness property that controls the display of colored images.

        • Contrast

          This property controls the display of colored images. The valid range for the contrast property is from 0.0 to 100.0, where 1.0 is the default value, 0.0 is the most lowest contrast and 100.0 is the highest contrast.

        • DisplayPage

          This property sets or returns the displayed page of a document.

        • EnableTool

          This property controls the activation of the user interactions tool of the displayed item.

        • FreeScrollPosX

          This property sets or returns the scrolling behaviour of the viewer for the horizontal direction.

        • FreeScrollPosY

          This property sets or returns the scrolling behaviour of the viewer for the vertical direction.

        • Item

          This property sets or returns a reference of the object to be displayed in the viewer.

        • OffsetX

          This read-only property controls the horizontal scrolling offset of the displayed object.

        • OffsetY

          This read-only property controls the vertical scrolling offset of the displayed object.

        • PageCount

          This property sets or returns the page count of the currently displayed document.

        • ScaleToGray

          This property sets or returns how black-and-white images are displayed.

        • ScrollbarVisible

          This property sets or returns whether the scroll bars are visible.

        • Selection

          This property sets or returns the currently selected viewer object.

        • SelectionBackgroundColor

          This property sets or returns the background color of the selection.

        • SelectionBorderColor

          This property sets or returns the border color of the selection.

        • SelectionEnable

          This property sets or returns which selection mode is enabled.

        • ShowPageSelectButtons

          This property sets or returns if the page selection buttons on the toolbar are visible.

        • ShowSelectionButton

          This property sets or returns if the selection buttons are visible.

        • ShowToolToolbar

          This property sets or returns whether the toolbar provided by the user interaction tool is visible.

        • ShowViewerToolbar

          This property sets or returns whether the toolbar of the viewer is visible.

        • Tool

          This read-only property returns the tool object provided by the displayed object.

        • ViewMode

          This property controls the default zoom mode.

        • Zoom

          This property sets or returns the zoom value of the displayed document in percent.

        • ZoomStep

          This property defines the zoom factor applied when the user presses the Zoom in or Zoom out button.

      • SCBCroViewer Events

        This object provides the following events.

      • Sample Code

        The following sample code shows how to load and display an image file in a Cairo Viewer object.

  • Working with CI Documents (SCBCroCiDocLib)
  • Working with Cairo Projects (SCBCroPROJLib)
  • Working with Collections (SCBCroCollLib)
  • Working with Worktext Objects (SCBCroWorktextLib)
  • Working with Verification Forms (DISTILLERVERIFIERCOMPLib)
  • Printing Documents (SCBCroPrintLib)
  • Error Handling
  • Troubleshooting Scripting Issues
  • Encryption

SCBCroViewer Properties

This object provides the following properties.

  • AlignmentX
  • AlignmentY
  • BackColor
  • BorderColor
  • BorderStyle
  • BorderWidth
  • Brightness
  • Contrast
  • DisplayPage
  • EnableTool
  • FreeScrollPosX
  • Item
  • OffsetX
  • OffsetY
  • PageCount
  • ScaleToGray
  • ScrollbarVisible
  • Selection
  • SelectionBackgroundColor
  • SelectionBorderColor
  • SelectionEnable
  • ShowPageSelectButtons
  • ShowSelectionButton
  • ShowToolToolbar
  • ShowViewerToolbar
  • Tool
  • ViewMode
  • Zoom
  • ZoomStep
footer © Hyland Software, Inc. and its affiliates. All rights reserved.