Grooper Object: Difference between revisions

From Grooper Wiki
No edit summary
No edit summary
 
(28 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{#menu:
''Last update: 2025-09-10''
*{{WikiHelpLinks|Grooper Object}}
 
**{{WikiHelpLinks|Connected Object}}
This page is intended for users creating and editing scripts in Grooper and other advanced users.
***{{WikiHelpLinks|Batch Filter}}
 
***{{WikiHelpLinks|Chat Filter}}
'''Grooper Object''' is the foundational base class in Grooper. All configurable objects inherit from Grooper Object (''{{TypeName|Grooper Object}}''). This includes:
*** {{WikiHelpLinks|Capture Device}}
* [[Node]]s in the Grooper node tree (including [[Batch]]es, [[Content Model]]s, [[Batch Process]]es and more)
**** {{WikiHelpLinks|ColorTrac Scanner}}
* Embedded objects stored as properties of nodes (including [[Activity|Activities]], [[Command]]s, [[Value Extractor]]s and much much more).
**** {{WikiHelpLinks|Import Device}}
 
**** {{WikiHelpLinks|ISIS Device}}
Grooper Objects are designed to be user-configurable (in most cases). These objects are used to define, store, and manage settings and data throughout Grooper. Their properties are typically exposed in the Property Grid interface, allowing users to view and modify settings in the Grooper UI.
**** {{WikiHelpLinks|TWAIN Device}}
 
***{{WikiHelpLinks|Database Row}}
== Object Inheritance ==
****{{WikiHelpLinks|AI Chat}}
 
****{{WikiHelpLinks|AI Message}}
All items in this tree inherit from {{WikiHelpLinks|Grooper Object}}. Expand an object to inspect its derived types. Its type name and link to the Grooper Help page is listed in parenthesis.
****{{WikiHelpLinks|Doc Index}}
*<li class="fyi-bullet"> ''Just looking for a list of all Grooper objects? Go to the [[List of Grooper Objects]] page for an expanded version of this tree.''
****{{WikiHelpLinks|File Store Entry}}
 
****{{WikiHelpLinks|Import Job}}
{{#tree:
****{{WikiHelpLinks|Index State}}
* {{WikiHelpLinks|API Key}}
****{{WikiHelpLinks|Index Table}}
* {{WikiHelpLinks|Archive Info}}
*****{{WikiHelpLinks|Batch State}}
* {{WikiHelpLinks|Border}}
****{{WikiHelpLinks|Log Event}}
* {{WikiHelpLinks|Capture Settings}}
****{{WikiHelpLinks|Processing Job}}
* {{WikiHelpLinks|Character Class Filter}}
****{{WikiHelpLinks|Processing Task}}
* {{WikiHelpLinks|Chat Parameters}}
****{{WikiHelpLinks|Saved Query}}
* {{WikiHelpLinks|CMIS Object}}
****{{WikiHelpLinks|Session Stats}}
** {{WikiHelpLinks|CMIS Document}}
***{{WikiHelpLinks|Embedded Object}}
** {{WikiHelpLinks|CMIS Folder}}
**** {{WikiHelpLinks|AI Chat Filter}}
* {{WikiHelpLinks|CMIS Property Definition}}
**** {{WikiHelpLinks|AI Chat Settings}}
** {{WikiHelpLinks|CMIS Boolean Property Definition}}
**** {{WikiHelpLinks|AI Generator
** {{WikiHelpLinks|CMIS DateTime Property Definition}}
** {{WikiHelpLinks|CMIS Decimal Property Definition}}
** {{WikiHelpLinks|CMIS HTML Property Definition}}
** {{WikiHelpLinks|CMIS ID Property Definition}}
** {{WikiHelpLinks|CMIS Integer Property Definition}}
** {{WikiHelpLinks|CMIS String Property Definition}}
** {{WikiHelpLinks|CMIS URI Property Definition}}
* {{WikiHelpLinks|Code39Settings}}
* {{WikiHelpLinks|Connected Object}}
** {{WikiHelpLinks|Batch Filter}}
** {{WikiHelpLinks|Chat Filter}}
** {{WikiHelpLinks|Capture Device}}
*** {{WikiHelpLinks|ColorTrac Scanner}}
*** {{WikiHelpLinks|Import Device}}
*** {{WikiHelpLinks|ISIS Device}}
*** {{WikiHelpLinks|TWAIN Device}}
** {{WikiHelpLinks|Database Row}}
*** {{WikiHelpLinks|AI Chat}}
*** {{WikiHelpLinks|AI Message}}
*** {{WikiHelpLinks|Doc Index}}
*** {{WikiHelpLinks|File Store Entry}}
*** {{WikiHelpLinks|Import Job}}
*** {{WikiHelpLinks|Index State}}
*** {
}}
}}


=== What's not on this list? ===


<!---
Not much! Nearly everything in Grooper inherits from {{WikiHelpLinks|Grooper Object}}. Not included in this list are:
<br clear=all>
* [[Grooper Command Console]] and its commands
{|class="mw-collapsible wikitable"
* {{WikiHelpLinks|Property Converter}} and its derived types
|Grooper Object
* {{WikiHelpLinks|Property Editor}} and its derived types
|-
* {{WikiHelpLinks|UI Element}} and its derived types
|
* ''[https://help.grooper.com/v2025/help&typeName=Grooper.StringManager+CharacterCasing Enumerations]''
{|class="mw-collapsible wikitable"
|Connected Object
|-
|
{|class="mw-collapsible wikitable"
|Capture Device
|-
|ColorTrac Scanner
|-
|Import Device
|-
|ISIS Device
|-
|TWAIN Device
|}
|-
|
{|class="mw-collapsible wikitable"
|Embedded Object
|-
|
{|class="mw-collapsible wikitable"
|Activity
|-
|
{|class="mw-collapsible wikitable"
|Attended Activity
|-
|Review
|}
|-
|
{|class="mw-collapsible wikitable"
|Code Activity
|-
|Apply Rules
|-
|Attach
|-
|Batch Transfer
|}
|}
|}
|}
|}
|}

Latest revision as of 12:10, 30 January 2026

Last update: 2025-09-10

This page is intended for users creating and editing scripts in Grooper and other advanced users.

Grooper Object is the foundational base class in Grooper. All configurable objects inherit from Grooper Object (Grooper.GrooperObject). This includes:

Grooper Objects are designed to be user-configurable (in most cases). These objects are used to define, store, and manage settings and data throughout Grooper. Their properties are typically exposed in the Property Grid interface, allowing users to view and modify settings in the Grooper UI.

Object Inheritance

All items in this tree inherit from Grooper Object (Grooper.GrooperObject). Expand an object to inspect its derived types. Its type name and link to the Grooper Help page is listed in parenthesis.

  • Just looking for a list of all Grooper objects? Go to the List of Grooper Objects page for an expanded version of this tree.

What's not on this list?

Not much! Nearly everything in Grooper inherits from Grooper Object (Grooper.GrooperObject). Not included in this list are: