IField - ABBYY Documentation

概要

ドキュメントのfieldです。fieldの型は、Type プロパティで確認できます。テーブルfieldでは、Rows および Cell オブジェクトのメソッドを使用できます。

メソッド


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

プロパティ


Caption	string	読み取り専用	フォームに表示されるfieldの名前です。このプロパティの値は、Name プロパティと同じ場合があります。
子アイテム	IFields	読み取り専用	fieldの子アイテム (テーブルの場合はセル) 。スクリプトルールでは使用できません。
FullName	string	読み取り専用	ドキュメントにおける完全な field 名です。ドキュメント内の field の一意の識別子です。 Field メソッドを使用してドキュメントの field を検索する際に使用できます。スクリプトルールでは、返される値は Name と一致し、一意ではありません。
HasRuleError	bool	読み取り/書き込み	field にルールの警告またはエラーが関連付けられているかどうかを指定します。注: スクリプトルールでは、このプロパティはエラーメッセージに field を表示するかどうかを指定します。ルールには、ルールのプロパティルールのプロパティダイアログで指定された fields のコレクションが含まれます。ルールチェックが失敗すると、エラーメッセージ (IRuleContext .ErrorMessage で指定) と、コレクション内の fields へのリンクが文書エディターに表示されます。このプロパティを false に設定すると、その field はエラーに関連付けられたリンクの一覧から除外されます。
IsExportable	bool	読み取り専用	field がエクスポート対象かどうかを指定します (Document Definition の設定に基づきます) 。
IsIndexed	bool	読み取り専用	field をインデックス可能にするかどうかを指定します。可能な場合、field の値は Document Definition の document およびページの External fields から利用できます。
IsMatched	bool	読み取り専用	field がマッチしているかどうかを示します。
IsSuspicious	bool	読み取り専用	fieldの値が確実に認識されているかどうかを示します。
IsValid	bool	読み取り専用	field に書式エラーがないかどうかを示します。
IsVerified	bool	読み取り/書き込み	field が確認済みかどうかを指定します。注: このプロパティは 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 のインスタンス (テーブル field の行) 。
名前	string	読み取り専用	Document Definition内のfield名です。
NeedVerification	bool	読み取り/書き込み	フィールド自体 (文字ではなく) に検証が必要かどうかを指定します。フラグが true の場合、文書エディターではそのフィールドが赤い背景で表示されます。これは、そのフィールドに検証が必要であることを意味します。field propertiesfield properties で Send to field verification オプションが選択されている場合、そのフィールドは Data Verification ステージに送られます。フィールドの検証が完了すると、このフラグは false に設定されます。フィールド全体ではなく特定の文字に検証が必要かどうかを指定するには、 ICharacterParams インターフェイスの NeedVerification プロパティを使用します。
ReadOnly	bool	読み取り専用	field が「読み取り専用」権限 (Document Definition の設定に従う) を持つかどうかを指定します。ルールで使用する場合は、そのルールがその field に対して「書き込み」権限を持つことを示します。
ReadOnlyInForm	bool	読み取り/書き込み	フォーム上のフィールドが”読み取り専用”権限を持つかどうかを指定します (Document Definition Settings の設定によります) 。
Regions**	IFieldRegions	読み取り専用	field region の配列です。オーバーフローした field は複数の領域を持つ場合があります。
行	IFields	読み取り専用	テーブルの行の集合です。テーブル以外のfieldでは使用できません。
シンボル	ICharactersParams	読み取り専用	シンボルのプロパティに関する詳細情報。
Text	string	読み取り/書き込み	field値をテキストで表したものです。
型	TExportFieldType	読み取り専用	field の種類。
Value	VARIANT	読み取り/書き込み	VARIANT 形式の field の値です。field の設定で整数を含むよう指定されており、その絶対値が 2147483647 以下の場合、このプロパティは Int32 型のオブジェクトを返します。field の絶対値が 2147483647 を超える場合、このプロパティは double 型のオブジェクトを返します。

** - License のプロパティで Advanced XML Export オプションの選択が解除されている場合、このプロパティは使用できません。

​概要

​メソッド

​プロパティ

概要

メソッド

プロパティ