The Cedar workdoc object stores all data of one document. The amount of data grows during the processing steps of OCR, classification and extraction.
The SCBCdrWorkdoc object provides the following properties.
This property sets or returns if worktext is plain text.
The SCBCdrWKDOCLib object provides the following type definitions.
Cedar candidates are generated during the analysis step and are representing possible results of a field.
The SCBCdrDocPage object represents a single DocPage within a workdoc.
When importing a MSG file into a workdoc, the most important properties of the email are stored in the workdoc and available in the custom script through the "ISCBCdrEmailProperties" interface that can be queried from the SCBCdrWorkdoc interface.
This object contains the evaluated data to extract from the document.
This is a collection of all field objects contained in the current WorkDoc object.
A folder can represent an array of workdocs within a batch. A folder can contain one or more workdocs. During classification and extraction, you can access all workdocs of the same folder from within a script.
The Cedar table object represents a logical table in a document assigned to a Cedar field of a workdoc.
This object represents a TextBlock on a document. A TextBlock can contain one or more lines.
This object represents a textual word of a document.
The SCBCdrWorkdoc object provides the following methods.
This property sets or returns the color used for attractor highlighting.
This property sets or returns the color used for block highlighting.
This read-only property returns the number of TextBlocks of the workdoc. Use this property before accessing the TextBlock property where an index is required. The range of valid indices for TextBlocks is from 0 to BlockCount –1.
This property sets or returns the color used for candidate highlighting.
This property sets or returns a confidence level for a classification engine specified by its index in the collection of classification engines.
This property sets or returns the distance value for a classification engine specified by its index in a collection of classification engines.
This property sets or returns a classification result matrix. This matrix is used during the classification step to store the results of each used classification method for each document class (DocClass) of the project. The matrix has one column for each classification method and one column for the combined result of all methods. A row contains the results for a single DocClass, therefore there is one row for each DocClass in the classification matrix. The matrix is created during the classification step, but not saved to disk. After reloading the workdoc, the matrix is no longer available.
This property sets or returns the classification weights within the Classification Result Matrix.
This read-only property returns the temporary document batch state, a numeric value between 0 and 999. To set this value, use the methods LoadWorkdoc and UpdateDocument of the Cedar Batch component.
This property sets or returns the displayed DocPage specified by the zero-based index of the workdoc in the viewer.
This property sets or returns the name of the DocClass to which the document was classified.
This read-only property returns the number of documents from which the workdoc is built.
The read-only property pWorkdoc.DocFileDatabaseID returns the database ID of document files attached to a Brainware Intelligent Capture workdoc. It corresponds to the [File].[Id] value in the database. The document file index has to be passed as a parameter when using DocFileDatabaseID property.
This read-only property returns the full pathname of a document (image or text file) from which the workdoc is built.
This read-only property returns the file type of the document by the specified index.
This property sets or returns the current state of the document.
This read-only property returns the number of vertical edges found in a document.
This property sets or returns an error description.
This property sets or returns the color that used to highlight valid and invalid fields.
This read-only property provides access to all fields of a document.
This read-only property contains the database ID of the workdoc and returns the database workdoc ID and Name.
This read-only property accesses the folder to which the workdoc belongs.
This read-only property provides the index of the Folder to which a workdoc belongs.
This property provides the ability to force a manual classification review even if the classification succeeded. Set or return this property in the PostClassify event.
This property sets or returns the position of the highlighted candidate.
This property sets or returns the field index value of the highlighted field.
This property sets or returns the highlighting mode.
This read-only property returns an image object for the specified DocPage of the workdoc.
This property sets or returns the language of the document, as specified by the language detection or the default language of the project.
This property sets or returns the Color used for line highlighting.
This read-only property returns the number of displayable DocPages of the workdoc.
This read-only property returns a single DocPage of the workdoc.
This read-only property returns the paragraph array of the workdoc.
This read-only property returns the number of paragraphs.
This property sets or returns if tool tips display when moving the mouse pointer over a displayed workdoc.
Use this property to set or return whether the specified trainable engine has to skip this document in the training process.
This read-only property returns a table for a given index of the workdoc.
This read-only property returns the number of table objects stored within the workdoc.
This read-only property returns the TextBlock by an index of the workdoc.
This read-only property returns the number of text lines present in a workdoc.
This read-only property indicates whether this document is trained with the specified engine.
This read-only property returns the unique id of the workdoc as a 60-character string with the identifier generation date, time, and a dynamically created UUID.
This read-only property provides access to the Word array of the workdoc.
This property sets or returns the color used for word highlighting.
This read-only property returns the number of words of the workdoc.
This property sets or returns a string that contains the characters used for the segmentation of Words.
This read-only property returns text line by an index of the workdoc.
This property provides access to the raw OCR results represented by the SCBCroWorktext object.
The SCBCdrWorkdoc object provides the following named properties.
IsPlainText as Boolean
