Octobox API  4.1.0
Octobox Scripting API
Properties
SCLocatorFunctionFile

Object containing the locator function file settings. More...

Inheritance diagram for SCLocatorFunctionFile:
SCLocator

Properties

IReadOnlyCollection< SCLocatorFunctionFileResult > Results [get]
 Collection of valid results. More...
 
String RootFolder [get, set]
 Root folder to use for function file location. More...
 
- 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...
 

Additional Inherited Members

- 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...
 

Detailed Description

Object containing the locator function file settings.

Property Documentation

◆ Results

IReadOnlyCollection<SCLocatorFunctionFileResult> Results
get

Collection of valid results.

◆ RootFolder

String RootFolder
getset

Root folder to use for function file location.