Cedar candidates are generated during the analysis step and are representing possible results of a field.
The SCBCdrField object provides the following properties.
This read-only property returns the text of the candidate.
The SCBCdrWKDOCLib object provides the following type definitions.
The SCBCdrField object provides the following methods.
This read-only property returns the attractor of the candidate by a zero-based index.
This read-only property returns the number of attractors for this candidate.
This read-only property returns FilterID value as specified by the AddCandidate method of the field.
This property sets or returns the confidence of the string match algorithm performed by the format search engine that has created the candidate.
This read-only property returns the height of the candidate in pixels.
This property sets or returns if the text created from several Words keeps the spaces between these Words.
This read-only property returns the left border of the candidate in pixels.
This read-only property returns the text of a single line. A candidate can consist of one or more lines.
If a candidate has more than one line, you can use this property to set or return a caption to each line to provide information about the content of the line.
This property sets or returns the number of lines of the candidate or the number of lines of a field.
This read-only property returns the number of words of the specified line.
This read-only property returns the Word ID of the specified line and word index.
This property sets or returns the worktext object of the single line specified by the zero-based index within a multi-line field.
This read-only property returns the DocPage number where the candidate is located.
This read-only property returns the top border of the candidate in pixels.
This property sets or returns the result of the evaluation, which is between 0 and 1.
This read-only property returns the width of the candidate in pixels.
This read-only property returns the word count of the candidate.
This read-only property returns the word ID of the specified word index within the first line.
This read-only property returns the worktext object of the first line.
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 Cedar workdoc object stores all data of one document. The amount of data grows during the processing steps of OCR, classification and extraction.
Text as String
