RootFolder

The RootFolder (CscScriptRootFolder) object and the corresponding script sheet are only available if folders are enabled. It provides events for foldering.

Foldering events can occur during server processing or if allowed during Validation.

The following image illustrates the script event sequence when foldering is executed:
An image that shows the Foldering event chronology.

Note The BeforeAutoFoldering and AfterAutoFoldering events are already fired but not yet supported by a configuration interface.

The DoFoldering event can be used to group the documents into subfolders. This event sequence is then followed by the Folder Extraction and Validation Events that can be used to calculate folder field data or in combination with a folder field validation rule to control the contained documents in the folder. For more information about applying Foldering please refer to Foldering.

Note The DoFoldering event is fired once only. This means that if a batch or document is sent to Kofax Capture - Quality Control because of an error, the DoFoldering event is not fired again once the batch is resolved and sent for further processing.

The complete foldering process can be skipped by setting the bSkip parameter of the BeforeAutoFoldering event to TRUE, if you want to skip Foldering for the validation step you can distinguish if this event is initiated by server processing or manually by checking the property Project.ScriptExecutionMode.

Private Sub RootFolder_BeforeAutoFoldering(ByVal pXRootFolder As CASCADELib.CscXFolder, ByRef bSkip As Boolean)
   If Project.ScriptExecutionMode = CscScriptModeValidation Then
      bSkip = True
   End If
End Sub

Your search for returned results.

Search tips

RootFolder