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 Workdoc Objects (SCBCdrWKDOCLib)
  3. SCBCdrDocPage

    The SCBCdrDocPage object represents a single DocPage within a workdoc.

  4. SCBCdrDocPage Properties

    The SCBCdrDocPage object provides the following properties.

  • Documentation Notice
  • About Scripting
  • ScriptModule Events
  • Cedar DocClass Event Interface
  • Cedar [FieldName] Event Interface
  • Working with Workdoc Objects (SCBCdrWKDOCLib)
    • SCBCdrWKDOCLib Type Definitions

      The SCBCdrWKDOCLib object provides the following type definitions.

    • SCBCdrCandidate

      Cedar candidates are generated during the analysis step and are representing possible results of a field.

    • SCBCdrDocPage

      The SCBCdrDocPage object represents a single DocPage within a workdoc.

      • SCBCdrDocPage Methods

        The SCBCdrDocPage object provides the following methods.

      • SCBCdrDocPage Properties

        The SCBCdrDocPage object provides the following properties.

        • DisplayImage

          This property sets or returns the index of the image, which is displayed if the DocPage is visible inside the Viewer.

        • DocIndex

          This read-only property specifies the index of the document inside the workdoc to which this DocPage belongs.

        • DocPageIndex

          This read-only property specifies the DocPage offset inside the document where this DocPage belongs.

        • Height

          This read-only property returns the height of the DocPage in millimeter.

        • Image

          This read-only property returns an image object for the specified index of the DocPage.

        • ImageCount

          This read-only property returns the number of images available for the DocPage.

        • ImportedFileName

          This read-only property returns the name of the imported file.

        • ImportedFilePageIndex

          This read-only property returns the zero-based index of the imported file page.

        • Line

          This read-only property returns some specific property of a line, of some specific index, direction and coordinate type.

        • LinesCount

          This read-only property returns the number of horizontal or vertical Lines present in a document.

        • OriginalDocumentFileName

          This property allows to access the page property to examine the original file name for the image. This is useful when attempting to track original file names for pages when a document is split or merged through Verifier, Web Verifier or the Page Separation engine.

        • PageSource

          This property sets or returns a source of a DocPage. At the time of scanning, a DocPage can be directly assigned to workdoc.

        • Rotation

          This read-only property returns the rotation angle as it was applied by the Rotate method.

        • Text

          This read-only property returns the text of the DocPage if OCR was already executed.

        • Width

          This read-only property returns the width of the DocPage in millimeters.

    • SCBCdrEmailProperties

      When importing a MSG file into a workdoc, the most important properties of the email are stored in the workdoc and available in the custom script through the "ISCBCdrEmailProperties" interface that can be queried from the SCBCdrWorkdoc interface.

    • SCBCdrField

      This object contains the evaluated data to extract from the document.

    • SCBCdrFields

      This is a collection of all field objects contained in the current WorkDoc object.

    • SCBCdrFolder

      A folder can represent an array of workdocs within a batch. A folder can contain one or more workdocs. During classification and extraction, you can access all workdocs of the same folder from within a script.

    • SCBCdrTable

      The Cedar table object represents a logical table in a document assigned to a Cedar field of a workdoc.

    • SCBCdrTextblock

      This object represents a TextBlock on a document. A TextBlock can contain one or more lines.

    • SCBCdrWord

      This object represents a textual word of a document.

    • SCBCdrWorkdoc

      The Cedar workdoc object stores all data of one document. The amount of data grows during the processing steps of OCR, classification and extraction.

  • 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

SCBCdrDocPage Properties

The SCBCdrDocPage object provides the following properties.

  • DisplayImage
  • DocIndex
  • DocPageIndex
  • Height
  • Image
  • ImageCount
  • ImportedFileName
  • ImportedFilePageIndex
  • Line
  • LinesCount
  • OriginalDocumentFileName
  • PageSource
  • Rotation
  • Text
  • Width
footer © Hyland Software, Inc. and its affiliates. All rights reserved.