IDocument - ABBYY Documentation

Repräsentiert ein Dokument.

Einige Methoden und Eigenschaften dieses Objekts stehen auf der Web-Verifizierungsstation für die lokale Prüfung von Regeln nicht zur Verfügung. Die nicht unterstützten Methoden und Eigenschaften sind mit einem Sternchen (*) gekennzeichnet.

Methoden

Methode	Beschreibung
`AddFileToExportResults( sourceFile : string, destinationName : string, replaceIfExists : bool )` *	Fügt den Dokumentexportergebnissen eine Benutzerdatei hinzu. Geben Sie im Parameter `sourceFile` den Pfad der hinzuzufügenden Benutzerdatei an. Geben Sie in den Projekteinstellungen unbedingt den Stammexportpfad an. Andernfalls wird die Benutzerdatei im Batch-Ordner am Dateispeicherort abgelegt. Geben Sie im Parameter `destinationName` ein Exportziel an. Setzen Sie den Parameter `replaceIfExists` auf `true`, um eine vorhandene Datei mit demselben Namen am Ziel zu überschreiben. Setzen Sie ihn auf `false`, um die vorhandene Datei mit demselben Namen beizubehalten und eine Fehlermeldung zum Protokoll hinzuzufügen.
`CheckRules( )` *	Überprüft alle Regeln im Dokument. Schreibberechtigungen für das Dokument sind erforderlich.
`Field( name : string ) : IField` *	Ermöglicht den Zugriff auf ein Dokumentfeld über den vollständigen Pfad zum Feld. Es werden vollständige Pfade verwendet. Dies ist ein internes Feld, das das Laden des Objekts in den Speicher erfordert. Kann nicht in Regeln verwendet werden.
`HasField( name : string ) : bool` *	Prüft, ob ein Feld mit dem angegebenen Pfad vorhanden ist. Es werden relative Pfade verwendet. Dies ist ein internes Feld, das das Laden des Objekts in den Speicher erfordert. Kann nicht in Regeln verwendet werden.
`IndexedItemValue( name : string ) : VARIANT` *	Ruft den Feldwert anhand des Namens oder des Pfads zum Feld ab. Verfügbar über externe Felder von Dokumenten und Seiten. Es können sowohl ein Feldname als auch ein vollständiger Pfad zum Feld verwendet werden. Kann nicht in Regeln verwendet werden.
`IndexedItemValues( name : string ) : IVARIANTArray` *	Ruft anhand des Namens oder des Pfads zum Feld eine Gruppe von Indexwerten ab, die einem Feld in der Document Definition entsprechen. Wenn ein Feld in einem wiederkehrenden Abschnitt als Indexfeld markiert ist, gibt die Methode alle Werte des Felds aus allen Abschnitten zurück. Verfügbar über externe Felder von Dokumenten und Seiten. Es können sowohl ein Feldname als auch ein vollständiger Pfad zum Feld verwendet werden. Kann nicht in Regeln verwendet werden.
`Property( name : string ) : VARIANT`	Ruft den Wert einer angegebenen Eigenschaft anhand ihres Namens ab. Der zurückgegebene Wert kann ein string, eine Zahl oder eine Zeitangabe sein. Eine Liste der Eigenschaftsnamen finden Sie unter Dokumenteigenschaftsnamen.
`SaveAs( filename : string, [optional] options : IExportImageSavingOptions )` *	Speichert das Bild eines einseitigen oder mehrseitigen Dokuments. Wenn in den Speicheroptionen kein Speicherformat angegeben ist, wird das Bild als `*.tif`-Datei gespeichert. Dies ist ein internes Feld, das das Laden des Objekts in den Speicher erfordert.
`SaveAsStream( [optional] options : IExportImageSavingOptions ) : byte[]` *	Speichert das Dokument in einem Speicherstream und gibt es als Byte-Array (COM SafeArray) zurück. JScript und VBScript unterstützen keine Iteration über dieses Array.
`SaveXmlToFile( filename : string )` *	Speichert die XML-Datei mit der Beschreibung des Dokuments ohne Vorverarbeitung am angegebenen Speicherort zur Verwendung in der Web-Verifizierungsstation.
`SaveXmlToFileStorage( )` *	Speichert die XML-Datei mit der Beschreibung des Dokuments ohne Vorverarbeitung im Dateispeicher zur Verwendung in der Web-Verifizierungsstation.

Die Methode Property sollte nicht mit der Sammlung Properties verwechselt werden, die benutzerdefinierte Dokumenteigenschaften enthält.

Eigenschaften

Name	Typ	Zugriff	Beschreibung
Action *	IActionResult	Schreibgeschützt	Nur in Export- und Post-Export-Skripten 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 ist immer schreibgeschützt.
Attachments	IUserAttachments	Schreibgeschützt	Benutzeranhänge.
Batch	IBatch	Schreibgeschützt	Der Batch. Unabhängig von den Berechtigungen des Skripts für das Dokument ist der Zugriff auf den Batch schreibgeschützt, und interne Felder von Dokumenten und Seiten sind nicht verfügbar.
BatchName	string	Schreibgeschützt	Der Name des Batches.
Children *	IFields	Schreibgeschützt	Untergeordnete Felder (Dokumentabschnitte). Im Gegensatz zur Eigenschaft `Sections` entspricht die Reihenfolge der Abschnitte ihrer Reihenfolge in der Document Definition. Wiederkehrende Abschnitte werden als ein Element dargestellt; ihre Instanzen sind über die Methode `Items` dieses Elements verfügbar. Dies ist ein internes Feld, für das das Objekt in den Speicher geladen werden muss. Kann nicht in Regeln verwendet werden.
Comment	string	Lesen/Schreiben	Ein Kommentar zum Dokument.
DefinitionName	string	Schreibgeschützt	Der Name der Document Definition. Bei unverarbeiteten und nicht erkannten Dokumenten gibt die Eigenschaft eine leere Zeichenfolge zurück.
DocumentDefinition	IDocumentDefinitionInfo	Schreibgeschützt	Detaillierte Informationen über die dem Dokument zugeordnete Document Definition.
HasErrors	bool	Schreibgeschützt	Gibt an, ob das Dokument Einzelfeld- oder Mehrfeldfehler aufweist.
HasUnpreparedImages	bool	Schreibgeschützt	Gibt an, ob das Dokument nicht vorverarbeitete Seiten enthält.
HasWarnings	bool	Schreibgeschützt	Gibt an, ob das Dokument Regel- oder Formatwarnungen aufweist.
Id	string	Schreibgeschützt	Dokumentbezeichner (External Id). Der Wert beginnt bei 1 und ist nur innerhalb eines Batches eindeutig.
Index	int	Schreibgeschützt	Der Index des Dokuments im Batch. Der Wert beginnt bei 0 und ist nur innerhalb einer Aufgabe eindeutig.
IsAnalyzed	bool	Schreibgeschützt	Gibt an, ob das Dokument analysiert wurde. Ein Dokument gilt als analysiert, wenn alle seine Seiten analysiert wurden.
IsAssembled	bool	Schreibgeschützt	Gibt an, ob das Dokument zusammengestellt wurde.
IsExcludedFromAutomaticAssembling	bool	Lesen/Schreiben	Gibt an, ob das Dokument in die automatische Zusammenstellung einbezogen wird.
IsExported	bool	Schreibgeschützt	Gibt an, ob das Dokument exportiert wurde.
IsRecognized	bool	Schreibgeschützt	Gibt an, ob das Dokument erkannt wurde. Ein Dokument gilt als erkannt, wenn jede seiner Seiten entweder erkannt wurde oder eine Anhangseite ist.
IsUsedForTraining	bool	Lesen/Schreiben	Gibt an, ob das Dokument für das Training verwendet wird.
IsVerified	bool	Schreibgeschützt	Gibt an, ob das Dokument verifiziert wurde.
Pages	IPages	Schreibgeschützt	Dokumentseiten.
PreviousStageInfo *	IStageInfo	Schreibgeschützt	Gibt das Objekt IStageInfo, also die Verarbeitungsstufe des Dokuments, zurück. Die Felder `TaskId` und `PrincipalId` werden nicht verwendet.
Priority	TProcessingPriority	Schreibgeschützt	Die Priorität des Dokuments.
ProcessingErrors *	string	Schreibgeschützt	Verarbeitungsfehler, getrennt durch Zeilenumbrüche.
ProcessingWarnings *	string	Schreibgeschützt	Verarbeitungswarnungen, getrennt durch Zeilenumbrüche.
ProhibitedUserId *	int	Schreibgeschützt	Eine aus dem Dokument erstellte Aufgabe ist für den Benutzer mit dem angegebenen Bezeichner nicht verfügbar. Standardmäßig ist der Wert `0`, sodass die Aufgabe für alle Benutzer verfügbar ist.
Properties	IProperties	Schreibgeschützt	Registrierungsparameter des Dokuments.
RecognizedSymbolsCount *	int	Schreibgeschützt	Die Anzahl der erkannten Symbole.
RuleErrors *	IRuleErrors	Schreibgeschützt	Eine Sammlung von Dokumentfehlern (Formatfehler, Regelfehler, Fehler beim Zusammenführen der Ergebnisse der doppelten Verifizierung). Nur für geöffnete Dokumente verfügbar.
Sections *	IFields	Schreibgeschützt	Eine flache Liste von Dokumentabschnitten. Bei einem wiederkehrenden Abschnitt enthält die Liste alle Wiederholungen dieses Abschnitts. Die Abschnitte in der Liste sind in derselben Reihenfolge angeordnet wie die ersten Seiten der Dokumentabschnitte. Abschnitte ohne Seiten bilden das Ende der Liste. Dies ist ein internes Feld, für das das Objekt in den Speicher geladen werden muss. Es kann nicht in Regeln verwendet werden.
StageInfo	IStageInfo	Schreibgeschützt	Informationen über die Verarbeitungsstufe auf dem Application Server.
SymbolsForVerificationCount	int	Schreibgeschützt	Die Anzahl der Symbole, die verifiziert werden müssen.
TotalSymbolsCount	int	Schreibgeschützt	Die Gesamtzahl der Symbole.
UncertainSymbolsCount	int	Schreibgeschützt	Die Anzahl der unsicheren Symbole.

Namen von Document-Eigenschaften

Die Methode Property ruft Werte für die folgenden Eigenschaftsnamen ab:

Name	Zurückgegebener Wert
`Exported`	Zeitpunkt des Dokumentexports
`ExportedBy`	Person, die das Dokument exportiert hat
`Created`	Zeitpunkt der Dokumenterstellung
`CreatedBy`	Person, die das Dokument erstellt hat
`Recognized`	Zeitpunkt der Dokumenterkennung
`RecognizedBy`	Person, die das Dokument erkannt hat
`Modified`	Zeitpunkt der letzten Änderung des Dokuments
`ModifiedBy`	Person, die das Dokument geändert hat
`TotalSymbolsCount`	Gesamtzahl der Symbole
`UncertainSymbolsCount`	Gesamtzahl der unsicheren Symbole
`RecognizedSymbolsCount`	Anzahl der erkannten Symbole
`Comment`	Kommentar zum Dokument
`ProcessingErrors`	Fehler bei der Dokumentverarbeitung
`ProcessingWarnings`	Warnungen bei der Dokumentverarbeitung
`Verified`	Zeitpunkt der letzten manuellen Bearbeitung der Dokumentfelder
`VerifiedBy`	Benutzer, der die letzten manuellen Änderungen an den Dokumentfeldern vorgenommen hat (speichert keine Informationen von Processing Stations)