Beschreibung
Methoden
AddFileToExportResults( sourceFile : string, destinationName : string, replaceIfExists : bool ) * | Fügt eine Benutzerdatei zu den Exportergebnissen des Dokuments hinzu. Geben Sie im Parameter sourceFile den Pfad der hinzuzufügenden Benutzerdatei an. Hinweis: Geben Sie in den Projekteinstellungen unbedingt den Stamm-Exportpfad an. Andernfalls wird die Benutzerdatei im Batch-Ordner im Dateispeicher abgelegt. Geben Sie im Parameter destinationName ein Exportziel an. Setzen Sie den Parameter replaceIfExists auf true, wenn Sie eine vorhandene Datei mit demselben Namen im Ziel überschreiben möchten. Setzen Sie den Parameter replaceIfExists auf false, wenn Sie eine vorhandene Datei mit demselben Namen im Ziel beibehalten und eine Fehlermeldung im Log protokollieren möchten. |
CheckRules( ) * | Prüft alle Regeln im Dokument. Für das Dokument sind Schreibrechte erforderlich. |
Ermöglicht den Zugriff auf ein Dokumentfeld über dessen vollständigen Pfad. Dabei werden vollständige Pfade verwendet. Dies ist ein internes** Feld. Es kann nicht in Regeln verwendet werden. | |
HasField( name : string ) : bool * | Prüft, ob ein Feld mit dem angegebenen Pfad existiert. 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 Pfads zum Feld ab. Für externe Felder von Dokumenten und Seiten verfügbar. Es können sowohl ein Feldname als auch ein vollständiger Pfad zum Feld verwendet werden. Nicht in Regeln verwendbar. |
IndexedItemValues( name : string ) : IVARIANTArray * | Ruft eine Menge von Indexwerten für ein Feld in der Dokumentdefinition anhand des Namens oder des Pfads zum Feld ab. Wenn ein Feld im wiederkehrenden Abschnitt als Indexfeld markiert ist, gibt die Methode alle Werte des Felds aus allen Abschnitten zurück. Verfügbar in externen Feldern 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 anhand ihres Namens den Wert einer angegebenen Eigenschaft ab. Der zurückgegebene Wert kann eine Zeichenfolge, eine Zahl oder eine Zeitangabe sein. Eigenschaftsnamen und zurückgegebene Werte:
|
SaveAs( filename : string, [optional] options : IExportImageSavingOptions ) * | Speichert das Bild eines ein- oder mehrseitigen Dokuments. Wenn in den Speicheroptionen kein Dateiformat angegeben ist, wird das Bild in einer *.tif-Datei gespeichert. Dies ist ein internes ** Feld. |
SaveAsStream( [optional] options: IExportImageSavingOptions) : byte[] * | Speichert das Dokument in einem Speicherstream und gibt es als Byte-Array (COM SafeArray) zurück. Hinweis: JScript und VBScript unterstützen das Iterieren über dieses Array nicht. |
SaveXmlToFile( filename : string ) * | Speichert die XML-Datei mit der Beschreibung des Dokuments ohne Vorverarbeitung unter dem angegebenen Pfad, damit sie in der Web-Verifizierungsstation verwendet werden kann. |
SaveXmlToFileStorage() * | Speichert die XML-Datei mit der Beschreibung des Dokuments ohne Vorverarbeitung im Dateispeicher, damit sie in der Web-Verifizierungsstation verwendet werden kann. |
Eigenschaften
Aktion * | Schreibgeschützt | Nur in Export- und Post-Export-Skripten wirksam. | |
AsBatchItem * | Schreibgeschützt | Wandelt das Dokument in ein IBatchItem-Objekt um. | |
AssemblingErrors | Schreibgeschützt | Eine Sammlung von Fehlern bei der Zusammenstellung. Auf die Sammlung besteht immer nur Lesezugriff. | |
Anhänge | Schreibgeschützt | Benutzeranhänge | |
Batch | 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 zugänglich. | |
BatchName | string | Schreibgeschützt | Der Batch-Name. |
Untergeordnete Felder * | 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; die einzelnen Instanzen sind über die Methode Items dieses Elements verfügbar. Ist ein internes** Feld. Kann nicht in Regeln verwendet werden. | |
Kommentar | string | Lesen/Schreiben | Ein Kommentar zum Dokument. |
DefinitionName | string | Schreibgeschützt | Der Name der Dokumentdefinition. Bei nicht verarbeiteten und nicht erkannten Dokumenten gibt die Eigenschaft eine leere Zeichenfolge zurück. |
DocumentDefinition | Schreibgeschützt | Detaillierte Informationen zur Dokumentdefinition, die für das Dokument erkannt wurde. | |
HasErrors | bool | Schreibgeschützt | Gibt an, ob das Dokument Fehler in einzelnen oder mehreren Feldern aufweist. |
HasUnpreparedImages | bool | Schreibgeschützt | Gibt an, ob das Dokument Seiten enthält, die nicht vorverarbeitet wurden. |
HasWarnings | bool | Schreibgeschützt | Gibt an, ob das Dokument regel- oder formatbezogene Warnungen aufweist. |
ID | string | Schreibgeschützt | Dokumentbezeichner (externe ID). Der Wert beginnt mit 1 und ist nur innerhalb eines Batchs eindeutig. |
Index | int | Schreibgeschützt | Der Index des Dokuments im Batch. Der Wert beginnt mit 0 und ist nur innerhalb eines Tasks 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 zusammengesetzt wurde. |
IsExcludedFromAutomaticAssembling | bool | Lesen/Schreiben | Gibt an, ob das Dokument in die automatische Assemblierung einbezogen wird. |
IsExported | bool | Schreibgeschützt | Gibt an, ob das Dokument exportiert ist. |
IsRecognized | bool | Schreibgeschützt | Gibt an, ob das Dokument erkannt wurde. Ein Dokument gilt als erkannt, wenn jede Seite des Dokuments entweder erkannt wurde oder eine Anhangseite ist. |
IsUsedForTraining | bool | Lese-/Schreibzugriff | Gibt an, ob das Dokument für das Training verwendet wird. |
IsVerified | bool | Schreibgeschützt | Gibt an, ob das Dokument verifiziert wurde. |
Pages | Schreibgeschützt | Dokumentseiten. | |
PreviousStageInfo * | Schreibgeschützt | Gibt das IStageInfo-Objekt zurück, also die Verarbeitungsstufe des Dokuments. Die Felder TaskId und PrincipalId werden nicht verwendet. | |
Priorität | Schreibgeschützt | Die Priorität des Dokuments. | |
ProcessingErrors * | string | Schreibgeschützt | Durch Zeilenumbrüche getrennte Verarbeitungsfehler. |
ProcessingWarnings * | string | Schreibgeschützt | Durch Zeilenumbrüche getrennte Verarbeitungswarnungen. |
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”; das bedeutet, dass die Aufgabe für alle Benutzer verfügbar ist. |
Eigenschaften | Schreibgeschützt | Registrierungsparameter des Dokuments. | |
RecognizedSymbolsCount * | int | Schreibgeschützt | Die Anzahl der erkannten Zeichen. |
RuleErrors * | Schreibgeschützt | Eine Sammlung von Dokumentfehlern (Formatfehler, Regelfehler, Fehler beim Zusammenführen der Ergebnisse der Doppelverifizierung). Hinweis: Nur für geöffnete Dokumente verfügbar. | |
Abschnitte * | Schreibgeschützt | Eine flache Liste von Dokumentabschnitten. Wenn es einen wiederkehrenden Abschnitt gibt, enthält die Liste alle Vorkommen dieses Abschnitts. Die Abschnitte in der Liste folgen derselben Reihenfolge wie die ersten Seiten der Dokumentabschnitte. Abschnitte ohne Seiten stehen am Ende der Liste. Ist ein internes** Feld. Kann nicht in Regeln verwendet werden. | |
StageInfo | Schreibgeschützt | Informationen zur Verarbeitungsstufe auf dem Application Server. | |
SymbolsForVerificationCount | int | Schreibgeschützt | Die Anzahl der Zeichen, die verifiziert werden müssen. |
TotalSymbolsCount | int | Schreibgeschützt | Die Gesamtzahl der Symbole. |
UncertainSymbolsCount | int | Schreibgeschützt | Die Anzahl der unsicheren Symbole. |