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. SCBCdrPROJLib
  3. SCBCdrSettings

    The Cedar Settings object stores arbitrary strings for usage in script.

  4. SCBCdrSettings Properties

    The SCBCdrSettings object provides the following properties.

  • Documentation Notice
  • About Scripting
  • ScriptModule Events
  • Cedar DocClass Event Interface
  • Cedar [FieldName] Event Interface
  • Working with Workdoc Objects (SCBCdrWKDOCLib)
  • SCBCdrPROJLib
    • SCBCdrPROJLib Type Definitions

      The SCBCdrPROJLib object provides the following type definitions.

    • SCBCdrProject Methods

      The Cedar Project object provides the following methods.

    • SCBCdrProject Properties

      The Cedar Project object provides the following properties.

    • SCBCdrDocClass

      A Cedar DocClass object represents a single document class within a Cedar project class hierarchy.

    • SCBCdrDocClasses

      This collection contains all defined DocClass objects of the Cedar project.

    • SCBCdrFieldDef

      A Cedar FieldDef object represents the definition of a single FieldDef inside a Cedar DocClass

    • SCBCdrFieldDefs

      This collection contains all defined FieldDef objects of a single DocClass.

    • SCBCdrLicenseInfoAccess

      The Licensing Information Access object allows direct retrieval to the active licensing object. You can directly query any licensing component in a custom script.

    • SCBCdrSettings

      The Cedar Settings object stores arbitrary strings for usage in script.

      • SCBCdrSettings Methods

        The SCBCdrSettings object provides the following methods.

      • SCBCdrSettings Properties

        The SCBCdrSettings object provides the following properties.

        • ActiveClient

          This property sets or returns the name of the currently active client.

        • Client

          This read-only property returns the name of the specified client.

        • ClientCount

          This read-only property returns the number of clients.

        • DocumentBinarizationMode

          This property sets or returns the binarization mode for document conversion in the recognition engine.

        • GlobalLearnsetPath

          This property sets or returns the global Learnset path.

        • Key

          This read-only property returns the key name specified by index.

        • KeyCount

          This read-only property returns the number of keys.

        • Keylcon

          This property sets or returns the value for the specified key.

        • KeyParent

          This read-only property returns the parent name of the specified key index.

        • ProjectFileName

          This property sets or returns the file name of the project.

        • SupervisedLearningDisabled

          This property sets or returns the state of supervised learning in Designer and local Verifier workstations.

        • TopDownEventSequence

          This property sets or returns the value of a top-down event sequence.

        • Value

          This property sets or returns the value of the specified key.

    • SCBCdrScriptModule

      This is a global object at the project level. All script module events occurred at project level belong to this object.

    • SCBCdrScriptAccess

      Brainware Intelligent Capture provides a public interface "SCBCdrScriptAccess" for external access to the project and class level custom script pages. The interface can be queried from the main "SCBCdrProject" interface available in Brainware Intelligent Capture custom script. Using this interface it is possible to get, modify and dump project and class level scripts.

  • 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

SCBCdrSettings Properties

The SCBCdrSettings object provides the following properties.

  • ActiveClient
  • Client
  • ClientCount
  • DocumentBinarizationMode
  • GlobalLearnsetPath
  • Key
  • KeyCount
  • Keylcon
  • KeyParent
  • ProjectFileName
  • SupervisedLearningDisabled
  • TopDownEventSequence
  • Value
footer © Hyland Software, Inc. and its affiliates. All rights reserved.