IDocument

Worum geht es

Repräsentiert das Dokument.

Hinweis. Einige Methoden und Eigenschaften dieses Objekts sind auf der Web-Überprüfungsstation zum lokalen Überprüfen von Regeln nicht verfügbar. Nicht unterstützte Methoden und Eigenschaften sind mit einem Stern (*) markiert.

Methoden

Definition Beschreibung
AddFileToExportResults( sourceFile : string, destinationName : string, replaceIfExists : bool ) *

Fügt den Exportergebnissen eines Dokuments eine Benutzerdatei hinzu.

Geben Sie im Parameter sourceFile die Adresse der Benutzerdatei an, die hinzugefügt werden soll.

Hinweis. Der Exportstammpfad muss unbedingt in den Projekteinstellungen angegeben werden. Die Benutzerdatei wird sonst im Stapelordner im Dateispeicherort abgelegt.

Geben Sie im Parameter destinationName ein Exportziel an.

Legen Sie den Parameter replaceIfExists auf true fest, wenn vorhandene Dateien mit demselben Namen im Ziel überschrieben werden sollen. Legen Sie den Parameter replaceIfExists auf false fest, wenn vorhandene Dateien mit demselben Namen im Ziel beibehalten werden sollen und um dem Protokoll eine Fehlermeldung hinzuzufügen.

CheckRules( ) * Überprüft alle Regeln im Dokument. Es sind Schreibrechte für das Dokument erforderlich.
Field( name : string ) : IField *

Eröffnet Zugriff auf ein Dokumentenfeld durch den vollständigen Pfad zu dem Feld. Es werden Vollständige Pfade verwendet.

Ist ein internes** Feld. Kann nicht in Regeln verwendet werden.

HasField( name : string ) : bool *

Überprüft, ob ein Feld mit dem angegebenen Pfad vorhanden ist. Es werden Relative Pfade verwendet.

Ist ein internes** Feld. Kann nicht in Regeln verwendet werden.

IndexedItemValue( name : string ) : VARIANT * Ruft den Feldwert anhand des Namens oder des Pfades zu dem Feld ab. Verfügbar von externen Feldern von Dokumenten und Seiten aus. Sowohl ein Feldname als auch der vollständige Pfad zu dem Feld können verwendet werden. Kann nicht in Regeln verwendet werden.
IndexedItemValues( name : string ) : IVARIANTArray * Ruft einen Satz von Indexwerten korrespondierend zu einem Feld in der Dokumentdefinition nach Name oder Pfad des Feldes ab. Wurde ein Feld in den mehrfach vorkommenden Bereichen als Indexfeld markiert, gibt die Methode alle Werte des Feldes aus allen Bereichen zurück. Verfügbar von externen Feldern von Dokumenten und Seiten aus. Sowohl ein Feldname als auch der vollständige Pfad zu dem Feld können verwendet werden. Kann nicht in Regeln verwendet werden.
Property( name : string ) : VARIANT

Ruft den Wert einer vorgegebenen Eigenschaft nach ihrem Namen ab. Der zurückgegebene Wert kann die Form einer Zeichenfolge, einer Zahl oder Uhrzeit haben.

Namen der Eigenschaften und zurückgegebene Werte:

  • Exported - wann das Dokument exportiert wurde
  • ExportedBy - wer das Dokument exportiert hat
  • Created - wann das Dokument erstellt wurde
  • CreatedBy - wer das Dokument erstellt hat
  • Recognized - wann das Dokument erkannt wurde
  • RecognizedBy - wer das Dokument erkannt hat
  • Modified - wann das Dokument zuletzt bearbeitet wurde
  • ModifiedBy - wer das Dokument bearbeitet hat
  • TotalSymbolsCount - die Gesamtanzahl der Symbole
  • UncertainSymbolsCount - die Gesamtanzahl nicht eindeutiger Symbole
  • RecognizedSymbolsCount - die Anzahl erkannter Symbole
  • Comment - der Kommentar zum Dokument
  • ProcessingErrors - die Dokumentverarbeitungsfehler
  • ProcessingWarnings - die Warnungen der Dokumentverarbeitung
  • Überprüft – die Uhrzeit, zu der die Felder des Dokuments das letzte Mal manuell bearbeitet wurden
  • Überprüft von – der Benutzer, der die letzten manuellen Änderungen an den Feldern des Dokuments vorgenommen hat (speichert keine Informationen aus den Verarbeitungsstationen)
SaveAs( filename : string, [optional] options : IExportImageSavingOptions ) * Speichert das Bild eines ein- oder mehrseitigen Dokuments. Wurde in den Speicheroptionen kein Speicherformat angegeben, wird das Bild in einer *.tif-Datei gespeichert. Dies ist ein internes** Feld.
SaveAsStream( [optional] options: IExportImageSavingOptions) : byte[] *

Speichert das Dokument in einen Speicherstream und gibt es als Byte-Array (COM SafeArray) zurück.

Hinweis. JScript und VBScript unterstützen die Iteration über diesen Array nicht.

SaveXmlToFile( filename : string ) * Speichert die XML-Datei mit der Beschreibung des Dokuments ohne Vorverarbeitung an dem angegebenen Speicherort, der in der Web-Überprüfungsstation verwendet werden soll.
SaveXmlToFileStorage() * Speichert die XML-Datei mit der Beschreibung des Dokuments ohne Vorverarbeitung in der angegebenen Dateiablage, die in der Web-Überprüfungsstation verwendet werden soll.

Wichtig! Die Methode Property sollte nicht verwechselt werden mit der Sammlung Properties die vom Benutzer angegebene Dokumenteigenschaften enthält.

Eigenschaften

Name Typ Zugriff Beschreibung
Action * IActionResult Schreibgeschützt Ist nur in Export- und Nach-Exportskripten wirksam.
AsBatchItem * IBatchItem Schreibgeschützt Konvertiert das Dokument in ein IBatchItem-Objekt.
AssemblingErrors IAssemblingErrors Schreibgeschützt Eine Sammlung von Zusammenstellungsfehlern. Der Zugriff auf die Sammlung erfolgt immer nur lesend.
Attachments IUserAttachments Schreibgeschützt Benutzeranhänge
Batch IBatch Schreibgeschützt Der Stapel. Unabhängig von den Berechtigungen des Skripts für das Dokument ist der Zugriff auf den Stapel nur lesend, und interne** Felder von Dokumenten und Seiten sind nicht verfügbar.
BatchName string Schreibgeschützt Der Stapelname..
Children * IFields Schreibgeschützt

Untergeordnete Felder (Dokumentbereiche). Anders als bei der Eigenschaft Sections entspricht die Bereichsreihenfolge der Reihenfolge in der Dokumentdefinition. Die mehrfach vorkommenden Bereiche werden als ein Objekt angezeigt und die Instanzen sind über die Methode Items dieses Objekts verfügbar.

Ist ein internes** Feld. Kann nicht in Regeln verwendet werden.

Comment string Lesen/Schreiben Ein Kommentar des Dokuments.
DefinitionName string Schreibgeschützt Der Name der Dokumentdefinition.
DocumentDefinition IDocumentDefinitionInfo Schreibgeschützt

Detaillierte Informationen über die Dokumentdefinition, die dem Dokument zugeordnet ist.

Für nicht verarbeitete und nicht erkannte Dokumente gibt die Eigenschaft eine leere Zeichenfolge zurück.

HasErrors bool Schreibgeschützt Bestimmt, ob das Dokument Einzelfeld- oder Feldübergreifenderfehler enthält.
HasUnpreparedImages bool Schreibgeschützt Bestimmt, ob das Dokument nicht vorverarbeitete Seiten enthält.
HasWarnings bool Schreibgeschützt Bestimmt, ob das Dokument Regel- oder Formatwarnungen enthält.
Id string Schreibgeschützt Dokumentkennung (externe ID). Der Wert beginnt mit 1 und ist nur innerhalb eines Stapels eindeutig.
Index int Schreibgeschützt Der Index des Dokuments im Stapel. Der Wert beginnt mit 0 und ist nur innerhalb eines Tasks eindeutig.
IsAnalyzed bool Schreibgeschützt Bestimmt, ob das Dokument analysiert ist. Das Dokument wird als analysiert angesehen, wenn alle Seiten des Dokuments analysiert werden.
IsAssembled bool Schreibgeschützt Bestimmt, ob das Dokument zusammengestellt ist.
IsExcludedFromAutomaticAssembling bool Lesen/Schreiben Überprüft, ob das Dokument in die automatische Zusammenstellung eingeschlossen ist.
IsExported bool Schreibgeschützt Bestimmt, ob das Dokument exportiert ist.
IsRecognized bool Schreibgeschützt Bestimmt, ob das Dokument erkannt ist. Das Dokument wird als erkannt angesehen, wenn entweder jede Seite des Dokuments erkannt wurde oder wenn es sich um eine Anhangseite handelt..
IsUsedForTraining bool Lesen/Schreiben Gibt an, ob das Dokument für das Training verwendet wird.
IsVerified bool Schreibgeschützt Bestimmt, ob das Dokument überprüft ist..
Pages IPages Schreibgeschützt Dokumentseiten.
PreviousStageInfo * IStageInfo Schreibgeschützt Gibt das Objekt IStageInfo zurück, d. h. die Verarbeitungsphase des Dokuments. Die Felder TaskId und PrincipalId werden nicht verwendet.
Priority TProcessingPriority Schreibgeschützt Eine Priorität des Dokuments.
ProcessingErrors * string Schreibgeschützt Verarbeitungsfehler, unterteilt durch Zeilenumbrüche.
ProcessingWarnings * string Schreibgeschützt Verarbeitungswarnungen, unterteilt durch Zeilenumbrüche.
ProhibitedUserId * int Schreibgeschützt Ein aus dem Dokument erstellter Task steht für den Benutzer mit der vorgegebenen Kennung nicht zur Verfügung. Standardmäßig lautet der Wert "0", was bedeutet, dass der Task für alle Benutzer verfügbar ist.
Properties IProperties Schreibgeschützt Registrierungsparameter des Dokuments.
RecognizedSymbolsCount * int Schreibgeschützt Die Anzahl erkannter Symbole.
RuleErrors * IRuleErrors Schreibgeschützt

Eine Sammlung von Dokumentfehlern (Formatfehler, Regelfehler, Fehler bei der Zusammenführung von Ergebnissen der Doppelüberprüfung).

Hinweis. Nur verfügbar für offene Dokumente.

Sections * IFields Schreibgeschützt

Eine einfache Liste der Dokumentbereiche. Sind mehrfach vorkommende Bereiche vorhanden, enthält die Liste alle Wiederholungen des Bereichs. Die Bereiche in der Liste werden in der gleichen Reihenfolge angeordnet wie die ersten Seiten der Dokumentbereiche. Bereiche ohne Seiten schließen die Liste.

Ist ein internes** Feld. Kann nicht in Regeln verwendet werden.

StageInfo IStageInfo Schreibgeschützt Information über die Verarbeitungsphase auf dem Anwendungsserver.
SymbolsForVerificationCount int Schreibgeschützt Die Anzahl der Symbole, die eine Überprüfung benötigen.
TotalSymbolsCount int Schreibgeschützt Die Gesamtanzahl der Symbole.
UncertainSymbolsCount int Schreibgeschützt Die Anzahl nicht eindeutiger Symbole.

** - Das interne Feld erfordert das Laden des Objekts in den Speicher.

10.11.2020 12:08:03


Please leave your feedback about this article