その機能
メソッド
AddBatch (target: IWorkspaceItem, name: string, type: IBatchType ): IWorkspaceItem | バッチを追加します。新しいバッチは、 target パラメーターで指定したバッチの後に追加されます。 バッチをリストの先頭に追加する場合は、 target パラメーターの値を “Nothing” に設定します。 [VBscript] name パラメーターが空の場合、バッチ名はバッチ設定に従って生成されます。 |
AddDocument (page: IWorkspaceItem, name: string): IWorkspaceItem | ページを新しいドキュメントに挿入します。ページがすでにドキュメントに含まれている場合は、3 つのドキュメントが作成されます。1 つは前のページを含むドキュメント、1 つは現在のページのみを含むドキュメント、 もう 1 つは後続のページを含むドキュメントです。name パラメーターが空の場合、ドキュメント名はバッチの設定に従って生成されます。 |
AddPages (fileName: string, target: IWorkspaceItem, [optional] inside: bool): IWorkspaceItems | ファイルからページを追加します。ページは、同じ階層の target 項目の後に追加することも、 target 項目内の先頭に追加することもできます。ターゲットとして指定できるのは、 バッチ、ドキュメント、またはページです。ターゲットがバッチの場合、 inside パラメーターは “true” である必要があります (ページはバッチの先頭に追加されます) 。ターゲットがページの場合、 inside パラメーターは “false” である必要があります (ページは指定したページの後に追加されます) 。ターゲットがドキュメントの場合、 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 | ページの矩形領域を定義します |
RunScript (scriptName: string, [省略可能] info: string, [省略可能] skipShowError: bool): IScriptResult | スクリプトを実行します |
Scan ([optional] folder: string) | 現在のバッチタイプの設定を使用してスキャンを開始します |
Send (batch: IWorkspaceItem) | 現在のバッチタイプの設定を使用して、バッチをエクスポートします |
SendByScript (batch: IWorkspaceItem, skipShowExportOptions: bool) | 現在のバッチタイプの設定を使用して、スクリプトでバッチを送信します。skipShowExportOptions パラメーターは、バッチの送信前に Export Options ダイアログを表示するかどうかを指定します。 |
SendToFC (batch: IWorkspaceItem, [optional] skipShowExportOptions: bool) | 現在のバッチタイプの設定に従って、バッチを ABBYY FlexiCapture に送信します。skipShowExportOptions パラメーターでは、バッチの送信前に Export Options ダイアログを表示するかどうかを指定します。 |
SendToFolder (batch: IWorkspaceItem, [optional] skipShowExportOptions: bool) | 現在のバッチタイプの設定を使用して、バッチをフォルダーにエクスポートします。skipShowExportOptions Parameter は、バッチの送信前に［Export Options］ダイアログを表示するかどうかを指定します。 |
SendToFTP (batch: IWorkspaceItem, [optional] skipShowExportOptions: bool) | 現在のバッチタイプの設定を使用して、バッチを FTP フォルダーにエクスポートします。skipShowExportOptions パラメーターは、バッチの送信前に［Export Options］ダイアログを表示するかどうかを指定します。 |
SetPageImage (page: IWorkspaceItem, fileName: string, [optional] filePageIndex: int) | ページの画像を変更する |
待機 (millisecond: int) | 指定した時間 (ミリ秒単位) だけスクリプトの実行を一時停止します |
プロパティ
ActiveBatch | 読み取り/書き込み | 現在アクティブなバッチ。 一部のイベントスクリプト (例: On batch sending、On batch sent) では、null を返します。 | |
Batches | 読み取り専用 | Batches | |
BatchTypes | 読み取り専用 | バッチタイプ | |
CurrentBatchType | 読み取り/書き込み可能 | 現在のバッチタイプ | |
Result | 読み取り専用 | スクリプトの実行結果 | |
ScriptEnvInfo | string | 読み取り専用 | スクリプトがトリガーされる際の条件に関する環境情報です。 エクスポートの前後に自動的にトリガーされるスクリプトの場合、この値は “<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>“。 |
ScriptItems | 読み取り専用 | スクリプトが呼び出される対象の項目です。返される値はイベントによって異なります。 On station started および On station closing イベントでは、返される値は空です。 On scan completed イベントでは、返される値はスキャン セッション中に追加されたページのリストです。 その他のイベントでは、返される値はイベントに応じてバッチ、ドキュメント、またはページになります。 スクリプトがユーザーの明示的なコマンドによって起動された場合は、現在選択されている項目のコレクションが返されます。 | |
ScriptProperties | 読み取り専用 | スクリプトのプロパティ | |
選択 | 読み取り専用 | 現在の選択項目です。バッチのみ、ドキュメントのみ、またはページのみが含まれます。 | |
SourceID | string | 読み取り専用 | ステーションの識別子 |