Octobox API  4.1.0
Octobox Scripting API
Public Member Functions
SCLocatorZone

Object containing the zone locator settings. More...

Inheritance diagram for SCLocatorZone:
SCLocator

Public Member Functions

SCLocatorZoneField GetFieldByName (string fieldName)
 Root folder to use for function file location. More...
 
- Public Member Functions inherited from SCLocator
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...
 

Additional Inherited Members

- Properties inherited from SCLocator
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 zone locator settings.

Member Function Documentation

◆ GetFieldByName()

SCLocatorZoneField GetFieldByName ( string  fieldName)
inline

Root folder to use for function file location.