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. SCBCdrCandidate

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

  4. SCBCdrCandidate Properties

    The SCBCdrField 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.

      • SCBCdrCandidate Methods

        The SCBCdrField object provides the following methods.

      • SCBCdrCandidate Properties

        The SCBCdrField object provides the following properties.

        • Attractor

          This read-only property returns the attractor of the candidate by a zero-based index.

        • AttractorCount

          This read-only property returns the number of attractors for this candidate.

        • FilterID

          This read-only property returns FilterID value as specified by the AddCandidate method of the field.

        • FormatConfidence

          This property sets or returns the confidence of the string match algorithm performed by the format search engine that has created the candidate.

        • Height

          This read-only property returns the height of the candidate in pixels.

        • KeepSpaces

          This property sets or returns if the text created from several Words keeps the spaces between these Words.

        • Left

          This read-only property returns the left border of the candidate in pixels.

        • Line

          This read-only property returns the text of a single line. A candidate can consist of one or more lines.

        • LineCaption

          If a candidate has more than one line, you can use this property to set or return a caption to each line to provide information about the content of the line.

        • LineCount

          This property sets or returns the number of lines of the candidate or the number of lines of a field.

        • LineWordCount

          This read-only property returns the number of words of the specified line.

        • LineWordID

          This read-only property returns the Word ID of the specified line and word index.

        • LineWorktext

          This property sets or returns the worktext object of the single line specified by the zero-based index within a multi-line field.

        • PageNr

          This read-only property returns the DocPage number where the candidate is located.

        • Text

          This read-only property returns the text of the candidate.

        • Top

          This read-only property returns the top border of the candidate in pixels.

        • Weight

          This property sets or returns the result of the evaluation, which is between 0 and 1.

        • Width

          This read-only property returns the width of the candidate in pixels.

        • WordCount

          This read-only property returns the word count of the candidate.

        • WordID

          This read-only property returns the word ID of the specified word index within the first line.

        • Worktext

          This read-only property returns the worktext object of the first line.

    • SCBCdrDocPage

      The SCBCdrDocPage object represents a single DocPage within a workdoc.

    • 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

SCBCdrCandidate Properties

The SCBCdrField object provides the following properties.

  • Attractor
  • AttractorCount
  • FilterID
  • FormatConfidence
  • Height
  • KeepSpaces
  • Left
  • Line
  • LineCaption
  • LineCount
  • LineWordCount
  • LineWordID
  • LineWorktext
  • PageNr
  • Text
  • Top
  • Weight
  • Width
  • WordCount
  • WordID
  • Worktext
footer © Hyland Software, Inc. and its affiliates. All rights reserved.