Objekte - ABBYY Documentation

Die folgenden Funktionen stehen zum Erstellen benutzerdefinierter Skripte zur Verfügung. Um auf Objektinstanzen zuzugreifen, verwenden Sie die Variable commandArgs. Alle Variablen in diesem Abschnitt sind global und im gesamten Programm sichtbar.

Feldpfade

Einige Funktionen verwenden den Pfad zu einem Feld als Eingabeparameter. Er umfasst den Feldnamen und die Namen der übergeordneten Elemente (Feldgruppe, Abschnitt). Bei Tabellen, wiederholbaren Tabellen und wiederholbaren Gruppen müssen Sie die Instanznummer angeben, beginnend bei 0 (null). Beispielsweise ['Document Section 1', 'Group[10]', 'Field3'], wobei [10] die Nummer der Instanz der wiederholbaren Gruppe ist.

Funktionen zum Arbeiten mit Feldern

getCurrentField

getCurrentField() Gibt einen Link auf das Feldobjekt zurück, das das aktuelle benutzerdefinierte Skript verwendet.

getFieldByName

getFieldByName(namesPath) Gibt einen Link auf das Feld zurück, für das das benutzerdefinierte Skript geöffnet wurde.

Parameter	Beschreibung
`namesPath`	Ein Array mit Feld- und Gruppennamen, die den Pfad zum Feld bilden, oder ein Link zu einem Feldobjekt. Siehe Feldpfade.

getFieldValue

getFieldValue(namesPath) Gibt den Feldwert zurück: einen String für ein TextField-Feld, einen Häkchenwert für ein Checkmark-Feld oder ein String-Array für ein Checkmark Group-Feld.

Parameter	Beschreibung
`namesPath`	Ein Array von Feld- und Gruppennamen, die den Pfad zum Feld bilden, oder einen Verweis auf ein Feldobjekt. Siehe Feldpfade.

setCurrentFieldValue

setCurrentFieldValue(value, forced, onSaved) Ändert den Wert des Felds, für das das benutzerdefinierte Skript geöffnet wurde.

Parameter	Beschreibung
`value`	Der Feldwert.
`forced`	Optional. Aktualisiert den Feldwert und speichert die neuen Daten. Bei `false` wird der Feldwert in der Document Definition erst nach dem Aufruf von `save()` aktualisiert. Bei `true` wird der Feldwert sofort aktualisiert. Bei einem benutzerdefinierten Skript erfolgt die Aktualisierung unabhängig vom Modus. Standardmäßig ist `false` festgelegt.
`onSaved`	Optional. Eine Callback-Funktion. Wird aufgerufen, wenn `forced` auf `true` gesetzt wird.

setFieldValue

setFieldValue(namesPath | field, value, forced, onSaved) Ändert den Feldwert.

Parameter	Beschreibung
`namesPath`	Ein Array von Feld- und Gruppennamen, die den Pfad zum Feld bilden, oder ein Verweis auf das Feldobjekt. Siehe Feldpfade.
`value`	Der Wert des entsprechenden Felds.
`forced`	Optional. Aktualisiert den Feldwert und speichert die neuen Daten. Wenn `false` festgelegt ist, wird der Feldwert in der Document Definition erst aktualisiert, nachdem `save()` aufgerufen wurde. Wenn `true` festgelegt ist, wird der Feldwert sofort aktualisiert. Bei einem benutzerdefinierten Skript erfolgt die Aktualisierung unabhängig vom Modus. Der Standardwert ist `false`.
`onSaved`	Optional. Eine Callback-Funktion. Wird aufgerufen, wenn `forced` auf `true` gesetzt ist.

save

save() Schließt das Fenster, in dem das benutzerdefinierte Skript ausgeführt wird, und speichert die Änderungen.

cancel

cancel() Schließt das Fenster, in dem das benutzerdefinierte Skript ausgeführt wird, ohne die Änderungen zu speichern.

Funktionen zum Arbeiten mit Datensätzen

addEntity

addEntity(entityInfo: {cacheName, columns, values}, onResult(newId)) Fügt dem Datensatz einen Eintrag hinzu.

Parameter	Beschreibung
`entityInfo.cacheName`	Ein Name für den Datensatz.
`entityInfo.columns`	Namen der Spalten, in denen Daten gespeichert werden. Array von strings.
`entityInfo.values`	Werte für die entsprechenden Spalten. Array von strings.
`onResult`	Eine Callback-Funktion, die die ID des im Datensatz erstellten Eintrags empfängt.

editEntity

editEntity(entityInfo: {cacheName, columns, values}, onResult()) Bearbeitet einen Datenbankeintrag.

Parameter	Beschreibung
`entityInfo.cacheName`	Name des Datensatzes.
`entityInfo.columns`	Namen der Spalten, in denen Daten gespeichert werden. Array von strings.
`entityInfo.values`	Werte für die entsprechenden Spalten. Array von strings.
`onResult`	Eine Callback-Funktion.

getDict

getDict({cacheName, filters: [{FieldName, FieldValue}], cursorPos, allowMultipleColumnResults}, onResult(param: {FieldName, FieldValue, BoldMask}[][]))

Durchsucht den Datensatz nach einem angegebenen Wert oder einem Teil davon.

Parameter	Beschreibung
`cacheName`	Der Name des Datensatzes.
`filters`	Suchparameter. Jeder Eintrag enthält `FieldName` (den Feldnamen; leer lassen, um alle Felder zu durchsuchen) und `FieldValue` (den Feldwert).
`cursorPos`	Die Position des Cursors im Eingabefeld. Wenn ein Wert nur teilweise eingegeben wurde und sich der Cursor hinter den eingegebenen Symbolen befindet, werden diese als Präfix des gesuchten Werts behandelt. Befindet sich der Cursor vor einem teilweise eingegebenen Wort, werden diese Symbole als dessen Endung behandelt. Bei der Suche nach einem Unternehmensnamen führt beispielsweise die Eingabe von `ADO` mit dem Cursor dahinter zu `AVOCADO`; mit dem Cursor davor zu `ADONIS`.
`allowMultipleColumnResults`	Gibt die Werte der gefundenen Felder zurück. Ein Datensatz kann Einträge enthalten, bei denen einem Feldnamen (`FieldName`) mehrere Feldwerte (`FieldValue`) zugeordnet sind, beispielsweise verschiedene Varianten eines Unternehmensnamens in der Spalte `CompanyName`. Bei `true` werden alle Feldwerte zurückgegeben und erfasst, die die Suchbedingungen erfüllen; bei `false` wird das am besten passende Einzelergebnis zurückgegeben und erfasst.
`onResult`	Eine Callback-Funktion, die ein Array mit Suchergebnissen zurückgibt. Jedes Ergebnis ist ein String aus dem Datensatz, der selbst ein String-Array ist. Jeder String enthält den Feldnamen, seinen Wert und den Parameter `BoldMask`.

BoldMask ist ein String aus 0 und 1 mit derselben Länge wie der gefundene Wert. 1 kennzeichnet ein Symbol des gefundenen Werts, das mit dem entsprechenden Symbol im Suchfeld übereinstimmt, und 0 eines, das nicht übereinstimmt. Enthält ein Datensatz beispielsweise CompanyName: ABBYY und wird nach den Symbolen ABB gesucht, wird Folgendes zurückgegeben:

[
  [
    {
      FieldName: 'CompanyName',
      FieldValue: 'ABBYY',
      BoldMask: '11100'
    },
  ]
]

Das zurückgegebene Array kann mehrere Werte enthalten, darunter auch solche, die zunächst nicht den Search Conditions entsprachen. Die Ergebnisse werden absteigend nach dem Wert von BoldMask sortiert, wobei die strings, die am besten den Search Conditions entsprechen, an erster Stelle stehen.

getDictAll

getDictAll({cacheName, filters: {FieldName, FieldValue}}, }, onResult(param: {FieldName, FieldValue, BoldMask}[][])) Durchsucht die Datenbank nach dem vollständig angegebenen Wert. Gibt die Werte aller gefundenen Felder zurück.

Parameter	Beschreibung
`cacheName`	Der Name des Datensatzes.
`filters`	Ein Objekt-Array. Jeder Eintrag enthält `FieldName` (den Feldnamen; leer lassen, um alle Felder zu durchsuchen) und `FieldValue` (den Feldwert).
`onResult`	Eine Callback-Funktion, die ein Array mit Suchergebnissen zurückgibt. Jedes Ergebnis ist ein string aus dem Datensatz, der selbst ein string-Array ist. Jeder string enthält den Feldnamen, dessen Wert und den Parameter `BoldMask`.

BoldMask ist ein string aus 0 und 1 mit derselben Länge wie der gefundene Wert. 1 kennzeichnet ein Symbol im gefundenen Wert, das mit dem entsprechenden Symbol im Suchfeld übereinstimmt, und 0 ein Symbol, das nicht übereinstimmt. Wenn ein Datensatz beispielsweise CompanyName: ABBYY enthält und nach den Symbolen ABB gesucht wird, wird Folgendes zurückgegeben:

[
  [
    {
      FieldName: 'CompanyName',
      FieldValue: 'ABBYY',
      BoldMask: '11100'
    },
  ]
]

Das zurückgegebene Array kann mehrere Werte enthalten, darunter auch solche, die zunächst nicht den Suchbedingungen entsprachen. Die Ergebnisse werden absteigend nach dem Wert BoldMask sortiert, wobei die strings, die den Suchbedingungen am besten entsprechen, zuerst aufgeführt werden. Ein vollständiges Beispiel finden Sie unter Beispielskript für die Datenbanksuche.

Funktionen für die Arbeit mit dem Dokumentformular

selectRow

selectRow(tablePath, rowNumber) Markiert eine Tabellenzeile als ausgewählt.

Parameter	Beschreibung
`tablePath`	Ein Array aus Feld- und Gruppennamen, die den Pfad zum Tabellenfeld bilden, oder ein Verweis auf ein Tabellenobjekt. Siehe Feldpfade.
`rowNumber`	Die Nummer der auszuwählenden Zeile, nullbasiert.

deselectRow

deselectRow(tablePath, rowNumber?) Hebt die Auswahl einer Tabellenzeile auf.

Parameter	Beschreibung
`tablePath`	Ein Array aus Feld- und Gruppennamen, die den Pfad zum Tabellenfeld bilden, oder ein Verweis auf ein Tabellenobjekt. Siehe Feldpfade.
`rowNumber`	Die Nummer der abzuwählenden Zeile, nullbasiert. Wenn nicht angegeben, wird die Auswahl für alle Zeilen in der Tabelle aufgehoben.

scrollFormToField

scrollFormToField(namesPath) Scrollt im Formular-Editor zum Feld.

Parameter	Beschreibung
`namesPath`	Ein Array aus Feld- und Gruppennamen, die den Pfad zum Feld bilden, oder ein Link zu einem Tabellenobjekt. Siehe Feldpfade.

getDomElementPosition

getDomElementPosition(domId, onResult: (result?: {width, height, top, left, right, bottom})) Ermittelt die Position eines Elements im Fenster des Formular-Editors und übergibt das Ergebnis an eine Callback-Funktion.

Parameter	Beschreibung
`domId`	Element-ID im DOM-Format.
`onResult`	Eine Callback-Funktion, die das Objekt mit den DOM-Koordinaten des Elements (`width`, `height`, `top`, `left`, `right`, `bottom`) relativ zur oberen linken Ecke des Browserfensters empfängt.

setStyles

setStyles(styles, callback) Fügt dem Fensterrahmen der benutzerdefinierten Aktion CSS-Stile hinzu.

Parameter	Beschreibung
`styles`	Ein Objekt mit CSS-Eigenschaftsnamen und -werten (siehe folgendes Beispiel).
`callback`	Eine Callback-Funktion.

{
  display: 'block',
  position: 'absolute',
  top: '0px',
  bottom: '0px',
  left: '0px',
  right: '0px',
  width: '100%',
  height: '100%',
  border: '0',
  overflow: 'hidden',
  'overflow-x': 'hidden',
  'overflow-y': 'hidden',
  'z-index': '10000'
}

commandArgs-Objekt

Variablen

Variable	Typ	Beschreibung
`commandArgs.params.document`	Document	Speichert eine Kopie eines geöffneten Dokumentobjekts. Verwenden Sie sie, um auf Fehler, Felder oder Regionen des aktuellen Dokuments zuzugreifen.
`commandArgs.params.currentField`	`(Picture \| Checkmark \| Checkmark Groups \| FieldsGroup \| Table \| TextField)`	Gibt einen Verweis auf ein Feldobjekt zurück, das den Zustand des Felds zum Zeitpunkt des Skriptaufrufs widerspiegelt. Es ist Teil des oben genannten Dokuments. Änderungen am Feldwert nach der Initialisierung des Skripts werden nicht übernommen.
`commandArgs.params.appPath`	String	Der Domänenname des Servers.
`commandArgs.params.coordinates`	`Object [{X1,X2,Y1,Y2}]`	Die Koordinaten des DOM-Elements, das das benutzerdefinierte Skript aufgerufen hat.
`commandArgs.params.currentElementDomId`	String	Die ID des DOM-Elements, das das benutzerdefinierte Skript aufgerufen hat.

Ereignisse

Funktion	Beschreibung
`commandArgs.events.addEventHandler`	Fügt dem globalen Kontext des benutzerdefinierten Skripts einen Event-Handler hinzu.
`commandArgs.events.triggerHandlers`	Löst im globalen Kontext des benutzerdefinierten Skripts ein Ereignis aus.
`commandArgs.events.removeEventHandler`	Entfernt einen Event-Handler aus dem globalen Kontext des benutzerdefinierten Skripts.

Feldobjekttypen

Benutzerdefinierte Skripte können auf die folgenden Feldobjekttypen sowie auf das Document-Objekt zugreifen. Jedes Feldobjekt stellt über seine Eigenschaft Regions das Region-Objekt bereit.

Feldgruppenfeld

Eigenschaft	Typ	Zugriff	Beschreibung
`Fields`	`(Picture \| Checkmark \| Checkmark Groups \| FieldsGroup \| Table \| TextField)[]`	Schreibgeschützt	Array von Feldern.
`HasTableLayout`	Boolean	Schreibgeschützt	Gibt an, ob die Feldregion eine Tabelle ist.
`Caption`	String	Schreibgeschützt	Benutzerdefinierter Feldname bzw. Beschriftung.
`FieldType`	Number	Schreibgeschützt	Feldtyp. Wert: `4` (Feldgruppe).
`Id`	Number	Schreibgeschützt	Feld-ID.
`IsReadOnly`	Boolean	Schreibgeschützt	Gibt an, ob Felder nicht bearbeitet werden können.
`IsVisible`	Boolean	Schreibgeschützt	Gibt an, ob das Feld im Datenformular sichtbar ist.
`MaxRegions`	Number	Schreibgeschützt	Maximale Anzahl von Feldregionen. Bei dem Wert `-1` ist eine beliebige Anzahl von Regionen zulässig.
`Name`	String	Schreibgeschützt	Servicename des Felds.
`NamePath`	`String[]`	Schreibgeschützt	Array von Feld- und Gruppennamen, die den Pfad zum Feld bilden.
`NeedRecognize`	Boolean	Lesen/Schreiben	Gibt an, ob der Feldwert aus der Region abgerufen werden soll, wenn die Regeln erneut geprüft werden.
`Regions`	`Region[]`	Schreibgeschützt	Regionen des Felds. Siehe Region-Objekt.

Section-Feld

Eigenschaft	Typ	Zugriff	Beschreibung
`Fields`	`(Picture \| Checkmark \| Checkmark Groups \| FieldsGroup \| Table \| TextField)[]`	Schreibgeschützt	Array von Feldern.
`Pageids`	`Number[]`	Schreibgeschützt	Bezeichner der Seiten, auf denen sich die Section befindet.
`IsFlexible`	Boolean	Schreibgeschützt	Gibt an, ob die Section flexibel ist.
`Caption`	String	Schreibgeschützt	Benutzerdefinierter Feldname bzw. Beschriftung.
`FieldType`	Number	Schreibgeschützt	Feldtyp. Wert: `6` (Section).
`Id`	Number	Schreibgeschützt	Feld-ID.
`IsReadOnly`	Boolean	Schreibgeschützt	Gibt an, ob das Feld bearbeitet werden kann.
`IsVisible`	Boolean	Schreibgeschützt	Gibt an, ob das Feld im Datenformular sichtbar ist.
`MaxRegions`	Number	Schreibgeschützt	Maximale Anzahl an Feldregionen. Bei einem Wert von `-1` ist eine beliebige Anzahl an Regionen zulässig.
`Name`	String	Schreibgeschützt	Servicename des Felds.
`NamePath`	`String[]`	Schreibgeschützt	Array von Feld- und Gruppennamen, die den Pfad zum Feld bilden.
`NeedRecognize`	Boolean	Lesen/Schreiben	Gibt an, ob der Feldwert aus der Region abgerufen werden soll, wenn die Regeln erneut geprüft werden.
`Regions`	`Region[]`	Schreibgeschützt	Regionen des Felds. Siehe Region-Objekt.

Tabellenfeld

Eigenschaft	Typ	Zugriff	Beschreibung
`Rows`	`Row[]`	Schreibgeschützt	Liste der Tabellenzeilen. Siehe Row-Objekt.
`Caption`	String	Schreibgeschützt	Benutzerdefinierter Feldname, Beschriftung.
`FieldType`	Number	Schreibgeschützt	Feldtyp. Wert: `7` (Tabelle).
`Id`	Number	Schreibgeschützt	Feld-ID.
`IsReadOnly`	Boolean	Schreibgeschützt	Gibt an, ob die Bearbeitung des Felds nicht zulässig ist.
`IsVisible`	Boolean	Schreibgeschützt	Gibt an, ob das Feld im Datenformular sichtbar ist.
`MaxRegions`	Number	Schreibgeschützt	Gibt an, ob das Feld im Datenformular sichtbar ist. Bei `-1` ist eine beliebige Anzahl von Regionen zulässig.
`Name`	String	Schreibgeschützt	Service-Name des Felds.
`NamePath`	`String[]`	Schreibgeschützt	Array aus Feld- und Gruppennamen, die den Pfad zum Feld bilden.
`NeedRecognize`	Boolean	Lesen/Schreiben	Gibt an, ob der Feldwert aus der Region abgerufen werden soll, wenn die Regeln erneut überprüft werden.
`Regions`	`Region[]`	Schreibgeschützt	Regionen des Felds. Siehe Region-Objekt.

Row-Objekt

Eigenschaft	Typ	Beschreibung
`Id`	number	Zeilen-ID.
`RowNumber`	number	Die fortlaufende Nummer der Zeile, beginnend bei null.
`HasColorImage`	boolean	Gibt an, ob das Zeilenbild farbig ist.
`TableBlockID`	`number[]`	Bezeichner der Abschnitte, Tabellen und Tabellenblöcke, die den Pfad zum Tabellenblock bilden.
`Cells`	`(Picture \| Checkmark \| CheckmarkGroup \| TextField)[]`	Felder in den Tabellenzellen.

Textfeld

Eigenschaft	Typ	Zugriff	Beschreibung
`Flags`	`Number[]`	Lesen/Schreiben	Array mit derselben Länge wie der Feldwert `Value`, bestehend aus `0` und `1`. Ein Zeichen in `Value`, das an derselben Position wie eine `0` in `Flags` steht, muss verifiziert werden.
`Suggests`	`String[]`	Schreibgeschützt	Liste der vorgeschlagenen Feldwerte.
`Value`	String	Lesen/Schreiben	Feldwert.
`TextType`	Number	Schreibgeschützt	Typ des Textfelds. Siehe TextType-Werte.
`Caption`	String	Schreibgeschützt	Benutzerdefinierter Feldname, Beschriftung.
`FieldType`	Number	Schreibgeschützt	Feldtyp. Wert: `0` (Textfeld).
`Id`	Number	Schreibgeschützt	Feld-ID.
`IsReadOnly`	Boolean	Schreibgeschützt	Gibt an, ob das Bearbeiten des Felds nicht zulässig ist.
`IsVisible`	Boolean	Schreibgeschützt	Gibt an, ob das Feld im Datenformular sichtbar ist.
`MaxRegions`	Number	Schreibgeschützt	Maximale Anzahl von Feldregionen. Bei dem Wert `-1` ist eine beliebige Anzahl von Regionen zulässig.
`Name`	String	Schreibgeschützt	Servicename des Felds.
`NamePath`	`String[]`	Schreibgeschützt	Array aus Feld- und Gruppennamen, die den Pfad zum Feld bilden.
`NeedRecognize`	Boolean	Lesen/Schreiben	Gibt an, ob der Feldwert aus der Region abgerufen wird, wenn die Regeln erneut geprüft werden.
`Regions`	`Region[]`	Schreibgeschützt	Regionen des Felds. Siehe Region-Objekt.
`IsVerified`	Boolean	Lesen/Schreiben	Gibt an, ob das Feld verifiziert wurde.
`NeedVerification`	Boolean	Schreibgeschützt	Gibt an, ob das Feld verifiziert werden muss.
`NeedDoubleVerification`	Boolean	Schreibgeschützt	Gibt an, ob das Feld doppelt verifiziert werden muss.
`IsSummary`	Boolean	Schreibgeschützt	Gibt an, ob das Feld in der Datenzusammenfassung des Datenformulars verwendet wird.

TextType-Werte

Wert	Bedeutung
`0`	Textfeld
`1`	Numerisches Feld
`2`	Währungsbetragsfeld
`3`	DateTime-Feld
`4`	Datumsfeld
`5`	Zeitfeld
`6`	Codefeld

Häkchenfeld

Eigenschaft	Typ	Zugriff	Beschreibung
`Value`	Boolean	Lesen/Schreiben	Feldwert.
`Caption`	String	Schreibgeschützt	Benutzerdefinierter Feldname, Beschriftung.
`FieldType`	Number	Schreibgeschützt	Feldtyp. Wert: `2` (Häkchen).
`Id`	Number	Schreibgeschützt	Feld-ID.
`IsReadOnly`	Boolean	Schreibgeschützt	Gibt an, ob die Bearbeitung des Felds gesperrt ist.
`IsVisible`	Boolean	Schreibgeschützt	Gibt an, ob das Feld im Datenformular sichtbar ist.
`MaxRegions`	Number	Schreibgeschützt	Maximale Anzahl von Feldregionen. Bei einem Wert von `-1` ist eine beliebige Anzahl von Regionen zulässig.
`Name`	String	Schreibgeschützt	Servicename des Felds.
`NamePath`	`String[]`	Schreibgeschützt	Array aus Feld- und Gruppennamen, die den Pfad zum Feld bilden.
`NeedRecognize`	Boolean	Lesen/Schreiben	Gibt an, ob der Feldwert aus der Region abgerufen werden soll, wenn die Regeln erneut geprüft werden.
`Regions`	`Region[]`	Schreibgeschützt	Regionen des Felds. Siehe Region-Objekt.
`IsVerified`	Boolean	Lesen/Schreiben	Gibt an, ob das Feld verifiziert wurde.
`NeedVerification`	Boolean	Schreibgeschützt	Gibt an, ob das Feld verifiziert werden muss.
`NeedDoubleVerification`	Boolean	Schreibgeschützt	Gibt an, ob das Feld doppelt verifiziert werden muss.
`IsSummary`	Boolean	Schreibgeschützt	Gibt an, ob das Feld in der Datenzusammenfassung im Datenformular verwendet wird.

Häkchengruppenfeld

Eigenschaft	Typ	Zugriff	Beschreibung
`MaxSelectedCount`	Number	Schreibgeschützt	Maximale Anzahl ausgewählter Feldwerte.
`MinSelectedCount`	Number	Schreibgeschützt	Minimale Anzahl ausgewählter Feldwerte.
`Values`	`Number[]`	Lesen/Schreiben	Feldwert. Ein Array von Datensatz-IDs, das die Liste der möglichen Feldwerte (`Variants`) bildet.
`Variants`	`{Id: number, Name: string}[]`	Schreibgeschützt	Liste der möglichen Feldwerte. Jede Variante verfügt über `Id` (Datensatz-ID) und `Name` (Datensatzname).
`Caption`	String	Schreibgeschützt	Benutzerdefinierter Feldname bzw. Beschriftung.
`FieldType`	Number	Schreibgeschützt	Feldtyp. Wert: `3` (Häkchengruppe).
`Id`	Number	Schreibgeschützt	Feld-ID.
`IsReadOnly`	Boolean	Schreibgeschützt	Gibt an, ob die Bearbeitung des Felds nicht zulässig ist.
`IsVisible`	Boolean	Schreibgeschützt	Gibt an, ob das Feld im Datenformular sichtbar ist.
`MaxRegions`	Number	Schreibgeschützt	Maximale Anzahl von Feldregionen. Bei einem Wert von `-1` ist eine beliebige Anzahl von Regionen zulässig.
`Name`	String	Schreibgeschützt	Service-Name des Felds.
`NamePath`	`String[]`	Schreibgeschützt	Array aus Feld- und Gruppennamen, die den Pfad zum Feld bilden.
`NeedRecognize`	Boolean	Lesen/Schreiben	Gibt an, ob der Feldwert bei erneuter Überprüfung der Regeln aus der Region abgerufen werden soll.
`Regions`	`Region[]`	Schreibgeschützt	Regionen des Felds. Siehe Region-Objekt.
`IsVerified`	Boolean	Lesen/Schreiben	Gibt an, ob das Feld verifiziert wurde.
`NeedVerification`	Boolean	Schreibgeschützt	Gibt an, ob das Feld eine Verifizierung erfordert.
`NeedDoubleVerification`	Boolean	Schreibgeschützt	Gibt an, ob das Feld eine doppelte Verifizierung erfordert.
`IsSummary`	Boolean	Schreibgeschützt	Gibt an, ob das Feld in der Datenzusammenfassung des Datenformulars verwendet wird.

Bildfeld

Eigenschaft	Typ	Zugriff	Beschreibung
`Caption`	String	Schreibgeschützt	Benutzerdefinierter Feldname, Beschriftung.
`FieldType`	Number	Schreibgeschützt	Feldtyp. Wert: `1` (Bild).
`Id`	Number	Schreibgeschützt	Feld-ID.
`IsReadOnly`	Boolean	Schreibgeschützt	Gibt an, ob das Feld nicht bearbeitet werden kann.
`IsVisible`	Boolean	Schreibgeschützt	Gibt an, ob das Feld im Datenformular sichtbar ist.
`MaxRegions`	Number	Schreibgeschützt	Maximale Anzahl von Feldregionen. Bei einem Wert von `-1` ist eine beliebige Anzahl von Regionen zulässig.
`Name`	String	Schreibgeschützt	Servicename des Felds.
`NamePath`	`String[]`	Schreibgeschützt	Array aus Feld- und Gruppennamen, die den Pfad zum Feld bilden.
`Regions`	`Region[]`	Schreibgeschützt	Regionen des Felds. Siehe Region-Objekt.

Feld „Wiederholbare Gruppe von Abschnitten“

Eigenschaft	Typ	Zugriff	Beschreibung
`Id`	Number	Schreibgeschützt	Feld-ID.
`Name`	String	Schreibgeschützt	Feldname.
`Sections`	`Section[]`	Schreibgeschützt	Array von Feldern vom Typ Section-Feld.
`FieldType`	Number	Schreibgeschützt	Feldtyp. Wert: `8` (wiederholbare Abschnittsgruppe).

Region-Objekt

Die Regions-Eigenschaft jedes Feldobjekts gibt ein Array von Regionen mit folgender Struktur zurück.

Eigenschaft	Typ	Beschreibung
`Id`	number	ID der Region.
`Status`	number	Status der Region: `0` Region nicht überlagert (oder gelöscht), `1` Region nicht erkannt, `2` der Wert aus der Region wird in das Feld übernommen.
`PageId`	Number	ID der Seite, auf der sich die Region befindet.
`IsNew`	Boolean	Flag zur Kennzeichnung neuer Regionen.
`Coordinates`	`Object [{X1,X2,Y1,Y2}]`	Koordinaten der Region im Bild.

Document-Objekt

Das Document-Objekt ist über commandArgs.params.document verfügbar.

Eigenschaft	Typ	Zugriff	Beschreibung
`AssemblingErrors`	`AssemblingError[]`	Schreibgeschützt	Zusammenstellungsfehler im Document. Siehe Objekt „Zusammenstellungsfehler“.
`BatchId`	Number	Schreibgeschützt	Die Batch-ID.
`Errors`	`Error[]`	Schreibgeschützt	Fehler im Document. Siehe Fehlerobjekt.
`Fields`	`(Section \| SectionsGroup)[]`	Schreibgeschützt	Liste der Abschnitte und doppelten Abschnitte.
`Id`	Number	Schreibgeschützt	Document-Bezeichner.
`Index`	Number	Schreibgeschützt	Index des Documents im Batch.
`Pages`	`Page[]`	Schreibgeschützt	Liste der Dokumentseiten. Siehe Page-Objekt.
`ProjectId`	Number	Schreibgeschützt	Projektbezeichner.
`TaskId`	Number	Schreibgeschützt	Task-ID.
`TemplateId`	Number	Schreibgeschützt	Definitions-ID des Documents.
`TemplateName`	String	Schreibgeschützt	Name der Document Definition.
`TemplateVersion`	Number	Schreibgeschützt	Definitionsversion des Documents.
`Version`	Number	Schreibgeschützt	Document-Version.

Objekt „Zusammenstellungsfehler“

Eigenschaft	Typ	Beschreibung
`DocumentNodeRef`	`number[][]`	Liste von Verweisen auf Felder im Formular in Form eines Arrays von Feld-IDs.
`Description`	string	Fehlerbeschreibung.
`SectionName`	`string[]`	Liste der am Fehler beteiligten Abschnitte.

Fehlerobjekt

Eigenschaft	Typ	Beschreibung
`DocumentNodeRef`	`number[][]`	Liste von Verweisen auf Felder im Formular als Array von Feld-IDs.
`Severity`	number	`1` Fehler, `0` Warnung.
`Message`	string	Fehlertext.
`RuleName`	string	Name der Regel, die den Fehler verursacht hat.

Page-Objekt

Eigenschaft	Typ	Beschreibung
`Id`	number	Seiten-ID.
`Modification`	number	Revisionsnummer der Seite.
`HasColorImage`	boolean	Gibt an, ob die Seite ein Farbbild enthält.
`ImageResolution`	number	Bildauflösung.
`KeyValue`	string	Wert des wichtigen Felds der Seite.
`SectionTemplateId`	number	ID des Seitenabschnitts.
`SectionTemplateName`	string	Name des Seitenabschnitts.
`FlexibleInstanceId`	number	ID der flexiblen Instanz.
`SectionTemplatePageNumber`	number	Seitennummer innerhalb des Abschnitts.
`Comment`	string	Kommentar zur Seite.
`ImageWidth`	number	Breite des Seitenbilds.
`ImageHeight`	number	Höhe des Seitenbilds.

​Feldpfade

​Funktionen zum Arbeiten mit Feldern

​getCurrentField

​getFieldByName

​getFieldValue

​setCurrentFieldValue

​setFieldValue

​save

​cancel

​Funktionen zum Arbeiten mit Datensätzen

​addEntity

​editEntity

​getDict

​getDictAll

​Funktionen für die Arbeit mit dem Dokumentformular

​selectRow

​deselectRow

​scrollFormToField

​getDomElementPosition

​setStyles

​commandArgs-Objekt

​Variablen

​Ereignisse

​Feldobjekttypen

​Feldgruppenfeld

​Section-Feld

​Tabellenfeld

​Row-Objekt

​Textfeld

​TextType-Werte

​Häkchenfeld

​Häkchengruppenfeld

​Bildfeld

​Feld „Wiederholbare Gruppe von Abschnitten“

​Region-Objekt

​Document-Objekt

​Objekt „Zusammenstellungsfehler“

​Fehlerobjekt

​Page-Objekt