Defines rules for excluding individual results from the output.
The following 16 properties are defined.
| Property Name | Description |
|---|---|
| Character Casing | |
| Case Filter | Type: CharacterCasing, Default: None
If a case filter is specified, instance which do not match the specified case will be discarded. |
| Minimum Similarity | Type: Double, Default: 100%, Range: 0% - 100%
If set to a value other than 1, the case will be fuzzy matched to the degree of similarity indicated. |
| Output Case | Type: CharacterCasing, Default: None
If set to a value other than None, will change the case of output instances to match the selected case. |
| Page and Location | |
| Page Filter | Type: String
An optional filter which restricts the results to specific page numbers.. If this value is blank, results found on any page will be returned. If set, only results found on page numbers included in the filter will be returned. |
| Location | Type: Logical Rectangle
Filters results by their geometric location on the page. If a rectangle is specified, only results with a centerpoint which falls inside this rectangle will be returned. A blank rectangle (0,0):(0,0) indicates that no ROI filtering should be performed. |
| Length Filtering | |
| Minimum Length | Type: Int32, Default: 0
The minimum length of a result, in characters. Any result instance shorter than the length specified here will be discarded. |
| Maximum Length | Type: Int32, Default: 0
The maximum length of a result, in characters. Any result instance longer than the length specified here will be discarded. A value of 0 indicates no upper length limit. |
| Horizontal Alignment | |
| Alignment | Type: HorizontalDataAlignment, Default: Any
Filters results based the horizontal alignment of the text relative to the overall page. Can be one of the following values:
|
| Relative To | Type: AlignmentMode, Default: Text
When alignment filtering is in use, specifies whether the alignment is relative to the boundaries of the page, or the boundaries of the text on the page. Can be one of the following values:
|
| Alignment Tolerance | Type: Double, Default: 0.25
The amount of tolerance, in inches, from the specified alignment. |
| Alignment Maximum Width | Type: Double, Default: 75%, Range: 0% - 100%
The maximum width of an aligned result, specified as a percentage of the overall width. |
| Font Size | |
| Minimum Font Size | Type: Double, Default: 0
The minimum font size, in points. A value of 0 indicates no minimum font size. |
| Maximum Font Size | Type: Double, Default: 0
The maximum font size, in points. A value of 0 indicates no maximum font size. |
| Result Set Options | |
| Maximum Results | Type: Int32, Default: 0
The maximum number of results to return. A value of 0 indicates all results should be returned. |
| Allow Invalid Results | Type: Boolean, Default: False
Indicates whether values which cannot be converted to the extractor's value type should be returned. |
| Exclude Perfect Matches | Type: Boolean, Default: False
If set to true, excludes all matches which have a 100% confidence. |