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 the Format Analysis Engine (SCBCdrFormatEngine)
  3. SCBCdrFormatEngine Methods

    The SCBCdrFormatEngine provides the following methods.

  • 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)
    • SCBCdrFormatEngine Methods

      The SCBCdrFormatEngine provides the following methods.

      • FindStringFirst

        This method finds the first word in the workdoc according to the pSettings parameter. The search starts from the first word in the workdoc and the first FormatSetting search pattern.

      • FindStringNext

        This method finds the next word in the workdoc according to the pSettings parameter.

      • GetBlockID

        This method retrieves the workdoc block index for the current matched word. This method is called typically after executing FindStringFirst or FindStringNext for search operations where the entire block is needed, such as in an address block search algorithm.

      • TestString

        Use this method to test a particular search string (Format String) against an arbitrary text, using the settings assigned to that specific Format String.

    • SCBCdrFormatEngine Properties

      The SCBCdrFormatEngine provides the following property.

  • 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

SCBCdrFormatEngine Methods

The SCBCdrFormatEngine provides the following methods.

  • FindStringFirst
  • FindStringNext
  • GetBlockId
  • TestString
footer © Hyland Software, Inc. and its affiliates. All rights reserved.