CaptureProcess Class

Represents a GlobalCapture process in memory, containing properties, methods and classes for use in process manipulation.

public class CaptureProcesss : Process

Example

The following example clears pages from the document associated with the CaptureProcess.

public class ExampleCaptureNode : CaptureNode
{
    public override void Run()
    {
        Process.Document.ClearPages();
    }
}

Remarks

Classes derived from CaptureNode automatically have access to the executing process as a CaptureProcess class. Additionally, CaptureProcesses are potentially returned from methods that return a Process base class, such as GetProcessById or GetProcessesByProperty. This process may be casted to an CaptureProcess like so:

var process = Database.GetProcessById(1);
if (process is CaptureProcess captureProcess) 
{
    captureProcess.Document.ClearPages();
}

Changes made to the Process class on CustomNode classes are saved automatically at the conclusion of the node.

Processes returned from methods are held in memory unless inserted or updated in the database using Database methods.

Files associated with processes are held in cache for the lifetime of the custom node execution and can be manipulated through methods or directly within the file system according to the file paths within the process. These files are only changed or created if the process is saved back to the database.

Properties

Methods