IField - ABBYY Documentation

ドキュメントのfieldです。fieldの型は Type プロパティで判別できます。テーブルフィールドの場合は、Rows および Cell オブジェクトのメソッドが利用できます。

メソッド

メソッド	説明
`AddRegion( page : IPage, rect : string ) : IFieldRegion`	指定した座標のRegionをfieldに追加します。`rect`は、`[left,top,right,bottom]`形式で表される矩形です。このメソッドを使用するには、`IField` オブジェクトに対する書き込み権限が必要です。このメソッドはテーブルでは使用できません。Regionを削除するには、IFieldRegion の`Delete()`メソッドを使用します。例については、field領域をコピーするを参照してください。
`Cell( columnName : string, rowNum : int ) : IField`	column名と行番号を指定してテーブルセルを取得します。テーブルでのみ使用できます。スクリプトルールでは使用できません。
`CheckRules( )`	指定したfieldとその子要素に対してruleをチェックします。rulesでは使用できません。
`Field( Path : string ) : IField`	指定した要素を基準に子要素を検索します。相対パスを使用します。rulesでは、rule settingsで定義されたfield namesの同義語のみ使用できます。
`GetFieldExtractor( )`	IFieldExtractor オブジェクトを返します。
`GetLangs( ) : IVARIANTArray`	fieldで検出された言語のIDを返します。例については、field内の言語を確認するを参照してください。
`HasField( parameter : string ) : bool`	指定したパスのfieldが存在するかどうかを確認します。相対パスを使用します。rulesでは、rule settingsで定義されたfield namesの同義語のみ使用できます。
`Suggest( VARIANT newSuggest )`	fieldにpromptを追加します。値またはstringとして指定できます。追加した値は小数点以下4桁で書き込まれます。たとえば、`field.Suggest( "12.90" )`は`12.90`形式のpromptを追加し、`field.Suggest( 12.90 )`は`12.9000`としてpromptを追加します。

プロパティ

Name	型	アクセス	説明
Caption	string	読み取り専用	フォームに表示されるfieldの名前です。このプロパティの値は、Name プロパティと同じになる場合があります。
Children	IFields	読み取り専用	field の子アイテム (テーブルの場合はセル) 。スクリプトルールでは使用できません。
FullName	string	読み取り専用	文書内の完全なfield名。文書内のfieldを一意に識別する識別子です。Fieldメソッドを使用して文書のfieldを検索できます。スクリプトルールでは、返される値はNameと同じであり、一意ではありません。
HasRuleError	bool	読み取り/書き込み	field にルールの警告またはエラーが関連付けられているかどうかを指定します。script rules では、このプロパティでエラーメッセージに field を表示するかどうかを指定します。ルールには、rule properties ダイアログで指定した fields のコレクションが含まれます。ルールチェックに失敗すると、文書エディターに IRuleContext の `ErrorMessage` のエラーメッセージが表示されます。また、コレクション内の fields へのリンクも表示されます。このプロパティを `false` に設定すると、エラーに関連するリンクのリストから field が除外されます。
IsExportable	bool	読み取り専用	field がエクスポート対象かどうかを指定します (Document Definition の設定に基づきます) 。
IsIndexed	bool	読み取り専用	field がインデックス可能かどうかを示します。可能な場合、field の値は Document Definition の文書およびページの External fields から取得できます。
IsMatched	bool	読み取り専用	field が一致したかどうかを示します。
IsSuspicious	bool	読み取り専用	fieldの値が確実に認識されたかどうかを示します。
IsValid	bool	読み取り専用	fieldに書式エラーがないかどうかを示します。
IsVerified	bool	読み取り/書き込み	field が検証済みかどうかを指定します。このプロパティは field グループには使用できません。field に対する書き込み権限がなくても、ルール内でこのプロパティを `true` に設定できます。フラグを解除するには、書き込み権限が必要です。フラグが `true` の場合、field はすでに確認済みであるかのように文書エディターでグレー表示されます。フラグが `false` の場合、field は白で表示され、確認が必要です。field が検証された後、フラグは `true` に設定されます。このフラグを `false` に設定しても、field は Data Verification ステージに送られません。その場合は、`IField` または ICharacterParams インターフェイスの `NeedVerification` プロパティを使用します。
IsVisible	bool	読み取り/書き込み	field をドキュメントのレイアウトに反映するかどうかを指定します (Document Definition の設定に従います) 。
Items	IFields	読み取り専用	field のインスタンス (テーブルフィールドの行) 。
名前	string	読み取り専用	Document Definition 内の field 名。
NeedVerification	bool	読み取り/書き込み	field 自体 (文字単位ではなく) に検証が必要かどうかを指定します。フラグが `true` の場合、文書エディターで field は赤い背景で表示されます。これは、field に検証が必要であることを示します。field properties で Send to field verification オプションが選択されている場合、field は Data Verification ステージに送られます。field が検証された後、フラグは `false` に設定されます。field 全体ではなく特定の文字に検証が必要かどうかを指定するには、ICharacterParams インターフェイスの `NeedVerification` プロパティを使用します。
ReadOnly	bool	読み取り専用	fieldが読み取り専用かどうかを指定します (Document Definitionの設定に基づく) 。ルールで使用する場合は、そのルールにfieldへの書き込み権限があることを示します。
ReadOnlyInForm	bool	読み取り/書き込み	フォーム上のfieldが読み取り専用かどうかを指定します (Document Definition Settingsの設定に従います) 。
Regions	IFieldRegions	読み取り専用	field regions の配列です。オーバーフローした field には複数の regions を設定できます。license properties で Advanced XML Export オプションが選択されている場合にのみ利用できます。
行	IFields	読み取り専用	テーブルの行のセットです。テーブル以外のfieldでは使用できません。
文字	ICharactersParams	読み取り専用	記号のプロパティに関する詳細情報。
Text	string	読み取り/書き込み	field値のテキスト表現。
型	TExportFieldType	読み取り専用	field の型。
Value	VARIANT	読み取り/書き込み	VARIANT 形式の field の値です。field 設定で整数を含むよう指定されており、その絶対値が `2147483647` 以下の場合、このプロパティは `Int32` オブジェクトを返します。field の絶対値が `2147483647` を超える場合は、double 型のオブジェクトを返します。

field Regionをコピーする

次のコードは、field 1 の領域を field 2 にコピーします:

field2.AddRegion( field1.Regions[0].Page, field1.Regions[0].SurroundingRect.ToString() )

field に含まれる言語を確認する

次のユーザースクリプトは、field にどの言語が含まれているかを確認します:

var t = Context.Field("Field Name").GetLangs();
var p = "";
foreach (var s in t)
{
p += s.ToString()+",";
}
FCTools.ShowMessage( "Language " +  p);