Grooper.Core.GeometricProvider

Defines a rectangular region using anchors, and extracts the character data bounded by the region as a Section Instance. Geometric section extraction is performed as follows:

  1. The Main Extractor establishes the initial region.
  2. Each edge of the region can then be adjusted using text anchors, page boundaries, or manual rules.
  3. The result can then be expanded to detected lines which bound the region..
NOTE: This method cannot be used in cases where the section content spans multiple pages.


Inherits from: Grooper.Core.SectionExtractMethod

Constructors

Signature Description
New (Owner As ConnectedObject)
Parameters
Owner
          Type: ConnectedObject
          

Fields

Field Name Field Type Description
Database As Grooper.GrooperDb Grooper.GrooperDb

Properties

Property Name Property Type Description
BottomAdjustment Grooper.Core.EdgeAdjustment Defines an optional adjustment for the bottom edge of each output instance.
HasReferenceProperties System.Boolean Returns true if the object has properties which reference Grooper Node objects.
IsEmpty System.Boolean Returns true if all properties with a ViewableAttribute are set to their default value.
IsWriteable System.Boolean Returns true if the object is writable, or false if it is not.
LeftAdjustment Grooper.Core.EdgeAdjustment Defines an optional adjustment for the left edge of each output instance.
LineDetectLimit Grooper.BorderExF If this property is set, line detection will be enabled, and the section region will be expanded to nearby lines. Line detection is performed after the initial region has been established using the Main Extractor and edge adjustments. This property defines the maximum distance from each edge of the initial region to a detected line. Any empty value disables line detection.
MainExtractor Grooper.Core.EmbeddedExtractor The extractor to be used to identify the initial region for each Section Instance. Each instance returned by this extractor will become a Section Instance in the output. Please note that any results returned by this extractor which span multiple pages will be discarded.
Owner Grooper.ConnectedObject Returns the node that owns the connected object, if any.
OwnerNode Grooper.GrooperNode Returns the node that owns the connected object, if any.
RightAdjustment Grooper.Core.EdgeAdjustment Defines an optional adjustment for the right edge of each output instance.
Root Grooper.GrooperRoot Returns the root node
TopAdjustment Grooper.Core.EdgeAdjustment Defines an optional adjustment for the top edge of each output instance.

Methods

Method Name Description
FindInstances(Source As DataElementInstance) As DataInstanceCollection
Parameters
Source
          Type: DataElementInstance
          
GetProperties() As PropertyDescriptorCollection
GetReferences() As List(Of GrooperNode) Returns a list of GrooperNode objects referenced in the properties of this object.
IsPropertyEnabled(PropertyName As String) As Nullable(Of Boolean) Defines whether a property is currently enabled.
Parameters
PropertyName
          Type: String
          The name of the property to determine the enabled state for.
IsPropertyVisible(PropertyName As String) As Nullable(Of Boolean) Defines whether a property is currently visible.
Parameters
PropertyName
          Type: String
          The name of the property to determine the visible state for.
IsType(Type As Type) As Boolean Returns true if the object is of the type specified, or if it derives from the type specfied.
Parameters
Type
          Type: Type
          The type to check.
ReadInstances(Source As DataElementInstance) As DataInstanceCollection
Parameters
Source
          Type: DataElementInstance
          
Serialize() As String Serializes the object.
SetDatabase(Database As GrooperDb) Sets the database connection of the object.
Parameters
Database
          Type: GrooperDb
          
SetOwner(Owner As ConnectedObject, SkipInitialization As Boolean) Sets the owner of the connected object with another object that implements the IConnected interface.
Parameters
Owner
          Type: ConnectedObject
          
 
SkipInitialization
          Type: Boolean
          
ToString() As String Returns a string value representation of the connected object.
ValidateProperties() As ValidationErrorList Validates the properties of the object, returning a list of validation errors.