IPage

ABBYY FlexiCapture スクリプト用の IPage オブジェクトリファレンス。ページ画像、分類結果、認識されたテキスト、画像補正プロファイルを操作できます。

ページを表します。

このオブジェクトの一部のメソッドおよびプロパティは、ローカルでルールをチェックする際に Web Verification Station では使用できません。サポートされていないメソッドおよびプロパティにはアスタリスク (*) が付いています。

​

メソッド

メソッド	説明
ApplyImageEnhancementProfile( name : string ) *	画像補正プロファイルを画像に適用します。プロファイルの適用により新しいページが作成された場合、それらは現在のページの後にドキュメントへ追加されます。例については、「写真画像に画像補正プロファイルを適用する」を参照してください。
MarkAsAnnex( ) *	ページを、認識を必要としない別紙としてマークします。
ReplaceImage( newPicture : IPictureObject ) *	ページ画像を新しい画像に置き換えます。新しい画像は3つの方法で作成できます。別のIPictureObjectオブジェクトを編集するか、FCToolsのLoadImageメソッドを使用してファイルからロードします。3つ目の方法は、.NETのSystem.Drawing.Imageなどのメモリ内のビットマップから、FCToolsのPictureFromHBitmapメソッドを使用して作成する方法です。
RevertToOriginalImage( ) *	元のページ画像に戻します。このメソッドは、HasOriginalImageプロパティがtrueに設定されている場合にのみ呼び出せます。例については、「元のページ画像に戻す」を参照してください。
SaveAs( filename : string, [optional] options : IExportImageSavingOptions ) *	指定した保存オプションに従ってページ画像を保存します。オプションを指定しない場合、画像は*.tifとして保存されます。これは、オブジェクトをメモリにロードする必要がある内部fieldです。
SaveSourceFile( ) *	ページ画像の元となったソースファイルを指定したファイルに保存します。このメソッドは、ソースファイルが保存されている場合にのみ呼び出せます。ソースファイルが保存されているかどうかは、SourceFileGUIDプロパティで確認できます。詳細については、「エクスポートに関するサンプルスクリプト」を参照してください。
SaveXmlTextToFile( filename : string ) *	ページ上のすべてのテキストをXMLファイルとして指定したフォルダーに保存します。
SaveXmlTextToFileStorage( ) *	ページ上のすべてのテキストをXMLファイルとして、ファイルストレージ内のバッチフォルダーに保存します。

​

プロパティ

Name	型	アクセス	説明
AsBatchItem *	IBatchItem	読み取り専用	ページをIBatchItemオブジェクトに変換します。
添付ファイル *	IUserAttachments	読み取り専用	ユーザー添付ファイル。
コメント *	string	読み取り専用	ページの説明。
Document *	IDocument	読み取り専用	このページを含むドキュメント。
ExcludedFromDocumentImage *	bool	読み取り/書き込み可能、変更可 (読み取り専用権限を持つスクリプトでも変更可能)	文書画像のエクスポート時に適用されます。文書全体をエクスポートする際に、現在のページ画像をエクスポートしないことを示します。これは、オブジェクトをメモリにロードする必要がある内部fieldです。
FullText *	string	読み取り専用	ページ上で認識されたテキスト。
FullTextCharRects *	IRects	読み取り専用	FullText内の各文字の矩形。
HasOriginalImage *	bool	読み取り専用	元のページ画像が利用可能かどうかを示します。
Id	string	読み取り専用	ページ識別子。
ImageSource *	string	読み取り専用	画像のソース。画像がファイルからインポートされた場合、このプロパティにはファイルへのパスが含まれます。画像がスキャナから取得された場合、ImageSource にはソース名が含まれます。カスタムインポートで画像がインポートされた場合は、空の値になります。
ImageSourceFileSubPath *	string	読み取り専用	Hot Folder のルート、またはインポート元のフォルダーからの元の画像の相対パス。
ImageSourcePageNumber *	int	読み取り専用	ファイル内のソースページの番号。
ImageSourceType *	string	読み取り専用	ソースに応じて、File、Scanner、または Custom の文字列。
Index *	int	読み取り専用	ドキュメント内のページのインデックス。
IsAnalyzed *	bool	読み取り専用	ページが解析済みかどうかを示します。
IsResultClassConfident *	bool	読み取り/書き込み	ページが高い信頼度で分類されたかどうかを示します。
MatchedSection *	IMatchedSectionInfo	読み取り専用	ページで照合されたセクションの詳細情報。ページ上に照合されたセクションがない場合、値は null になります。
Picture *	IPictureObject	読み取り専用	ページ画像。この内部fieldを使用するには、objectをメモリにロードする必要があります。
Rect *	IRect	読み取り専用	ページの矩形。この内部fieldを使用するには、objectをメモリにロードする必要があります。
ReferenceClassName *	string	読み取り専用	ページの参照クラス。
ResultClassName *	string	読み取り/書き込み	ページに割り当てられたクラスの名前。
SectionName *	string	読み取り専用	ドキュメント セクションの名前。
SourceFileGUID *	string	読み取り専用	ドキュメントのソース ファイルの識別子。ソース ファイルが保存されていない場合は空の文字列になります。
SourceImageRotation *	int	読み取り専用	元のページ画像の回転角度 (度単位) 。可能な値は 0、90、180、270 です。反時計回りに回転されたページの場合は、時計回りの回転角度が返されます (たとえば、反時計回りに 90° 回転された画像の場合は 270 が返されます) 。このプロパティは、ページを含む文書が開かれている場合にのみ使用できます。これは、オブジェクトをメモリにロードする必要がある内部 field です。このプロパティが適用される画像については、「元の画像の回転」を参照してください。

​

元の画像の回転

SourceImageRotation プロパティは、次の画像の回転角度を返します。

• Hot Folder からインポートされた画像
• Project Setup Station またはリッチ Verification Station でロードされた画像
• 認識中に回転された画像
• リッチステーションおよびリモートステーションで手動で回転された画像
• Web Verification Station または Web Capture Station での検証中に手動で回転された画像

このプロパティでは、次の画像の回転値は考慮されません。

• スクリプトによって回転された画像
• (Web) Scanning Station または Web Capture Station でのスキャン中に回転された画像
• 画像の傾き補正時に自動的に回転された画像

​

写真画像に画像補正プロファイルを適用する

以下のカスタム処理ステージ用スクリプトは、写真タイプのすべての画像に Photo 画像補正プロファイルを適用します。

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

​

元のページ画像に戻す

次のスクリプトは、処理中に元の画像を保存するオプションが選択されている場合に、検証ステーション上でオペレーターを元のページ画像に戻します：

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 );
}