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

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

  4. SCBCdrField Methods

    The SCBCdrField object provides the following methods.

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

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

      • SCBCdrField Methods

        The SCBCdrField object provides the following methods.

        • AddCandidate

          This method adds a new candidate to the field based on the specified Word ID.

        • AddCandidate2

          This method adds a new candidate to the field based on the specified Worktext.

        • AddTable

          This method adds a table into the table array of this field.

        • CandidateByFilterID

          This method finds the first candidate by specified the filter ID or creates a new one if no such candidate is found.

        • CandidateCount

          This method returns the number of candidates for a field.

        • DeleteLine

          This method deletes a line from a specific index position.

        • DeleteTable

          This method deletes a table from the table array of this field.

        • FindCandidate

          This method searches inside the list of candidates if there is a candidate based on the specified WordID.

        • FindCandidateByPos

          This method finds a candidate by its position.

        • GetFirstCandidatePropsByPage

          This method returns the first candidate’s properties by page.

        • GetNextCandidatePropsByPage

          This method returns the next candidate’s properties by page.

        • GetUniqueEntryID

          This method returns other column values for the specified pool entry.

        • InsertLine

          This method inserts a line at the specified line index in a field.

        • PutUniqueEntryId

          This method sets the unique ID (64 bit) for the field content from associative search pool.

        • RemoveCandidate

          This method removes a candidate from the candidate array.

        • SortCandidatesByWeight

          This method sorts evaluated field candidates by their weight.

      • SCBCdrField Properties

        The SCBCdrField object provides the following properties.

    • 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

SCBCdrField Methods

The SCBCdrField object provides the following methods.

  • AddCandidate
  • AddCandidate2
  • AddTable
  • CandidateByFilterID
  • CandidateCount
  • DeleteLine
  • DeleteTable
  • FindCandidate
  • FindCandidateByPos
  • GetFirstCandidatePropsByPage
  • GetNextCandidatePropsByPage
  • GetUniqueEntryID
  • InsertLine
  • PutUniqueEntryId
  • RemoveCandidate
  • SortCandidatesByWeight
footer © Hyland Software, Inc. and its affiliates. All rights reserved.