› ユーザー インターフェイス › フォーム › ツールボックス › 拡張コントロール › キャプチャ複合コントロール › キャプチャ複合コントロールのドリルダウン プロパティ

キャプチャ複合コントロールのドリルダウン プロパティ

プロセス内でキャプチャ アクティビティ (スキャン、検証、確認、ドキュメント レビュー) を構成し、構成したプロセスに対してこれらのアクティビティ タイプを使用してアクティビティ フォームを生成できます。これらのアクティビティ用に生成されたキャプチャ フォームを開いて .Net メソッドや表示ルールなどのアクションを構成する場合、デフォルトで次のドリルダウン プロパティをフォーム コントロールで使用してパラメータにマッピングできます。ScanActvity フォームの場合は、ImprinterFormat、ImprinterIndexStep などの追加のドリルダウン プロパティを使用して、スキャン開始時にスキャナのエンドーサまたはインプリンタに初期値をシードし、スキャンの完了時に値を取得します。

プロパティ

説明

これらのプロパティは内部使用専用です。

SessionId

コントロールに読み込まれた現在のバッチの内部 ID (通常のユーザー セッション ID ではない)。

FolderType

キャプチャ複合コントロールに読み込まれたフォルダに割り当てられた型。

フォルダ

キャプチャ複合コントロールに読み込まれたフォルダ オブジェクト。

DocumentType

キャプチャ複合コントロールに現在読み込まれているドキュメントに割り当てられている型。

ドキュメント

キャプチャ複合コントロールに現在読み込まれているドキュメント。

AssociatedDocTypes

ドキュメントの分類に使用できるドキュメント タイプのコレクションが含まれています。

Permissions

「注釈の許可」、「ページの削除の許可」など、現在のユーザーの権限を示すプロパティを持つ JavaScript オブジェクトを返します。

FolderType

割り当てられたフォルダの種類のシリアル化されたバージョンを返します。

Vrsprofiles

完全なスキャン/VRS プロファイルを JavaScript オブジェクトの配列として返します。

DocumentSeparation

割り当てられた分割プロファイルで定義されたドキュメント分割設定の完全なセットを JavaScript オブジェクトとして返します。

FolderSeparation

割り当てられた分割プロファイルで定義されたフォルダ分割設定の完全なセットを JavaScript オブジェクトとして返します。

RejectionReasons

コントロールに構成された拒否理由のリストを含む JavaScript 配列を返します。

これらのプロパティは使用可能です。

DisplayedDocumentId

画像ビューアで現在表示されているドキュメントのドキュメント ID。

DisplayedPageId

画像ビューアで現在表示されているページのページ ID。

ActivityVariantName

キャプチャ複合コントロールによって現在使用されているアクティビティ バリアントの名前 (存在する場合)。

NewSplitDocumentId

ドキュメントを分割する場合、分割から新しく作成されたドキュメントのドキュメント ID。

EnableDocumentFields

[ドキュメント フィールド] オプションが複合コントロールに対して有効になっているかどうかに応じて、true または false を返します。

EnableFolderFields

[フォルダ フィールド] オプションが複合コントロールに対して有効になっているかどうかに応じて、true または false を返します。

ContextHeader

このプロパティは、カスタム DLL からの Web サービス参照を使用してキャプチャ SDK (CaptureDocumentService) を呼び出すときに役立ちます。

API 呼び出しをコンテキスト対応にするために、ContextHeader プロパティを使用して、API 呼び出しを行う前に送信 HTTP ヘッダーに挿入できます。例:

var cds = new CaptureDocumentServiceClient(binding, new EndpointAddress("http://<TotalAgility-Server>/TotalAgility/Services/Sdk/CaptureDocumentService.svc"));

using (var scope = new OperationContextScope(cds.InnerChannel))
{
	// Set special header to make sure API is executed in correct context
	// 'header' value is consumed from 'ContextHeader' property of Capture control 
	OperationContext.Current.OutgoingMessageProperties[HttpRequestMessageProperty.Name] =
		new HttpRequestMessageProperty
		{
			Headers =
			{
				{ "CaptureContextDataHeader" , header }
			}
		};	

	// Call some API from CaptureDocumentService
	cds.DeletePages(sessionId, new CDSWS.ReportingData(), documentId, new CDSWS.PageIndexCollection { new CDSWS.PageIndex { Index = 0 } });
}

CurrentFolderId

選択したフォルダのフォルダ ID を返します。

選択したドキュメントの親フォルダを返します。

これらの追加プロパティは、ScanActvity フォームおよびスキャン新規ジョブ作成フォームで使用できます。

ImageAddress

スキャンの開始前にスキャナ ドライバに適用される値を持つパラメータ。この値は、スキャンが終了すると自動的にリフレッシュされ、「次の」イメージ アドレス値を表します。

スキャンが行われる前に値が取得された場合、値は定義されません。
ImageAddressTemplate

現在構成されているイメージ アドレス テンプレート文字列を含む読み取り専用プロパティ。このプロパティの値は、スキャナ設定またはドライバが変更されるたびに、スキャン終了後に取得されます。イメージ アドレスが有効になっていない、または使用できない場合、文字列は空です。

ScanningHostName

スキャン マシンのホスト名を含む読み取り専用プロパティ。このプロパティは、Web Capture Service によって onScanReady イベントに渡される値を返します。

ImprinterFormat

スキャナ形式。有効な値の範囲は 0 ～ 2 です。

値 TWAIN ドライバ VRS ドライバ

0 または "" (空の文字列)

デフォルト値。

スキャナは、ImprinterString プロパティで定義された 1 行を印刷します。

デフォルト値。

スキャナは、ImprinterString プロパティで定義された 1 行を印刷します。

1

スキャナは、ImprinterString プロパティで定義された複数の行を印刷します。

該当なし。フォーマット「0」として動作します。

2

スキャナは、スキーム {String}{Index}{Suffix} に従って構成された文字列を印刷します

スキャナは、スキーム {String}{Index} に従って構成された文字列を印刷します

ImprinterString

フォーマットに応じて、印刷された出力値のすべてまたはプレフィックスのみを形成する文字列値。

ImprinterIndex

スキャンされたページごとに、スキャナによって増分される自動インデックス。

これは、使用する ImprinterFormat に依存します。また、使用される最終的なインプリンタ文字列を取得します。

このプロパティを使用して、スキャン前に開始インデックス値をシードし、スキャン完了後にその最後の値を読み取ります。

ImprinterIndexStep

次のインデックス値までの増分値。サポートはスキャナに依存します。

ImprinterIndexDigits

インデックス値で許可される最大桁数。

ImprinterSuffix

印刷された出力値に付加されるサフィックス文字列。

ImprinterRotation

インプレース文字回転の量。回転は度単位で、時計回りに動きます。TWAIN 仕様は 0 ～ 359 の値をサポートしますが、ほとんどのスキャナ メーカーは、許容値を 0、90、180、270 に制限しています。VRS Elite は、0、90、180、270 をサポートします。
ImprinterVerticalOffset

指定した単位の垂直オフセット。

ImprinterUnits

垂直オフセットを指定するときの測定単位。

  • 0=インチ

  • 1=センチメートル

  • 2=パイカ

  • 3=ポイント

  • 4=トゥイップ

  • 5=ピクセル

  • 6=ミリメートル

ImprinterFontStyle

次のビット フィールドの数値の組み合わせによって定義される TWAIN スキャンのフォント スタイル:

  • 1: 標準

  • 2: 太字

  • 4: 斜体

  • 8: 大サイズ

  • 16: 小サイズ

たとえば、TWAIN スキャナが太字と大サイズのフォントで構成されるフォント サイズをサポートする場合、数値は 10 (2 + 8) になります。

VRS Elite はこのパラメータをサポートしていません。代わりに、ドライバ設定でフォント サイズを指定し、VRS プロファイルに保存できます。

ScannerName

スキャン フォームでドキュメントを取得するために使用されるスキャナ名を取得します。