メインコンテンツへスキップ

その機能

このステーションのワークスペースを表します。スクリプトでは、キーワード this を使ってこのオブジェクトにアクセスできます。

メソッド

定義説明
AddBatch( target: IWorkspaceItem, name: string, type: IBatchType ): IWorkspaceItemバッチを追加します。新しいバッチは、target パラメーターで指定したバッチの後に追加されます。バッチをリストの先頭に追加するには、target パラメーターに “Nothing” を設定します (VBScript: me.AddBatch Nothing, "batch 1", me.BatchTypes.Item(0)) 。name パラメーターが空の場合、バッチ名はバッチ設定に従って生成されます。
AddDocument( page: IWorkspaceItem, name: string ): IWorkspaceItemページを新しいドキュメントに挿入します。ページがすでにドキュメントに含まれている場合は、3 つのドキュメントが作成されます。1 つは前のページを含むドキュメント、1 つは現在のページのみを含むドキュメント、もう 1 つは後続のページを含むドキュメントです。name パラメーターが空の場合、ドキュメント名はバッチ設定に従って生成されます。
AddPages( fileName: string, target: IWorkspaceItem, [optional] inside: bool ): IWorkspaceItemsファイルからページを追加します。ページは、同じレベルの target アイテムの後に追加することも、target アイテム内のリスト先頭に追加することもできます。target には、バッチ、ドキュメント、またはページを指定できます。target がバッチの場合、inside パラメーターは “true” である必要があります (ページはバッチの先頭に追加されます) 。target がページの場合、inside パラメーターは “false” である必要があります (ページは指定したページの後に追加されます) 。target がドキュメントの場合、inside パラメーターには “true” と “false” のどちらも指定できます。
ClearSelection()現在の選択を解除します
DeleteItem( item: IWorkspaceItem )指定したアイテムを削除します
DetectPageEmpty( page: IWorkspaceItem, [省略可能] options: IEmptyPageDetectionOptions ): bool空白ページを検出します
Exit(): boolステーションの作業を終了します
FindPageBarcodes( page: IWorkspaceItem, [省略可能] options: IBarcodeFindingOptions ): IScriptFoundBarcodesページ上のバーコードを検索します
NewBarcodeFindingOptions(): IBarcodeFindingOptionsバーコード検出オプションを設定します
NewEmptyPageDetectionOptions(): IEmptyPageDetectionOptions空白ページの検出オプションを設定します
NewImageSavingOptions(): IImageSavingOptions画像の保存オプションを設定します
NewPageRect(): IPageRectページのRectangleを定義します
RunScript( scriptName: string, [オプション] info: string, [オプション] skipShowError: bool ): IScriptResultスクリプトを実行します
Scan( [optional] folder: string )現在のバッチタイプの設定でスキャンを開始します
Send( batch: IWorkspaceItem )現在のバッチタイプの設定でバッチをエクスポートします
SendByScript( batch: IWorkspaceItem, skipShowExportOptions: bool )現在のバッチタイプの設定を使用して、スクリプトでバッチを送信します。skipShowExportOptions Parameter は、バッチを送信する前に Export Options ダイアログを表示するかどうかを指定します。
SendToFC( batch: IWorkspaceItem, [optional] skipShowExportOptions: bool )現在のバッチタイプの設定で、バッチをABBYY FlexiCaptureに送信します。skipShowExportOptions パラメーターは、バッチの送信前に Export Options ダイアログを表示するかどうかを指定します。
SendToFolder( batch: IWorkspaceItem, [省略可能] skipShowExportOptions: bool )現在のバッチタイプの設定に従って、バッチをフォルダーにエクスポートします。skipShowExportOptions パラメーターは、バッチを送信する前に Export Options ダイアログを表示するかどうかを指定します。
SendToFTP( batch: IWorkspaceItem, [省略可能] skipShowExportOptions: bool )現在のバッチタイプの設定を使用して、バッチをFTPフォルダーにエクスポートします。skipShowExportOptions パラメーターは、バッチの送信前に[エクスポートオプション]ダイアログを表示するかどうかを指定します。
SetPageImage( page: IWorkspaceItem, fileName: string, [任意] filePageIndex: int )ページの画像を変更します
Wait( millisecond: int )指定した時間 (ミリ秒) だけスクリプトの実行を一時停止します

プロパティ

名前アクセス説明
ActiveBatchIWorkspaceItem読み取り/書き込みアクティブなバッチです。一部のイベントスクリプト (例: On batch sendingOn batch sent) では、null を返します。
BatchesIWorkspaceItems読み取り専用Batches
BatchTypesIBatchTypes読み取り専用バッチタイプ
CurrentBatchTypeIBatchType読み取り/書き込み現在のバッチタイプです
ResultIScriptResult読み取り専用スクリプトの実行結果
ScriptEnvInfostring読み取り専用スクリプトがトリガーされる条件に関する環境情報です。エクスポートの前後に自動的にトリガーされるスクリプトの場合、値は <exportType> <taskID> です。ここで、exportType には “Folder”、“FTP”、“FC”、“RS”、“Script” のいずれかが入り、taskID はエクスポートタスクの識別子です。ページ変換の前後に自動的にトリガーされるスクリプトの場合、このプロパティは次のいずれかの値になります: Rotate <angle>, FlipHorizontal, FlipVertical, Invert, ConvertToBW, Deskew, Despeckle, Erase <rectLeft> <rectTop> <rectRight> <rectBottom>, Crop <rectLeft> <rectTop> <rectRight> <rectBottom>, SplitHorizontal <pos>, SplitVertical <pos>, ChangeResolution <newRes>, Scale <ratio>, FreeScale <newWidth>, <newHeight>, <newRes>.
ScriptItemsIWorkspaceItems読み取り専用スクリプトが呼び出される対象のアイテムです。返される値はイベントによって異なります。イベント On station startedOn station closing では、空の値が返されます。イベント On scan completed では、スキャンセッション中に追加されたページのリストが返されます。その他のイベントでは、イベントに応じてバッチ、ドキュメント、またはページが返されます。スクリプトが明示的なユーザーコマンドによって起動された場合は、現在選択されているアイテムのコレクションが返されます。
ScriptPropertiesIScriptProperties読み取り専用スクリプトプロパティ
SelectionIWorkspaceItems読み取り専用現在の選択内容です。バッチのみ、ドキュメントのみ、またはページのみが含まれます。
SourceIDstring読み取り専用ステーションの識別子