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 Format Settings (SCBCdrFormatSettings)
  3. SCBCdrFormatSettings Methods and Properties to Specify the General Search Settings

    Use the following methods and properties to specify the general search settings.

  • 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)
    • SCBCdrFormatSettings Type Definitions

      The SCBCdrFormatSettings object provides the following type definitions.

    • SCBCdrFormatSettings Methods and Properties to Modify the List of Format Strings

      Use the following methods and properties to modify the list of format strings.

    • SCBCdrFormatSettings Methods and Properties to Specify the Settings for each Format String

      Use the following properties to specify the settings for each format string.

    • SCBCdrFormatSettings Methods and Properties to Specify the General Search Settings

      Use the following methods and properties to specify the general search settings.

      • CaseSensitive

        This property sets or returns if the search operation works case-sensitive.

      • KeepSpaces

        This property sets or returns if the engine keeps the spaces between the connected words.

      • MaxDistance

        This property sets or returns the maximal compare distance. A match requires that the actual compare distance is less or equal to the maximum compare distance.

      • MaxWordCount

        This property sets or returns the maximum number of words combined as input for the search operation. Words which are combined must be in the same line.

      • MaxWordGap

        This property sets or returns the maximum distance in millimeters that permits word concatenation during the search. The requirements strongly depend on the font size.

      • MaxWordLen

        This property sets or returns the maximum overall word length in millimeters on the document of the combined input string for the search engine.

      • ResetTranslationLanguage

        This method sets the transliteration approach to CDRTranslationLanguageDefault, which means that no transliteration executes for the format string, ignore char string, prefix and suffix string. This is the default setting and should be used in case the workdoc was not transliterated. This method has no impact to the methods FindStringFirst and FindStringNext.

      • SettingsCheckSum

        This property sets or returns the checksum string created during extraction for the format settings object for the field. The checksum is not stored in the storage object. Checksum is used in BIC internally. This property has no impact to the methods FindStringFirst and FindStringNext.

      • SetTranslationLanguage

        This method specifies the transliteration approach for the format analysis engine. In general, use the same approach as used for the workdoc's OCR text. This method has no impact to the methods FindStringFirst and FindStringNext.

    • SCBCdrFormatSettings Methods and Properties to Specify the Settings for the Search Regions

      Use the following properties to specify the settings for the search regions.

  • 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

SCBCdrFormatSettings Methods and Properties to Specify the General Search Settings

Use the following methods and properties to specify the general search settings.

  • CaseSensitive
  • KeepSpaces
  • MaxDistance
  • MaxWordCount
  • MaxWordGap
  • MaxWordLen
  • ResetTranslationLanguage
  • SettingsCheckSum
  • SetTranslationLanguage
footer © Hyland Software, Inc. and its affiliates. All rights reserved.