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

Object containing the locator format settings. More...

Inheritance diagram for SCLocatorFormat:
SCLocator

Public Member Functions

void AddPattern (SCExtractionPattern pattern)
 Add a new pattern to the patterns collection. More...
 
void ClearPatterns ()
 Remove all existing patterns More...
 
void InsertPattern (SCExtractionPattern pattern, int index)
 Insert a new pattern to the patterns collection at the specified index. More...
 
void RemovePattern (int index)
 Remove the pattern at the specified index. 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...
 

Properties

IReadOnlyCollection< SCExtractionPattern > Patterns [get]
 Collection of extraction patterns. 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...
 

Detailed Description

Object containing the locator format settings.

Member Function Documentation

◆ AddPattern()

void AddPattern ( SCExtractionPattern  pattern)
inline

Add a new pattern to the patterns collection.

Parameters
patternAlternative to add

◆ ClearPatterns()

void ClearPatterns ( )
inline

Remove all existing patterns

◆ InsertPattern()

void InsertPattern ( SCExtractionPattern  pattern,
int  index 
)
inline

Insert a new pattern to the patterns collection at the specified index.

Parameters
patternpattern to add
indexIndex where to insert

◆ RemovePattern()

void RemovePattern ( int  index)
inline

Remove the pattern at the specified index.

Parameters
indexIndex of the pattern to remove

Property Documentation

◆ Patterns

IReadOnlyCollection<SCExtractionPattern> Patterns
get

Collection of extraction patterns.