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

Object containing the settings of an extraction pattern. More...

Public Member Functions

 SCExtractionPattern ()
 SCExtraction default constructor More...
 
 SCExtractionPattern (object o)
 Internal constructor. Do not use More...
 

Properties

string Description [get, set]
 Description of this extraction pattern. More...
 
Guid DictionaryId [get, set]
 Dictionary id of this patterns dictionary More...
 
bool Enabled [get, set]
 Indicate if this extraction pattern is enabled. More...
 
bool IgnoreCase [get, set]
 Indicates if case is ignored. More...
 
string IgnoreChars [get, set]
 Characters to ignore in the extraction pattern. More...
 
bool IgnoreSpaces [get, set]
 Indicates if spaces are ignored. More...
 
string SearchPattern [get, set]
 Search pattern to use in this extraction pattern. More...
 
List< KeyValuePair< string, string > > Substitutions [get, set]
 List of substitutions to use in this extraction pattern. [srctext|replacetext] More...
 
int Weight [get, set]
 Indicates the weight of the extraction pattern. More...
 
bool WholeWord [get, set]
 Indicates if extraction pattern is only applied to whole words. More...
 

Detailed Description

Object containing the settings of an extraction pattern.

Constructor & Destructor Documentation

◆ SCExtractionPattern() [1/2]

SCExtractionPattern ( )
inline

SCExtraction default constructor

◆ SCExtractionPattern() [2/2]

SCExtractionPattern ( object  o)
inline

Internal constructor. Do not use

Property Documentation

◆ Description

string Description
getset

Description of this extraction pattern.

◆ DictionaryId

Guid DictionaryId
getset

Dictionary id of this patterns dictionary

◆ Enabled

bool Enabled
getset

Indicate if this extraction pattern is enabled.

◆ IgnoreCase

bool IgnoreCase
getset

Indicates if case is ignored.

◆ IgnoreChars

string IgnoreChars
getset

Characters to ignore in the extraction pattern.

◆ IgnoreSpaces

bool IgnoreSpaces
getset

Indicates if spaces are ignored.

◆ SearchPattern

string SearchPattern
getset

Search pattern to use in this extraction pattern.

◆ Substitutions

List<KeyValuePair<string, string> > Substitutions
getset

List of substitutions to use in this extraction pattern. [srctext|replacetext]

◆ Weight

int Weight
getset

Indicates the weight of the extraction pattern.

◆ WholeWord

bool WholeWord
getset

Indicates if extraction pattern is only applied to whole words.