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 Settings for each Format String

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

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

      • AllowMultilineCandidates

        This property is reserved for future use and should not be used in the current version.

      • AnalysisMethod

        This property sets or returns the analysis method for the specified format string from the list of format strings.

      • CompareType

        This property sets or returns the string compare algorithm which is used for the specified format string from the list of format strings.

      • DesignatorType

        This property sets or returns the DesignatorType for the specified format string from the list of format strings.

      • FormatString

        This property sets or returns the specified format string in/from the list of format strings.

      • FormatValid

        This read-only property returns the result of the validation check for the specified format string from the list of format strings.

      • IgnoreCharacters

        This property sets or returns the ignore character string for the specified format string from the list of format strings. The ignore character string contains the characters or symbols which are ignored in the search algorithm.

      • Prefix

        This property sets or returns the prefix string for the specified format string from the list of format strings. The prefix string contains the characters or symbols which are ignored when found at the beginning of the word.

      • Suffix

        This property sets or returns the suffix string for the specified format string from the list of format strings. The suffix string contains the characters or symbols which are ignored when found at the end of the word.

    • SCBCdrFormatSettings Methods and Properties to Specify the General Search Settings

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

    • 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 Settings for each Format String

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

  • AllowMultilineCandidates
  • AnalysisMethod
  • CompareType
  • DesignatorType
  • FormatString
  • FormatValid
  • IgnoreCharacters
  • Prefix
  • Suffix
footer © Hyland Software, Inc. and its affiliates. All rights reserved.