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

Documentation Index

Fetch the complete documentation index at: https://docs.abbyy.com/llms.txt

Use this file to discover all available pages before exploring further.

Field は、ドキュメント内の field (値、パラメーター、構造) にアクセスするためのオブジェクトです。スクリプトから、field の値を変更したり、手動確認の担当者に表示される候補値を追加したりできます。

​
プロパティ

​
Children

型: Field[] — アクセス: 読み取り専用 子fieldの配列です。グループfieldでのみ有効です。

​
DataType

型: DataType — アクセス: 読み取り専用 field内のデータの型です。

​
FieldType

型: FieldType — アクセス: 読み取り専用 fieldの型です。たとえば、テキスト、checkmark、またはテーブル (他のfieldを表すセルを含む) です。

​
FullName

型: string — アクセス: 読み取り専用 ドキュメントのルートからfieldまでの完全なパスです。区切り文字にはスラッシュ (/) を使用します。たとえば、Vendor/Address/Street です。

​
HasRegion

型: bool — アクセス: 読み取り/書き込み fieldがドキュメント上で見つかった場合 (画像上に対応する領域が存在する場合) は true です。false は、対応する領域が見つからなかったことを意味します。

​
HasSuspiciousSymbols

型: bool — アクセス: 読み取り専用 true if the field value contains characters recognized with low confidence.

​
Id

型: string — アクセス: 読み取り専用 ドキュメント内で一意のfield識別子です。

​
ImageRegions

型: ImageRegionList — アクセス: 読み取り/書き込み 画像上のfield領域の配列です。

​
InstanceIndex

型: int — アクセス: 読み取り専用 繰り返しfieldの現在のインスタンスのインデックスです。繰り返しでないfieldの場合は -1 に設定されます。

​
Instances

型: Field[] — アクセス: 読み取り専用 このfieldのすべてのインスタンスの配列です (繰り返しfieldのみ) 。GetField で取得したコンテナー内で、繰り返しfieldのインスタンスにアクセスするには Instances を使用します。

​
IsConfirmed

型: bool — アクセス: 読み取り/書き込み オペレーターまたは検証ルールによってfieldが確認済みの場合は true です。

​
IsRepeatable

型: bool — アクセス: 読み取り専用 fieldが繰り返しfieldである場合は true です。

​
IsSuspicious

型: bool — アクセス: 読み取り専用 field値内のいずれかの文字が低い信頼度で認識された場合は true です。そのようなfieldは手動で確認するか、ルールでチェックする必要があります。

​
IsValid

型: bool — アクセス: 読み取り専用 Text 内の認識されたテキストが、Value 内の指定された型の値に正常に変換された場合は true です。

​
IsVisible

型: bool — アクセス: 読み取り専用 fieldがドキュメント上に表示されている場合は true です。

​
Name

型: string — アクセス: 読み取り専用 そのグループ内で一意のfield名です。

​
Parent

型: Field — アクセス: 読み取り専用 親fieldです。

​
ReadOnly

型: bool — アクセス: 読み取り専用 fieldが読み取り専用で、手動確認中に編集できない場合は true です。

​
Symbols

型: Symbol[] — アクセス: 読み取り専用 テキスト形式のfieldの元の値を構成する文字の配列です。

​
Text

型: string — アクセス: 読み取り専用 テキスト形式のfieldの元の値です (ドキュメントの認識時に生成されます) 。

​
Value

型: object — アクセス: 読み取り/書き込み 指定された形式のfield値です (認識されたテキストの変換時に生成されます) 。
Text とは異なり、Value プロパティには正規化された値が保存されます。スクリプトが Value を別の正規化値に変更すると、Text は新しい正規化形式で更新されます。スクリプト実行後も Value が変更されていない場合、Text は更新されません。

​
メソッド

​
AddSuggestion

void AddSuggestion(string value);
field に推奨値を追加します。手動確認時に、オペレーターは推奨値の一覧から選択できます。
field グループまたは繰り返し field のコンテナーではサポートされていません。

​
CopyTo

void CopyTo(Field field);
引数として渡された field から現在の field に Text、Value、ImageRegions、および Symbols をコピーします。2 つの field のデータ型が異なる場合は、エラーを返します。

​
GetChild

Field GetChild(string fieldName);
指定した名前の子 field を返します。GetChild を使用すると、同じ行内の別のセルなど、リスト内の要素にアクセスできます。
field 名は、変数ではなく文字列リテラルとして渡してください。スクリプトのプリプロセッサは、実行前にそのリテラル名を field の識別子に置き換えます。変数は処理されません。

オブジェクトモデル

Advanced Script Rules で使用する、JavaScript オブジェクトの完全なリファレンス。

Context

Context グローバルオブジェクト — ルール内から document、fields、skill parameters にアクセスできます。

FieldType

利用可能な field の型と、各型でサポートされるデータ型の列挙。

DataType

field に含められるデータ型の列挙 (通貨用の AmountOfMoney を含みます) 。