|
Octobox API
4.1.0
Octobox Scripting API
|
Object containing the locator settings. More...
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... | |
Object containing the locator settings.
|
inlinevirtual |
Find valid alternatives found in the passed through collection of documents.
| documents | List of documents to process |
| batch | Current batch object |
| fileCriteria | optional regex defining which media filenames to process |
Return a collection of alternatives
|
inlinevirtual |
Find valid alternatives found in the passed through collection of strings.
| targetText |
Return a collection of alternatives
|
get |
Collection of found alternatives by this locator.
|
get |
GUID of the locator.
|
get |
Type of the locator.
|
get |
Name of the locator.
|
get |
Region to check by the locator.
1.8.13