メインコンテンツへスキップ
field、その値、およびParameterへのアクセスを提供します。fieldの値はスクリプトで変更できます。スクリプトは、手動確認のオペレーターに表示する候補値を追加するためにも使用できます。

プロパティ

名前アクセス レベル説明
ChildrenField[]読み取り専用子fieldの配列。このプロパティはグループfieldに対してのみ有効です。
DataTypeDataType読み取り専用field内のデータ型。
FieldTypeFieldType読み取り専用fieldの種類。例: テキスト、チェックマーク、テーブル(他のfieldを表すセルを含む)。
FullNamestring読み取り専用Documentのルートから当該名前までのフルパス。区切りにはスラッシュ(/)を使用します(例: Vendor/Address/Street)。
HasRegionbool読み取り/書き込みfieldがドキュメント上で見つかった(対応する領域が存在する)場合はtrueを返します。falseは、このドキュメント画像に当該fieldに対応する領域が存在しないことを示します。
HasSuspiciousSymbolsbool読み取り専用field値に低信頼度で認識された文字が含まれる場合はtrueを返します。
Idstring読み取り専用ドキュメント内で一意のfield識別子。
ImageRegionsImageRegionList読み取り/書き込み画像上のfield領域の配列。
InstanceIndexint読み取り専用繰り返しfieldの現在のインスタンスのインデックス。IsRepeatabletrue の場合にのみ有効です。その他のケースでは -1 に設定されます。
InstancesField[]読み取り専用このfieldのすべてのインスタンスの配列。IsRepeatabletrue の場合にのみ有効です。Instances プロパティは、Field GetField メソッドで取得したコンテナー内の繰り返しfieldインスタンスへアクセスするために使用できます。
IsConfirmedbool読み取り/書き込みオペレーターまたは検証ルールによりfieldが確認済みの場合はtrueを返します。
IsRepeatablebool読み取り専用fieldが繰り返し可能な場合はtrueを返します。
IsSuspiciousbool読み取り専用field値に低信頼度で認識された文字が含まれる場合はtrueを返します。このようなfieldの値は、オペレーターによる手動確認か、ルールによるチェックが必要です。
IsValidbool読み取り専用fieldの認識テキスト(Text プロパティに保存)が、Value プロパティの指定型の値に正常に変換された場合はtrueを返します。
IsVisiblebool読み取り専用fieldがドキュメント上で可視の場合はtrueを返します。
Namestring読み取り専用グループ内で一意のfield名。
ParentField読み取り専用親field。
ReadOnlybool読み取り専用fieldが読み取り専用で、手動確認のオペレーターが編集できない場合はtrueを返します。
SymbolsSymbol[]読み取り専用fieldの元の値(テキスト形式)を構成する文字の配列。
Textstring読み取り専用fieldの元の値(テキスト形式。ドキュメント認識時に生成)。
Valueobject読み取り/書き込み指定形式のfieldの値(認識テキストの変換時に生成)。注意: Text プロパティとは異なり、Value プロパティは正規化された形式で値を保存します。スクリプト実行によりValue プロパティの正規化値が変更された場合、Text プロパティの値は新しい正規化値で更新されます。スクリプト実行後もValue プロパティの正規化値が変更されない場合、Text プロパティの値は更新されません。

メソッド

名前説明
void AddSuggestion(string value);field の推奨値を追加します。このメソッドにより、ユーザーは推奨値の一覧から値を選択できます。推奨値は手動確認の際に表示されます。このメソッドは field グループおよび繰り返し field コンテナーには適用できません。
void CopyTo(Field field);引数の field の次のプロパティを現在の field にコピーします:TextValueImageRegionsSymbols。field と field のデータ型が同一でない場合、メソッドはエラーを返します。
Field GetChild(string fieldName);指定された名前の子 field を返します。このメソッドは、同一リスト内の異なる要素(例:同一行内の異なるセル)へのアクセスを容易にします。重要:このメソッドには field の文字列名を直接渡してください。同じ文字列値を持つ変数では動作しません。スクリプトコードを実行前に解析するプリプロセッサは、field の名前をその識別子に置き換えますが、変数は処理できません。