Octobox API  4.1.0
Octobox Scripting API
Public Member Functions | Properties
SCLocator

Object containing the locator settings. More...

Inheritance diagram for SCLocator:
SCLocatorFormat SCLocatorFunctionFile SCLocatorZone

Public Member Functions

virtual List< SCAlternative > ExecuteOnDocuments (List< SCDocument > documents, SCProcess batch, string fileCriteria=".*")
 Find valid alternatives found in the passed through collection of documents. More...
 
virtual List< SCAlternative > ExecuteOnText (List< string > targetText)
 Find valid alternatives found in the passed through collection of strings. More...
 

Properties

List< SCAlternative > Alternatives [get]
 Collection of found alternatives by this locator. More...
 
Guid Id [get]
 GUID of the locator. More...
 
LocatorTypes LocatorType [get]
 Type of the locator. More...
 
string Name [get]
 Name of the locator. More...
 
SCRegion Region [get]
 Region to check by the locator. More...
 

Detailed Description

Object containing the locator settings.

Member Function Documentation

◆ ExecuteOnDocuments()

virtual List<SCAlternative> ExecuteOnDocuments ( List< SCDocument >  documents,
SCProcess  batch,
string  fileCriteria = ".*" 
)
inlinevirtual

Find valid alternatives found in the passed through collection of documents.

Parameters
documentsList of documents to process
batchCurrent batch object
fileCriteriaoptional regex defining which media filenames to process

Return a collection of alternatives

◆ ExecuteOnText()

virtual List<SCAlternative> ExecuteOnText ( List< string >  targetText)
inlinevirtual

Find valid alternatives found in the passed through collection of strings.

Parameters
targetText

Return a collection of alternatives

Property Documentation

◆ Alternatives

List<SCAlternative> Alternatives
get

Collection of found alternatives by this locator.

◆ Id

Guid Id
get

GUID of the locator.

◆ LocatorType

LocatorTypes LocatorType
get

Type of the locator.

◆ Name

string Name
get

Name of the locator.

◆ Region

SCRegion Region
get

Region to check by the locator.