IPage - ABBYY Documentation

Stellt eine Seite dar.

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
`ApplyImageEnhancementProfile( name : string )` *	Wendet das angegebene Bildverbesserungsprofil auf ein Bild an. Wenn beim Anwenden eines Profils neue Seiten erstellt werden, werden diese im Dokument nach der aktuellen Seite eingefügt. Ein Beispiel finden Sie unter Bildverbesserungsprofil auf Fotos anwenden.
`MarkAsAnnex( )` *	Kennzeichnet die Seite als Anhang, der keine Erkennung erfordert.
`ReplaceImage( newPicture : IPictureObject )` *	Ersetzt das Seitenbild durch ein neues Bild. Das neue Bild lässt sich auf drei Arten erstellen. Bearbeiten Sie ein anderes IPictureObject-Objekt oder laden Sie es mithilfe der Methode `LoadImage` von FCTools aus einer Datei. Die dritte Möglichkeit besteht darin, es mithilfe der Methode `PictureFromHBitmap` von FCTools aus einer im Speicher befindlichen Bitmap zu erzeugen, z. B. einem .NET `System.Drawing.Image`.
`RevertToOriginalImage( )` *	Stellt das Originalseitenbild wieder her. Diese Methode kann nur aufgerufen werden, wenn die Eigenschaft `HasOriginalImage` auf `true` gesetzt ist. Ein Beispiel finden Sie unter Originalseitenbild wiederherstellen.
`SaveAs( filename : string, [optional] options : IExportImageSavingOptions )` *	Speichert das Seitenbild gemäß den Speicheroptionen. Wenn keine Optionen angegeben sind, wird das Bild als `*.tif` gespeichert. Dies ist ein internes Feld, für das das Objekt in den Speicher geladen werden muss.
`SaveSourceFile( )` *	Speichert die Quelldatei, aus der das Seitenbild stammt, in der angegebenen Datei. Diese Methode kann nur aufgerufen werden, wenn die Quelldatei gespeichert wurde. Mithilfe der Eigenschaft `SourceFileGUID` können Sie überprüfen, ob die Quelldatei gespeichert wurde. Weitere Informationen finden Sie unter Beispielskripte zum Export.
`SaveXmlTextToFile( filename : string )` *	Speichert den gesamten Text auf der Seite als XML-Datei im angegebenen Ordner.
`SaveXmlTextToFileStorage( )` *	Speichert den gesamten Text auf der Seite als XML-Datei im Batch-Ordner im Dateispeicher.

Eigenschaften

Name	Typ	Zugriff	Beschreibung
AsBatchItem *	IBatchItem	Schreibgeschützt	Konvertiert die Seite in ein IBatchItem-Objekt.
Anhänge *	IUserAttachments	Schreibgeschützt	Benutzeranhänge.
Kommentar *	string	Schreibgeschützt	Die Seitenbeschreibung.
Dokument *	IDocument	Schreibgeschützt	Das Dokument, das die Seite enthält.
ExcludedFromDocumentImage *	bool	Lesen/Schreiben, veränderbar (kann auch in Skripten mit Berechtigungen nur zum Lesen geändert werden)	Gilt beim Export des Dokumentbilds. Gibt an, dass das aktuelle Seitenbild beim Export des gesamten Dokuments nicht exportiert werden soll. Dies ist ein internes Feld, für das das Objekt in den Speicher geladen werden muss.
FullText *	string	Schreibgeschützt	Der auf der Seite erkannte Text.
FullTextCharRects *	IRects	Schreibgeschützt	Rechtecke der Zeichen in `FullText`.
HasOriginalImage *	bool	Schreibgeschützt	Gibt an, ob das Bild der Originalseite verfügbar ist.
Id	string	Schreibgeschützt	Der Seitenbezeichner.
ImageSource *	string	Schreibgeschützt	Die Quelle eines Bildes. Wenn das Bild aus einer Datei importiert wurde, enthält diese Eigenschaft den Dateipfad. Wurde das Bild von einem Scanner empfangen, enthält `ImageSource` den Namen der Quelle. Bei einem Import über einen benutzerdefinierten Import ist der Wert leer.
ImageSourceFileSubPath *	string	Schreibgeschützt	Der Pfad des Quellbilds relativ zum Stammverzeichnis des Hot Folders oder des Ordners, aus dem es importiert wurde.
ImageSourcePageNumber *	int	Schreibgeschützt	Die Nummer der Quellseite in der Datei.
ImageSourceType *	string	Schreibgeschützt	Je nach Quelle die Zeichenfolge `File`, `Scanner` oder `Custom`.
Index *	int	Schreibgeschützt	Der Seitenindex im Dokument.
IsAnalyzed *	bool	Schreibgeschützt	Gibt an, ob die Seite analysiert ist.
IsResultClassConfident *	bool	Lesen/Schreiben	Gibt an, ob die Seite mit hoher Sicherheit klassifiziert wurde.
MatchedSection *	IMatchedSectionInfo	Schreibgeschützt	Detaillierte Informationen zum Abschnitt, der auf der Seite gefunden wurde. Wenn auf der Seite keine Abschnitte gefunden wurden, ist der Wert `null`.
Bild *	IPictureObject	Schreibgeschützt	Das Seitenbild. Dies ist ein internes Feld, für dessen Verwendung das Objekt in den Speicher geladen werden muss.
Rect *	IRect	Schreibgeschützt	Das Rectangle der Seite. Dies ist ein internes Feld, für das das Objekt in den Speicher geladen werden muss.
ReferenceClassName *	string	Schreibgeschützt	Die Referenzklasse der Seite.
ResultClassName *	string	Lesen/Schreiben	Der Name der Klasse, die der Seite zugewiesen ist.
SectionName *	string	Schreibgeschützt	Der Name des Dokumentabschnitts.
SourceFileGUID *	string	Schreibgeschützt	Der Bezeichner der Quelldatei eines Dokuments. Enthält eine leere Zeichenfolge, wenn die Quelldatei nicht gespeichert wurde.
SourceImageRotation *	int	Schreibgeschützt	Der Winkel (in Grad), um den das Quellseitenbild gedreht wurde. Mögliche Werte: `0`, `90`, `180`, `270`. Bei gegen den Uhrzeigersinn gedrehten Seiten wird der entsprechende Wert der Drehung im Uhrzeigersinn zurückgegeben (bei einem um 90° gegen den Uhrzeigersinn gedrehten Bild beispielsweise `270`). Die Eigenschaft ist nur verfügbar, wenn das Dokument, das die Seite enthält, geöffnet ist. Dies ist ein internes Feld, für das das Objekt in den Speicher geladen werden muss. Informationen zu den Bildern, für die diese Eigenschaft gilt, finden Sie unter Drehung des Quellbilds.

Drehung des Quellbilds

Die Eigenschaft SourceImageRotation gibt den Drehwinkel für Bilder zurück, die:

aus einem Hot Folder importiert wurden
in der Project Setup Station oder in der Rich-Verifizierungsstation geladen wurden
während der Erkennung gedreht wurden
manuell in Rich- und Remote-Stationen gedreht wurden
manuell in der Web-Verifizierungsstation oder während der Verifizierung in der Web-Erfassungsstation gedreht wurden

Die Eigenschaft berücksichtigt den Drehwert nicht für Bilder, die:

durch Skripte gedreht wurden
in der (Web-) Scanning Station oder während des Scannens in der Web-Erfassungsstation gedreht wurden
beim Korrigieren der Bildschieflage automatisch gedreht wurden

Ein Bildverbesserungsprofil auf Bilder des Typs „Foto“ anwenden

Das folgende Skript für eine benutzerdefinierte Verarbeitungsstufe wendet das Bildverbesserungsprofil Photo auf alle Bilder des Typs „Foto“ an:

foreach( IPage page in Document.Pages )
{
    IPictureObject picture = page.Picture;
    if( picture.IsPhoto() )
    {
        page.ApplyImageEnhancementProfile("Photo");
    }
}

Zum Originalseitenbild zurückkehren

Das folgende Skript führt den Operator auf der Verifizierungsstation zum Originalseitenbild zurück, wenn die Option Originalbild während der Verarbeitung speichern ausgewählt ist:

foreach( IPageItem pageItem in MainWindow.Selection.PageItems) {
    pageItem.TaskWindow.CloseEditorWindow();
    pageItem.TaskWindow.OpenDocument(  pageItem.DocumentItem.Document );
    IPage page = pageItem.Page;
    if ( page.HasOriginalImage )
        page.RevertToOriginalImage();
    pageItem.TaskWindow.CloseDocument(  pageItem.DocumentItem.Document );
}

​Methoden

​Eigenschaften

​Drehung des Quellbilds

​Ein Bildverbesserungsprofil auf Bilder des Typs „Foto“ anwenden

​Zum Originalseitenbild zurückkehren

Methoden

Eigenschaften

Drehung des Quellbilds

Ein Bildverbesserungsprofil auf Bilder des Typs „Foto“ anwenden

Zum Originalseitenbild zurückkehren