Jump to main content

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

Home
SCBCdrPROJLib
SCBCdrProject Properties
The Cedar Project object provides the following properties.
Page
This read-only property returns the Cairo Page object of the current Project.

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.
  - AllClasses
    This read-only property returns a collection of all defined DocClasses of this Project.
  - BaseClasses
    This read-only property returns a collection that contains all defined BaseDocClasses.
  - ClassificationMode
    This property sets returns the used classification mode.
  - CurrentClient
    This property sets or returns the "Client" attribute of the batch.
  - DefaultClassifyResult
    This property sets or returns the default DocClass name to which a document is redirected if no other DocClass fits.
  - DefaultLanguage
    This read-only property returns the language used as default.
  - Filename
    This read-only property returns the project's path and file name.
  - ForceValidation
    This property sets or returns the Force Validation mode.
  - LastAddressPoolUpdate
    This read-only property returns the time when the address pool was updated for the last time.
  - MinClassificationDistance
    This property sets or returns the minimal distance of classification results.
  - MinClassificationWeight
    This property sets or returns the minimal classification weight.
  - MinParentClsDistance
    This property sets or returns the minimal distance between the classification weight of the parent and the derived DocClasses.
  - MinParentClsWeight
    This property sets or returns the minimal parent classification weight. This value is used as a threshold during parent classification.
  - NoUI
    This property sets or returns NoUI. If NoUI is set to TRUE, then no login dialog box displays.
  - Page
    This read-only property returns the Cairo Page object of the current Project.
  - ParentWindow
    This write-only property sets the parent window of the login dialog box.
  - SLWDifferentResultsAction
    This property sets or returns the action to complete if a template classification and supplier extraction has different results.
  - SLWSupplierInvalidDifferentClsResults
    This property sets or returns if a Supplier Field is made invalid when the template classification and supplier extraction have different results.
  - ValidationSettingsColl
    This read-only property returns a collection of all activated validation engines.
  - ValidationTemplates
    This read-only property returns a collection of all available validation templates.
  - VersionCount
    This read-only property returns the number of versions available for a specified file name.
  - WordSegmentationChars
    This property sets or returns a string that contains all characters used for Word segmentation.
- 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.
- 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

Page

This read-only property returns the Cairo Page object of the current Project.

Syntax

Page as ISCBCroPage

footer © Hyland Software, Inc. and its affiliates. All rights reserved.