Octobox API  4.1.0
Octobox Scripting API
Public Member Functions
ValidationRuleScriptBaseabstract

Base class for all script validation rules. More...

Inheritance diagram for ValidationRuleScriptBase:
ScriptBase

Public Member Functions

abstract ValidationRuleResult Validate (SCDocument document, SCExtractionResult result)
 Validate extraction result in a document. More...
 

Additional Inherited Members

- Data Fields inherited from ScriptBase
Action< string > LogInfo
 Write text to the Octobox logging at information level. More...
 
Action< string > LogMsg
 Write text to the Octobox logging at normal level. More...
 
- Properties inherited from ScriptBase
SCProcess Batch [get, set]
 Batch object containing global values available to all scripts. More...
 
CancellationToken CancellationToken [get, set]
 Cancellation token that can be checked for process cancellation on long running script actions. More...
 
SourceApplications SourceApplication [get, set]
 Application that called this function. More...
 

Detailed Description

Base class for all script validation rules.

Member Function Documentation

◆ Validate()

abstract ValidationRuleResult Validate ( SCDocument  document,
SCExtractionResult  result 
)
pure virtual

Validate extraction result in a document.

Parameters
documentDocument to check
resultExtraction result to check in the document