キャプチャ コントロールのプロパティ

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

SessionId

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

FolderType

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

フォルダ

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

DocumentType

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

ドキュメント

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

AssociatedDocTypes

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

Permissions

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

RejectionReasons

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

Vrsprofiles

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

DocumentSeparation

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

FolderSeparation

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

FolderType

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

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

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://kta-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 } });
}