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 methods.
Use this method to determine all the paragraphs present in workdoc.
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.
This method adds a file into the workdoc. File types include CIDoc, image, and raw text.
This method adds a field to the workdoc.
This method adds a highlight rectangle on the page described by the following parameters. Set HighlightMode to CDRHighlightRectangles to highlight all rectangles.
HighlightMode
CDRHighlightRectangles
This method splits the document into blocks that contain only left or right aligned lines. Using this method on a document with centered lines only typically results in one block per line.
This method determines all the TextBlocks of text present in a workdoc that are a minimum XDist apart from each other on X-axis and a minimum of YDist apart from each other on Y-axis.
This method analyzes a document set of words that are, within a certain tolerance, aligned either right or left. Use Highlight mode (CDRHighlightVerticalEdgesLeft or CDRHighlightVerticalEdgesRight) to make the results visible.
This method is similar to AnalyzeEdges method, but it applies the processing for visible text lines only (in case 'vbCheckedOnly' parameter is set to TRUE), otherwise it works exactly like AnalyzeEdges.
vbCheckedOnly
This method is used to append a given workdoc to the existing workdoc.
Use this method to assign a Page of an Image or CIDoc to a specific DocPage of the workdoc. This method requires that there are already documents inserted to the workdoc using the AddDocFile function and that the SetPageCount function is called prior to using this method.
SetPageCount
Use this method to clear all memories and to remove all documents from the workdoc. This leaves the workdoc in an initial state.
This method removes all highlighted rectangles.
This method creates a workdoc from the OCRed text of an image.
This method cuts the current workdoc and generates a new workdoc from DocPages present after the given PageIndex.
This method deletes all WDC files and the corresponding TIF files of the workdoc.
This method exports the structure and the field data of the current workdoc to an XML file or MSXML object in a predefined format.
This method returns the coordinates for the left, top, and bottom of the corners for an edge, which is interpreted as a rectangle.
This method returns the file size of an image or document through a custom script.
This method returns a worktext object from a specific location on a document. The worktext object contains text and positional information relating to the area specified in GetWorktextForPageArea. You can view this as a temporary zone to read a piece of information through a script and review the returned result for that area.
GetWorktextForPageArea
This method loads a file from given root path and this root path is not the absolute path of the file.
This method generates a PDF file from workdoc based on CDRPDFExportStyle.
This method returns the PDF export type of a given document page.
This method sets the type of a document page for the export into a PDF file.
This method is part of the OCR-on-demand concept.
This method rebuilds the basic workdoc object words, text lines, and blocks without applying OCR or auto-rotation.
This method refreshes the workdoc’s DocPage currently shown in the viewer.
Use this method to change the name of the CIDoc or Image at a given DocIndex by the given new name.
This method replaces the first image in workdoc.
This method saves a workdoc with given file name and its DocFiles relatively at given ImageRootPath.
This method has been added to allow the script implementation of the page merging workflow step.
This method releases all the images and CIDocs that belong to this workdoc.
The SCBCdrWorkdoc object provides the following properties.
The SCBCdrWorkdoc object provides the following named properties.
