Objekte

Gibt einen Link für das Feld zurück, für den das benutzerdefinierte Skript geöffnet wurde.

Beispiel: ['Document Section 1', 'Group[10]','Field3'] where [10] ist die Nummer der Instanz der sich wiederholenden Gruppe.

• namesPath – entweder ein Array mit Feld- und Gruppennamen, die den Pfad zum Feld oder eine Verknüpfung zu einem Feldobjekt bilden.

Gibt zurück:

• eine Zeichenfolge für ein TextField-Feld;
• einen Wert eines Auswahlfelds für ein Auswahlfeld;
• ein Zeichenfolgenarray für ein Auswahlgruppenfeld.

namesPath | fieldObject:

• ein Array mit Feld- und Gruppennamen, die den Pfad zum Feld oder eine Verknüpfung zu einem Feldobjekt bilden,
• oder ein Link zu einem Feldobjekt.

Ändert den Wert des Feldes, für das das benutzerdefinierte Skript geöffnet wurde.

Parameter:

• value – der neue Feldwert.
• forced – aktualisiert den Feldwert und zeichnet neue Daten auf. Dieser Parameter ist optional.
• false – der Feldwert in der Dokumentdefinition wird nur dann aktualisiert, wenn die Funktion save() aufgerufen wurde.
• true – der Feldwert in der Dokumentdefinition wird sofort aktualisiert.
  
  Ein benutzerdefiniertes Skript wird unabhängig vom Modus aktualisiert.
  Standardmäßig ist der Schlüssel auf false gesetzt.

• onSaved – Eine Callback-Funktion. Die Funktion wird aufgerufen, wenn der Parameter forced auf true festgelegt ist. Dieser Parameter ist optional.

Ändert die Feldwerte.

Parameter:

• namesPath | fieldObject:
• ein Array mit Feld- und Gruppennamen, die den Pfad zu dem Feld bilden,
• oder ein Link zu einem Feldobjekt.
• value – Wert des entsprechenden Feldes.
• forced – aktualisiert den Feldwert und zeichnet neue Daten auf. Dieser Parameter ist optional.
• false – der Feldwert in der Dokumentdefinition wird nur dann aktualisiert, wenn die Funktion save() aufgerufen wurde.
• true – der Feldwert in der Dokumentdefinition wird sofort aktualisiert.
  
  Bei einem benutzerdefinierten Skript wird ein Update unabhängig vom Modus durchgeführt.
  Dieser Parameter ist standardmäßig auf false festgelegt.

• onSaved –  Eine Callback-Funktion. Die Funktion wird aufgerufen, wenn der Parameter forced auf true festgelegt ist. Dieser Parameter ist optional.

(*)Für einige der oben aufgeführten Funktionen wird der Pfad zum Feld als Eingabeparameter angegeben. Es umfasst den Feldnamen und die Namen der übergeordneten Elemente (Feldgruppe, Bereich). Für Tabellen, sich wiederholende Tabellen und sich wiederholende Gruppen müssen Sie die Instanznummer angeben, die bei 0 (null) beginnt.

Beispiel:
['Document Section 1', 'Group[10]','Field3'],

where [10] ist die Nummer der Instanz der sich wiederholenden Gruppe.

addEntity(entityInfo: {cacheName, columns, values}, onResult(newId))

Fügt dem Datensatz einen Eintrag hinzu.

Parameter:

• entityInfo – ein Objekt:
• cacheName – ein Name für den Datensatz.
• columns – Namen für die Spalten, in denen die Daten aufgezeichnet werden. Zeichenfolgenarrays.
• values – die Werte für die entsprechenden Spalten. Zeichenfolgenarrays.
• onResult – Eine Callback-Funktion, die die ID des im Datensatz erstellten Eintrags empfängt.

Bearbeitet einen Eintrag in der Datenbank.

Parameter:

• entityInfo – ein Objekt:
• cacheName – ein Name für den Datensatz.
• columns – Namen für die Spalten, in denen die Daten aufgezeichnet werden. Zeichenfolgenarrays.
• values – die Werte für die entsprechenden Spalten. Zeichenfolgenarrays.
• onResult – eine Callback-Funktion.

Führt eine Datensatzsuche nach einem bestimmten Wert oder nach einem Teil davon durch. Gibt die übereinstimmenden Zeichenfolgen im folgenden Format zurück:

[{FieldName
FieldValue
BoldMask}].

Parameter:

• cacheName – der Datensatzname.
• filters – Suchparameter:
• FieldName – der Feldname. Leer lassen, um alle Felder zu durchsuchen.
• FieldValue – der Feldwert.
• cursorPos – die Position des Cursors im Eingabefeld.
• Wenn ein Wert teilweise eingegeben wurde und der Cursor hinter den eingegebenen Symbolen positioniert ist, werden sie als Präfix für den gesuchten Wert betrachtet.
• Wenn sich der Cursor vor einem teilweise eingegebenen Wort befindet, werden diese Symbole als Ende des Werts betrachtet, nach dem gesucht wird.
  
  Suchen Sie beispielsweise nach einem Firmenname, geben Sie "AB" ein und der Cursor wird danach positioniert und der Wert "ABBYY" ausgewählt.
  Geben Sie "AB" ein und der Cursor wird davor positioniert, wird der Wert "Q LAB erwähnen" ausgewählt.

• allowMultipleColumnResults – Gibt die Werte der gefundenen Felder zurück.
  Der Datensatz kann Einträge enthalten, für die ein Feldname (FieldName) mehreren Feldwerten entspricht (FieldValue). Beispielsweise können zwei oder mehr Variationen des Firmennamens in der Spalte Firmenname angegeben werden.
  
  In diesem Fall:
• true – gibt alle Feldwerte zurück, die den Suchbedingungen entsprechen und zeichnet diese auf,
• false – gibt ein Einzelergebnis zurück, das den Suchbedingungen am besten entspricht und zeichnet diese auf.
• onResult – eine Callback-Funktion, die ein Suchergebnis-Array zurückgibt. Jedes Ergebnis ist eine einzelne Zeichenfolge aus dem Datensatz, der ein Zeichenfolgenarray ist. Jede Zeichenfolge besteht aus Feldname, dessen Wert und dem ParameterBoldMask .
  
  BoldMask – eine Zeichenfolge aus ‘0’ und ‘1’ derselben Länge wieder Wert, der während der Suche gefunden wurde. '1' repräsentiert ein Symbol aus dem gefundenen Wert, das mit dem entsprechenden Symbol im Suchfeld übereinstimmt, und '0' repräsentiert ein Symbol, das damit nicht übereinstimmt.

Wenn beispielsweise das Folgende in einem Datensatz enthalten ist:

CompanyName: ABBYY

Nehmen wir an, dass nach den Symbolen "AB" gesucht wird.

Dann wird das Folgende zurückgegeben:

[

  [

     {

           FieldName: ‘CompanyName’,

           FieldValue: ‘ABBYY’,

           BoldMask: ‘11000’

      },

  ]

]

Führt eine Datenbanksuche für den gesamten angegebenen Wert durch. Gibt die Werte aller Felder zurück, die gefunden wurden.

Parameter:

• cacheName– der Datensatzname.
• Filters – ein Objekt-Array:
• FieldName – der Feldname. Um alle Felder zu durchsuchen, sollte dies leer gelassen werden.
• FieldValue – der Feldwert.
• onResult – eine Callback-Funktion, die ein Suchergebnis-Array zurückgibt. Jedes Ergebnis ist eine einzelne Zeichenfolge aus dem Datensatz, der selbst ein Zeichenfolgenarray ist. Jede Zeichenfolge besteht aus dem Feldnamen, dessen Wert und dem ParameterBoldMask.
  
  BoldMask – eine Zeichenfolge aus ‘0’ und ‘1’ in derselben Länge wieder Wert, der während der Suche gefunden wurde. '1' repräsentiert ein Symbol aus dem gefundenen Wert, das mit dem entsprechenden Symbol im Suchfeld übereinstimmt, und '0' repräsentiert ein Symbol, das damit nicht übereinstimmt.
  
  
  Wenn beispielsweise Folgendes im Datensatz vorhanden ist:
  
  CompanyName: ABBYY
  
  Nehmen wir an, dass nach den Symbolen "AB" gesucht wird.
  
  Dann wird Folgendes zurückgegeben:

[

  [

     {

           FieldName: ‘CompanyName’,

           FieldValue: ‘ABBYY’,

           BoldMask: ‘11000’

      },

  ]

]

Markiert eine Tabellenzeile als ausgewählt.

• tablePath | fieldObject:
• ein Array aus Feld- und Gruppennamen, die den Pfad zum Tabellenfeld bilden,
• oder ein Link zu einem Tabellenobjekt.
• rowNumber – die Nummer der Zeile, die ausgewählt werden soll, nullbasiert.

Entfernt die Auswahl von einer Tabellenzeile.

• tablePath | fieldObject:
• ein Array von Feld- und Gruppennamen, die den Pfad zum Tabellenpfad bilden,
• oder ein Link zu einem Tabellenobjekt.
• rowNumber – die Nummer der Zeile zum Deaktivieren, nullbasiert, wenn ausgelassen, wird die Auswahl aus allen Zeilen in der Tabelle entfernt.

Scrollt den Formulareditor, um das Feld in den sichtbaren Bereich zu bewegen.

• namesPath | fieldObject:
• ein Array aus Feld- und Gruppennamen, die den Pfad zum Tabellenfeld bilden,
• oder ein Link zu einem Tabellenobjekt.

Ruft die Position eines Elements im Formulareditorfenster ab und gibt das Ergebnis einer Callback-Funktion zurück.

• domId – Element-ID im DOM-Format.
• onResult – eine Callback-Funktion, die das Objekt mit den DOM-Koordinaten des Elements empfängt (Breite, Höhe, oben, links, rechts, unten) in Bezug auf die linke obere Ecke des Browserfensters.

Fügt dem benutzerdefinierten Aktionsrahmenfenster CSS-Stile hinzu.

• styles – ein Objekt mit CSS-Eigenschaftsnamen und CSS-Werten .
  
  example:
  {
  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'
  }
• callback – eine Callback-Funktion.

(*) Für einige der oben aufgeführten Funktionen wird der Pfad zum Feld als Eingabeparameter angegeben. Es umfasst den Feldnamen und die Namen der übergeordneten Elemente (Feldgruppe, Bereich). Für Tabellen, sich wiederholende Tabellen und sich wiederholende Gruppen müssen Sie die Instanznummer angeben, die bei null beginnt.

Beispiel:
['Document Section 1', 'Group[10]','Field3'],

wobei [10] die Nummer der Instanz der sich wiederholenden Gruppe ist.

Feldtyp. Mögliche Werte:

4 – Feldgruppen

Bereichsarray, bei dem:

• Id – Bereichs-ID
• Status –Bereichsstatus
• 0 – Bereich wurde nicht zugeordnet (Bereich gelöscht)
• 1 – Bereich wurde nicht erkannt
• 2 – der Wert des Bereichs wurde in ein Feld eingefügt
• PageId – ID einer Seite, in der sich ein Bereich befindet
• IsNew – eine Markierung für das Markieren neuer Bereiche.
• Coordinates – Koordinaten des Bereichs im Bild.

Feldtyp. Mögliche Werte:

6 – Bereich

Bereichsarray, bei dem:

• Id – Bereichs-ID
• Status –Bereichsstatus
• 0 – Bereich wurde nicht zugeordnet (Bereich gelöscht)
• 1 – Bereich wurde nicht erkannt
• 2 – der Wert des Bereichs wurde in ein Feld eingefügt
• PageId – ID einer Seite, in der sich ein Bereich befindet
• IsNew – eine Markierung für das Markieren neuer Bereiche.
• Coordinates – Koordinaten des Bereichs im Bild.

Die Liste von Tabellenzeilen

Die Parameter der Objektzeile in der Tabelle:

• Id – Zeilen-ID.
• RowNumber – die laufende Nummer der Zeile, beginnend bei null.
• TableBlockId – Kennungen von Bereichen, Tabellen, Tabellenblöcken, die den Pfad zum Tabellenblock bilden.
• Cells – Felder in Tabellenzellen. Felder können vom folgenden Typ sein: Bild, Auswahlfeld, Auswahlfeldgruppe, Text.

Feldtyp. Mögliche Werte:

7 – Tabelle

Bereichsarray, bei dem:

• Id – Bereichs-ID
• Status –Bereichsstatus
• 0 – Bereich wurde nicht zugeordnet (Bereich gelöscht)
• 1 – Bereich wurde nicht erkannt
• 2 – der Wert des Bereichs wurde in ein Feld eingefügt
• PageId – ID einer Seite, in der sich ein Bereich befindet
• IsNew – eine Markierung für das Markieren neuer Bereiche.
• Coordinates – Koordinaten des Bereichs im Bild.

Array derselben Länge wie das Feld Wert. Besteht aus 0 und 1.

0 – ein Zeichen, das sich im Wert Value in der gleichen Position befindet wie 0 in Markierungen, erfordert Überprüfung.

Textfeldtyp. Möglicher Wert:

• 0 – Textfeld.
• 1 – Zahlenfeld.
• 2 – Felder für Währungsbetrag.
• 3 – DateTime-Feld.
• 4 – Datumsfeld.
• 5 – Uhrzeitfeld.
• 6 – Codefeld.

Feldtyp. Mögliche Werte:

0 – text field

Bereichsarray, bei dem:

• Id – Bereichs-ID
• Status –Bereichsstatus
• 0 – Bereich wurde nicht zugeordnet (Bereich gelöscht)
• 1 – Bereich wurde nicht erkannt
• 2 – der Wert des Bereichs wurde in ein Feld eingefügt
• PageId – ID einer Seite, in der sich ein Bereich befindet
• IsNew – eine Markierung für das Markieren neuer Bereiche.
• Coordinates – Koordinaten des Bereichs im Bild.

Feldtyp. Mögliche Werte:

2 – checkmark

Bereichsarray, bei dem:

• Id – Bereichs-ID
• Status –Bereichsstatus
• 0 – Bereich wurde nicht zugeordnet (Bereich gelöscht)
• 1 – Bereich wurde nicht erkannt
• 2 – der Wert des Bereichs wurde in ein Feld eingefügt
• PageId – ID einer Seite, in der sich ein Bereich befindet
• IsNew – eine Markierung für das Markieren neuer Bereiche.
• Coordinates – Koordinaten des Bereichs im Bild.

Eine Liste möglicher Feldwerte:

• Id – Datensatz-ID
• Name – Datensatzname

Feldtyp. Mögliche Werte:

3 – checkmark group

Bereichsarray, bei dem:

• Id – Bereichs-ID
• Status –Bereichsstatus
• 0 – Bereich wurde nicht zugeordnet (Bereich gelöscht)
• 1 – Bereich wurde nicht erkannt
• 2 – der Wert des Bereichs wurde in ein Feld eingefügt
• PageId – ID einer Seite, in der sich ein Bereich befindet
• IsNew – eine Markierung für das Markieren neuer Bereiche..
• Coordinates – Koordinaten des Bereichs im Bild.

Feldtyp. Mögliche Werte:

1 – Bild

Bereichsarray, bei dem:

• Id – Bereichs-ID
• Status –Bereichsstatus
• 0 – Bereich wurde nicht zugeordnet (Bereich gelöscht)
• 1 – Bereich wurde nicht erkannt
• 2 – der Wert des Bereichs wurde in ein Feld eingefügt
• PageId – ID einer Seite, in der sich ein Bereich befindet
• IsNew – eine Markierung für das Markieren neuer Bereiche.
• Coordinates – Koordinaten des Bereichs im Bild.

Feldtyp.

Mögliche Werte

8 – Sich wiederholende Bereichsgruppe

Erstellungsfehler im Dokument, wobei:

• DocumentNodeRef – eine Liste von Links, die wie ein Array von ID-Feldern aussehen und zu Feldern im Formular führen
• Description – eine Fehlerbeschreibung
• SectionName – eine Liste von Bereichen, in denen Fehler auftreten

Dokumentfehler, wobei:

• DocumentNodeRef – eine Liste von Links, die wie ein Array von ID-Feldern aussehen und zu Feldern im Formular führen
• Schweregrad: 1 – Fehler, 0 – Warnung
• Meldung – eine Fehlermeldung
• RuleName – Der Name der Regel, die den Fehler verursacht hat

Eine Liste von Dokumentseiten, wobei:

• ID – Seiten-ID
• Modification – Änderungsnummer auf einer Seite
• HasColorImage – zeigt an, ob eine Seite farbig ist
• ImageResolution – Bildauflösung
• KeyValue – Wert eines Schlüsselfelds einer Seite
• SectionTemplateId – Seitenbereich-ID
• SectionTemplateName – Name des Seitenbereichs
• SectionTemplatePageNumber – Seitennummer eines Bereichs
• Comment – Kommentar auf einer Seite
• ImageWidth – Breite eines Bildes auf einer Seite
• ImageHeight – Höhe eines Bildes auf einer Seite