Objekte
Unten finden Sie eine Liste der Funktionen, die zum Erstellen benutzerdefinierter Skripte verfügbar sind. Verwenden Sie die Variable commandArgs, um auf Objektinstanzen zuzugreifen.
Alle Variablen in diesem Bereich sind global und im gesamten Programm sichtbar.
Funktionen für das Arbeiten mit Feldern
Funktion | Beschreibung |
getCurrentField() | Gibt einen Link an das Feldobjekt zurück, das ein geöffnetes Benutzerskript verwendet. |
getFieldByName(namesPath) (*) |
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.
|
getFieldValue(namesPath) (*) |
Gibt zurück:
namesPath | fieldObject:
|
setCurrentFieldValue(value, forced, onSaved) |
Ändert den Wert des Feldes, für das das benutzerdefinierte Skript geöffnet wurde. Parameter:
|
setFieldValue(namesPath | field, value, forced, onSaved) (*) |
Ändert die Feldwerte. Parameter:
|
save() | Schließt das Fenster, in dem das benutzerdefinierte Skript ausgeführt wird und speichert die Änderungen. |
cancel() | Schließt das Fenster, in dem das benutzerdefinierte Skript ausgeführt wird und speichert die Änderungen nicht. |
(*)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: where [10] ist die Nummer der Instanz der sich wiederholenden Gruppe. |
Funktionen für das Arbeiten mit Datensätzen
Funktion | Beschreibung |
addEntity(entityInfo: {cacheName, columns, values}, onResult(newId)) |
Fügt dem Datensatz einen Eintrag hinzu. Parameter:
|
editEntity(entityInfo: {cacheName, columns, values}, onResult()) |
Bearbeitet einen Eintrag in der Datenbank. Parameter:
|
getDict({cacheName, filters: [{FieldName, FieldValue}], cursorPos, allowMultipleColumnResults}, onResult (param: { FieldName, FieldValue, BoldMask}[][]) ) |
Führt eine Datensatzsuche nach einem bestimmten Wert oder nach einem Teil davon durch. Gibt die übereinstimmenden Zeichenfolgen im folgenden Format zurück: [{FieldName Parameter:
Wenn beispielsweise das Folgende in einem Datensatz enthalten ist: CompanyName: ABBYY Nehmen wir an, dass nach den Symbolen "ABB" gesucht wird. Dann wird das Folgende zurückgegeben: [ [ { FieldName: ‘CompanyName’, FieldValue: ‘ABBYY’, BoldMask: ‘11100’ }, ] ] Hinweis. Das zurückgegebene Array kann einige Werte enthalten, unter anderem diejenigen, die den Suchbedingungen ursprünglich nicht entsprachen. Die Suchergebnisse im zurückgegebenen Array werden nach dem Parameterwert BoldMask in absteigender Reihenfolge sortiert werden (z. B. beginnend mit Strings, die den Suchbedingungen am besten entsprechen). |
getDictAll({cacheName, filters: {FieldName, FieldValue}}, }, onResult (param: { FieldName, FieldValue, BoldMask}[][])) |
Führt eine Datenbanksuche für den gesamten angegebenen Wert durch. Gibt die Werte aller Felder zurück, die gefunden wurden. Parameter:
[ [ { FieldName: ‘CompanyName’, FieldValue: ‘ABBYY’, BoldMask: ‘11100’ }, ] ] Hinweis. Das zurückgegebene Array kann einige Werte enthalten, unter anderem diejenigen, die den Suchbedingungen ursprünglich nicht entsprachen. Die Suchergebnisse im zurückgegebenen Array werden nach dem Parameterwert BoldMask in absteigender Reihenfolge sortiert werden (z. B. beginnend mit Strings, die den Suchbedingungen am besten entsprechen). |
Suchskript für Beispieldatenbank |
Funktionen für das Arbeiten mit dem Dokumentformular
Funktion | Beschreibung |
selectRow(tablePath, rowNumber) (*) |
Markiert eine Tabellenzeile als ausgewählt.
|
deselectRow(tablePath, rowNumber?) (*) |
Entfernt die Auswahl von einer Tabellenzeile.
|
scrollFormToField(namesPath) (*) |
Scrollt den Formulareditor, um das Feld in den sichtbaren Bereich zu bewegen.
|
getDomElementPosition(domId, onResult: (result?: {width, height, top, left, right, bottom})) |
Ruft die Position eines Elements im Formulareditorfenster ab und gibt das Ergebnis einer Callback-Funktion zurück.
|
setStyles(styles, callback) |
Fügt dem benutzerdefinierten Aktionsrahmenfenster CSS-Stile hinzu.
|
(*) 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: wobei [10] die Nummer der Instanz der sich wiederholenden Gruppe ist. |
Eigenschaften des Objekts commandArgs
Variablen
Variable | Typ | Beschreibung |
commandArgs.params.document | Dokument | Speichert eine Objektkopie eines offenen Dokuments. Dies kann verwendet werden, um Zugriff auf Fehler, Felder oder Regionen im aktuellen Dokument zu erhalten. |
commandArgs.params.currentField | (Picture | Checkmark | Checkmark Groups | FieldsGroup | Table | TextField) |
Gibt einen Link zu einem Feldobjekt zurück, der den Status des Feldes zum Zeitpunkt des Aufrufs des Skripts widerspiegelt. Teil des oben angegebenen Dokuments. Hinweis. Wenn der Feldwert nach der Initialisierung des Skripts geändert wurde, werden die Änderungen nicht übernommen. |
commandArgs.params.appPath | Zeichenfolge | Der Domänenname des Servers. |
commandArgs.params.coordinates | Objekt [{X1,X2,Y1,Y2}] |
Die Koordinaten des DOM-Elements, das das benutzerdefinierte Skript aufgerufen hat. |
commandArgs.params.currentElementDomId | Zeichenfolge | Die ID des DOM-Elements, von dem das benutzerdefinierte Skript aufgerufen wurde. |
Funktionen
Funktion | Beschreibung |
commandArgs.events.addEventHandler | Fügt einen Event-Handler im globalen Kontext des benutzerdefinierten Skripts hinzu. |
commandArgs.events.triggerHandlers | Löst ein Event im globalen Kontext des benutzerdefinierten Skripts aus. |
commandArgs.events.removeEventHandler | Löscht einen Event-Handler im globalen Kontext des benutzerdefinierten Skripts. |
Feldgruppenfeld
Name | Typ | Zugriff | Beschreibung |
Fields | (Picture | Checkmark | Checkmark Groups | FieldsGroup | Table | TextField)[] | Schreibgeschützt | Array von Feldern |
HasTableLayout | Boolescher Wert | Schreibgeschützt | Legt fest, ob der Feldbereich eine Tabelle ist. |
Beschriftung | Zeichenfolge | Schreibgeschützt | Name des benutzerdefinierten Feldes, Beschriftung |
FieldType | Zahl | Schreibgeschützt |
Feldtyp. Mögliche Werte: 4 – Feldgruppen |
Id | Zahl | Schreibgeschützt | Feld-ID |
IsReadOnly | Boolescher Wert | Schreibgeschützt | Zeigt, dass ein Feld nicht geändert werden kann |
IsVisible | Boolescher Wert | Schreibgeschützt | Zeigt an, ob ein Feld im Datenformular sichtbar ist. |
MaxRegions | Zahl | Schreibgeschützt | Maximale Anzahl der Feldbereiche. Beträgt der Wert -1 ist jede Anzahl von Bereichen erlaubt. |
Name | Zeichenfolge | Schreibgeschützt | Der vollständige Name des Feldes. |
NamePath | Zeichenfolge[] | Schreibgeschützt | Array von Feld- und Gruppennamen, die den Pfad zum Feld bilden. |
NeedRecognize | Boolean | Lesen/Schreiben | Zeigt an, ob der Wert eines Feldes aus einer Region extrahiert wird, wenn die Regeln erneut überprüft werden.. |
Regions | { Id: number; Status: number; PageId: Number; IsNew : Boolean; Coordinates: Object [{X1,X2,Y1,Y2}]; }[] |
Schreibgeschützt |
Bereichsarray, bei dem:
|
Bereichsfeld
Name | Typ | Zugriff | Beschreibung |
Fields | (Picture | Checkmark | Checkmark Groups | FieldsGroup | Table | TextField)[] | Schreibgeschützt | Array von Feldern |
Pageids | Zahl[] | Schreibgeschützt | Kennungen der Seiten, auf denen sich der Bereich befindet. |
IsFlexible | Boolescher Wert | Schreibgeschützt | Gibt an, ob der Bereich flexibel ist. |
Beschriftung | Zeichenfolge | Schreibgeschützt | Name des benutzerdefinierten Feldes, Beschriftung |
FieldType | Zahl | Schreibgeschützt |
Feldtyp. Mögliche Werte: 6 – Bereich |
Id | Zahl | Schreibgeschützt | Feld-ID |
IsReadOnly | Boolescher Wert | Schreibgeschützt | Zeigt, dass ein Feld nicht geändert werden kann. |
IsVisible | Boolescher Wert | Schreibgeschützt | Zeigt an, ob ein Feld im Datenformular sichtbar ist.. |
MaxRegions | Zahl | Schreibgeschützt | Maximale Anzahl der Feldbereiche. Beträgt der Wert -1 ist jede Anzahl von Bereichen erlaubt. |
Name | Zeichenfolge | Schreibgeschützt | Der vollständige Name des Feldes. |
NamePath | Zeichenfolge[] | Schreibgeschützt | Array von Feld- und Gruppennamen, die den Pfad zum Feld bilden. |
NeedRecognize | Boolean | Lesen/Schreiben | Zeigt an, ob der Wert eines Feldes aus einer Region extrahiert wird, wenn die Regeln erneut überprüft werden. |
Regions | { Id: number; Status: number; PageId: Number; IsNew : Boolean; Coordinates: Object [{X1,X2,Y1,Y2}]; }[] |
Schreibgeschützt |
Bereichsarray, bei dem:
|
Tabellenfeld
Name | Typ | Zugriff | Beschreibung |
Reihen | { Id: number; RowNumber: number; HasColorImage: boolean; TableBlockID: number[]; Cells: (Picture | Checkmark | CheckmarkGroup | TextField)[]; }[] |
Schreibgeschützt |
Die Liste von Tabellenzeilen Die Parameter der Objektzeile in der Tabelle:
|
Beschriftung | Zeichenfolge | Schreibgeschützt | Name des benutzerdefinierten Feldes, Beschriftung |
FieldType | Zahl | Schreibgeschützt |
Feldtyp. Mögliche Werte: 7 – Tabelle |
Id | Zahl | Schreibgeschützt | Feld-ID |
IsReadOnly | Boolescher Wert | Schreibgeschützt | Zeigt, dass ein Feld nicht geändert werden kann. |
IsVisible | Boolescher Wert | Schreibgeschützt | Zeigt an, ob ein Feld im Datenformular sichtbar ist. |
MaxRegions | Zahl | Schreibgeschützt | Gibt an, ob das Feld im Datenformular angezeigt wird -1, eine beliebige Anzahl von Bereichen ist erlaubt. |
Name | Zeichenfolge | Schreibgeschützt | Der vollständige Name des Feldes. |
NamePath | Zeichenfolge[] | Schreibgeschützt | Array von Feld- und Gruppennamen, die den Pfad zum Feld bilden. |
NeedRecognize | Boolescher Wert | Lesen/Schreiben | Zeigt an, ob der Wert eines Feldes aus einer Region extrahiert wird, wenn die Regeln erneut überprüft werden. |
Bereiche | { Id: number; Status: number; PageId: Number; IsNew : Boolean; Coordinates: Objekt [{X1,X2,Y1,Y2}]; }[] |
Schreibgeschützt |
Bereichsarray, bei dem:
|
Texteingabefeld
Name | Typ | Zugriff | Beschreibung |
Flags | Zahl[] | Lesen/Schreiben |
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. |
Suggests | Zeichenfolge[] | Schreibgeschützt | Die Liste vorgeschlagener Feldwerte |
Value | Zeichenfolge | Lesen/Schreiben | Feldwert |
TextType | Zahl | Schreibgeschützt |
Textfeldtyp. Möglicher Wert:
|
Beschriftung | Zeichenfolge | Schreibgeschützt | Name des benutzerdefinierten Feldes, Beschriftung |
FieldType | Zahl | Schreibgeschützt |
Feldtyp. Mögliche Werte: 0 – text field |
Id | Zahl | Schreibgeschützt | Feld-ID |
IsReadOnly | Boolescher Wert | Schreibgeschützt | Zeigt, dass ein Feld nicht geändert werden kann. |
IsVisible | Boolescher Wert | Schreibgeschützt | Zeigt an, ob ein Feld im Datenformular sichtbar ist. |
MaxRegions | Zahl | Schreibgeschützt | Gibt an, ob das Feld im Datenformular angezeigt wird -1, eine beliebige Anzahl von Bereichen ist erlaubt. |
Name | Zeichenfolge | Schreibgeschützt | Der vollständige Name des Feldes. |
NamePath | Zeichenfolge[] | Schreibgeschützt | Array von Feld- und Gruppennamen, die den Pfad zum Feld bilden. |
NeedRecognize | Boolescher Wert | Lesen/Schreiben | Zeigt an, ob der Wert eines Feldes aus einer Region extrahiert wird, wenn die Regeln erneut überprüft werden. |
Regions | { Id: number; Status: number; PageId: Number; IsNew : Boolean; Coordinates: Object [{X1,X2,Y1,Y2}]; }[] |
Schreibgeschützt |
Bereichsarray, bei dem:
|
IsVerified | Boolescher Wert | Lesen/Schreiben | Zeigt an, ob ein Feld überprüft wurde. |
NeedVerification | Boolescher Wert | Schreibgeschützt | Zeitg an, ob ein Feld eine Überprüfung erfordert. |
NeedDoubleVerification | Boolescher Wert | Schreibgeschützt | Zeigt an, ob ein Feld eine doppelte Überprüfung erfordert |
IsSummary | Boolescher Wert | Schreibgeschützt | Zeigt an, ob ein Feld für das Erstellen einer Zusammenfassung im Datenformular verwendet wird. |
Auswahlfeld
Name | Typ | Zugriff | Beschreibung |
Value | Boolescher Wert | Lesen/Schreiben | Feldwert. |
Beschriftung | Zeichenfolge | Schreibgeschützt | Name des benutzerdefinierten Feldes, Beschriftung |
FieldType | Zahl | Schreibgeschützt |
Feldtyp. Mögliche Werte: 2 – checkmark |
Id | Zahl | Schreibgeschützt | Feld-ID |
IsReadOnly | Boolescher Wert | Schreibgeschützt | Zeigt, dass ein Feld nicht geändert werden kann. |
IsVisible | Boolescher Wert | Schreibgeschützt | Zeigt an, ob ein Feld im Datenformular sichtbar ist. |
MaxRegions | Zahl | Schreibgeschützt | Gibt an, ob das Feld im Datenformular angezeigt wird -1, eine beliebige Anzahl von Bereichen ist erlaubt. |
Name | Zeichenfolge | Schreibgeschützt | Der vollständige Name des Feldes. |
NamePath | Zeichenfolge[] | Schreibgeschützt | Array von Feld- und Gruppennamen, die den Pfad zum Feld bilden. |
NeedRecognize | Boolescher Wert | Lesen/Schreiben | Zeigt an, ob der Wert eines Feldes aus einer Region extrahiert wird, wenn die Regeln erneut überprüft werden. |
Regions | { Id: number; Status: number; PageId: Number; IsNew : Boolean; Coordinates: Object [{X1,X2,Y1,Y2}]; }[] |
Schreibgeschützt |
Bereichsarray, bei dem:
|
IsVerified | Boolescher Wert | Lesen/Schreiben | Zeigt an, ob ein Feld überprüft wurde. |
NeedVerification | Boolescher Wert | Schreibgeschützt | Zeitg an, ob ein Feld eine Überprüfung erfordert. |
NeedDoubleVerification | Boolescher Wert | Schreibgeschützt | Zeigt an, ob ein Feld eine doppelte Überprüfung erfordert. |
IsSummary | Boolescher Wert | Schreibgeschützt | Zeigt an, ob ein Feld für das Erstellen einer Zusammenfassung im Datenformular verwendet wird. |
Auswahlgruppenfeld
Name | Typ | Zugriff | Beschreibung |
MaxSelectedCount | Zahl | Schreibgeschützt | Höchstanzahl ausgewählter Feldwerte. |
MinSelectedCount | Zahl | Schreibgeschützt | Mindestanzahl ausgewählter Feldwerte. |
Values | Zahl[] | Lesen/Schreiben | Feldwert. Ein Array von Datensatz-IDs, aus denen die Liste möglicher Feldwerte gebildet wird (Varianten). |
Variants | {Id:number, Name:string}[] | Schreibgeschützt |
Eine Liste möglicher Feldwerte:
|
Beschriftung | Zeichenfolge | Schreibgeschützt | Name des benutzerdefinierten Feldes, Beschriftung |
FieldType | Zahl | Schreibgeschützt |
Feldtyp. Mögliche Werte: 3 – checkmark group |
Id | Zahl | Schreibgeschützt | Feld-ID. |
IsReadOnly | Boolescher Wert | Schreibgeschützt | Zeigt, dass ein Feld nicht geändert werden kann. |
IsVisible | Boolescher Wert | Schreibgeschützt | Zeigt an, ob ein Feld im Datenformular sichtbar ist. |
MaxRegions | Zahl | Schreibgeschützt | Gibt an, ob das Feld im Datenformular angezeigt wird -1, eine beliebige Anzahl von Bereichen ist erlaubt. |
Name | Zeichenfolge | Schreibgeschützt | Der vollständige Name des Feldes. |
NamePath | Zeichenfolge[] | Schreibgeschützt | Array von Feld- und Gruppennamen, die den Pfad zum Feld bilden. |
NeedRecognize | Boolescher Wert | Lesen/Schreiben | Zeigt an, ob der Wert eines Feldes aus einer Region extrahiert wird, wenn die Regeln erneut überprüft werden. |
Regions | { Id: number; Status: number; PageId: Number; IsNew : Boolean; Coordinates: Object [{X1,X2,Y1,Y2}]; }[] |
Schreibgeschützt |
Bereichsarray, bei dem:
|
IsVerified | Boolescher Wert | Lesen/Schreiben | Zeigt an, ob ein Feld überprüft wurde. |
NeedVerification | Boolescher Wert | Schreibgeschützt | Zeitg an, ob ein Feld eine Überprüfung erfordert |
NeedDoubleVerification | Boolescher Wert | Schreibgeschützt | Zeigt an, ob ein Feld eine doppelte Überprüfung erfordert |
IsSummary | Boolescher Wert | Schreibgeschützt | Zeigt an, ob ein Feld für das Erstellen einer Zusammenfassung im Datenformular verwendet wird. |
Bildfeld
Name | Typ | Zugriff | Beschreibung |
Beschriftung | Zeichenfolge | Schreibgeschützt | Name des benutzerdefinierten Feldes, Beschriftung |
FieldType | Zahl | Schreibgeschützt |
Feldtyp. Mögliche Werte: 1 – Bild |
Id | Zahl | Schreibgeschützt | Feld-ID |
IsReadOnly | Boolescher Wert | Schreibgeschützt | Zeigt, dass ein Feld nicht geändert werden kann. |
IsVisible | Boolescher Wert | Schreibgeschützt | Zeigt an, ob ein Feld im Datenformular sichtbar ist |
MaxRegions | Zahl | Schreibgeschützt | Gibt an, ob das Feld im Datenformular angezeigt wird -1, eine beliebige Anzahl von Bereichen ist erlaubt. |
Name | Zeichenfolge | Schreibgeschützt | Der vollständige Name des Feldes. |
NamePath | Zeichenfolge[] | Schreibgeschützt | Array von Feld- und Gruppennamen, die den Pfad zum Feld bilden. |
Regions | { Id: number; Status: number; PageId: Number; IsNew : Boolean; Coordinates: Object [{X1,X2,Y1,Y2}]; }[] |
Schreibgeschützt |
Bereichsarray, bei dem:
|
Wiederkehrende Gruppe von Bereichsfeldern
Name | Typ | Zugriff | Beschreibung |
Id | Zahl | Schreibgeschützt | Feld-ID |
Name | Zeichenfolge | Schreibgeschützt | Feldname |
Bereiche | Bereich[] | Schreibgeschützt | Array von Feldern des Typs Bereich |
FieldType | Zahl | Schreibgeschützt |
Feldtyp. Mögliche Werte 8 – Sich wiederholende Bereichsgruppe |
Dokument-Objekteigenschaften
Name | Typ | Zugriff | Beschreibung |
AssemblingErrors | { DocumentNodeRef: number[][]; Description: string; SectionName: string[] }[] |
Schreibgeschützt |
Erstellungsfehler im Dokument, wobei:
|
BatchId | Zahl | Schreibgeschützt | Paket-ID |
Fehler | { DocumentNodeRef: number[][]; Severity: number; Message: string; RuleName: string; }[] |
Schreibgeschützt |
Dokumentfehler, wobei:
|
Felder | (Section | SectionsGroup)[] | Schreibgeschützt | Liste von Bereichen/doppelten Bereichen |
Id | Zahl | Schreibgeschützt | Dokument-ID |
Index | Zahl | Schreibgeschützt | Der Index des Dokuments im Paket |
Seiten | { Id: number; Modification: number; HasColorImage: boolean; ImageResolution: number; KeyValue: string; SectionTemplateId: number; SectionTemplateName: string; FlexibleInstanceId: number; SectionTemplatePageNumber: number; Comment: string; ImageWidth: number; ImageHeight: number; }[] |
Schreibgeschützt |
Eine Liste von Dokumentseiten, wobei:
|
ProjectId | Zahl | Schreibgeschützt | Projekt-ID |
TaskId | Zahl | Schreibgeschützt | Task-ID |
TemplateId | Zahl | Schreibgeschützt | Ungültige Definitions-ID. |
TemplateName | Zeichenfolge | Schreibgeschützt | Dokumentdefinitionsname |
TemplateVersion | Zahl | Schreibgeschützt | Version der Dokumentdefinition |
Version | Zahl | Schreibgeschützt | Dokumentversion |
12.04.2024 18:16:01