DCO methods
You can use DCO methods to complete actions on DCO objects, such as adding documents to batches, pages to documents, or fields to pages. You can also use the DCO methods to search for and change metadata values, including confidence levels, indexes, variables, and alternative text for verification.
- AddChild method
The AddChild method adds a child object to the parent runtime DCO object. You can use the AddChild method to add a field to a page or add a page to a document. You can add only a child that is at the same or a lower level than this object in the hierarchy. - AddValue method
The AddValue method adds a character data value (ASCII code) and the associated confidence level to the character object. You can use this method to correct optical character recognition (OCR) errors. - AddVariable method
The AddVariable method adds a variable and its value to an object, such as a batch, document, page, or field. You can use this method when you need to pass values to a custom action. For example, your organization might introduce a new security regulation that requires a new field for identification on certain page types. - AddVariableFloat method
The AddVariableFloat method adds a variable of type double and its value to an object. - AddVariableInt method
The AddVariableInt method adds an integer variable and its value to an object. You can use this method when you need to pass values to custom actions. - AddVariableString method
The AddVariableString method adds a string variable and its value to an object. You can use this method when you need to pass values to custom actions. - CheckIntegrity method
The CheckIntegrity method determines whether a batch conforms to the document integrity rules that are specified in the Setup DCO file. - Clear method
The Clear method removes all of the child objects of a runtime object, but does not remove the object itself. For example, you can use this method when a document contains corrupted or incorrect pages. - CreateDocuments method
The CreateDocuments method uses the Setup DCO file to determine the document type that is associated with each page in a batch and creates the required document objects. - CreateFields method
The CreateFields method creates a runtime field object for each field that is specified within the corresponding page (or field) node in the document hierarchy. - DeleteChild method
The DeleteChild method removes the specified child object from the runtime DCO object. - DeleteValue method
The DeleteValue method deletes a data value and the corresponding confidence level value of a character object. - DeleteVariable method
The DeleteVariable method removes a variable, including variables such as TYPE or STATUS that are installed with Datacap, and its value from a runtime DCO object. - FindChild method
The FindChild method gets an interface to a child object that is referenced by ID (name). You can use this method when you need to get the interface to a child object for which you only know the name. - FindChildIndex method
The FindChildIndex method returns the index of the specified child object that is contained within a runtime DCO object. You can use this method when you know the name of the child object, and you need to pass the position of the child object to a variable. - FindRouteChild method
The FindRouteChild method returns the interface to an object that is specified by using the path through the document hierarchy. You use this method to save or restore execution points during an action process. - FindVariable method
The FindVariable method returns the index of a variable by using the ID (name) of the variable. You can use this method when you need to pass the value of a variable to another variable or action. - get_AltConfidenceString method
The get_AltConfidenceString method gets the confidence level of each character in the referenced field. You can use this method when you need to pass the confidence level of a string to a variable or action. - get_AltText method
The get_AltText method gets the primary or alternative character data that is associated with a field. - get_CharConfidence method
The get_CharConfidence method gets the primary or alternative character data that is associated with a field. You can use this method when you need to pass the character data value to a variable or action. - get_CharValue method
The get_CharValue method gets the ASCII data value of the primary character or alternative character. You can use this method when you need to pass the character data value to a variable or action. - get_OMRValue method
The get_OMRValue method gets the positions within the optical mark recognition (OMR) field of the check boxes that are selected. You can use this method to pass the positions to variables or actions, such as those that are used in verification functions to confirm that check boxes are selected. - get_Variable method
The get_Variable method gets the value of a referenced variable by using the ID (name) of the variable. You can use this method to pass the value of a named variable to an action for further processing. - GetChild method
The GetChild method gets a referenced child object by using the index of the child object. You can use this method to retrieve a field on a page when you know the position, but not the name. - GetLastError method
The GetLastError method retrieves the text of the last error that is encountered during a DCO read operation or write operation, and clears the error. - GetPosition method
The GetPosition method gets the position of a field or character on a page. You can use this method for fields or characters that are located at identical positions on multiple pages in a batch. - GetRoute method
The GetRoute method gets the path through the document hierarchy to an object. - GetVariableName method
The GetVariableName method gets the name (ID) of a variable from the index of the variable. You can use this method when you know the position of a variable within an object, but you do not know the name of the variable. - GetVariableValue method
The GetVariableValue method gets the value of a referenced variable by using the index of the variable. - IsError method
The IsError method indicates whether an error occurred during a prior Read operation or Write operation. - IsRoute method
The IsRoute method indicates whether the specified path is the valid path through the runtime hierarchy for an object. - IsValid method
The IsValid method confirms that the interface of a DCO object is valid and is connected to an actual object. - MoveChild method
The MoveChild method moves a child of a runtime DCO object to a different index location. You can use this method to reorganize or correct batches, documents, pages, or fields. - MoveIn method
The MoveIn method moves the specified runtime DCO object from the current parent to a different parent. - NumOfChildren method
The NumOfChildren method returns the number of child objects that is associated with the runtime DCO object. - NumOfVars method
The NumOfVars method returns the number of variables that is associated with the runtime DCO object. - ObjectType method
The ObjectType method returns a numeric value that indicates the object type. - Parent
The Parent method returns the parent of the runtime DCO object. - Read method
The Read method reads the runtime information from a Runtime DCO file or a page data file, and writes the information into the DCO object. - ReadSetup method
The ReadSetup method reads the document hierarchy setup information from the specified Setup DCO file and writes the information into the Setup object and SetupNode object. - SetPosition method
The SetPosition method sets the position of the runtime field or character object on the page. This method is useful for making corrections to zonal recognition on a page. - SetupNode method
The SetupNode method accesses the SetupNode object that is associated with the current object. You can use this method to get the name of the object in the document hierarchy that corresponds to the object in the runtime batch hierarchy. - SetupObject method
The SetupObject method returns the Setup object that is associated with the current batch-level runtime DCO object. You can use this method when a batch contains unidentified pages and you need to modify the runtime batch hierarchy. - set_AltConfidenceString
The set_AltConfidenceString method sets the confidence level of each character in the referenced field. - set_AltText method
The set_AltText method sets the primary character data or alternative character data that is associated with a field. You can use this method for multi-pass verification tasks and double-blind data entry tasks. - set_CharConfidence method
The set_CharConfidence method sets the confidence level for the primary value or of the alternative value of a character in a field. - set_CharValue method
The set_CharValue method sets the ASCII data value of the primary character or alternative character. - set_OMRValue
The set_OMRValue method sets the character values within the OMR field to indicate whether a check box is selected. - set_Variable method
The set_Variable method sets the value of a referenced variable by using the name of the variable. - Write method
The Write method saves the runtime batch object to a batch file, or a page object to a page file. When it writes a batch object, this method also writes all of the child objects, including documents, pages, and fields. - WriteSetup method
The WriteSetup method writes the Setup object and SetupNode objects to the Setup DCO file. You use this method after you read a setup DCO file from an external location.
Parent topic: DCO APIs