IField

動作

文書フィールドフィールドのタイプはプロパティから決定できますType。テーブルフィールドの場合は、RowsCellオブジェクトメソッドを使用できます。

メソッド

定義 説明
AddRegion( page :IPage, rect : string ) :IFieldRegion

指定された座標を持つ領域をフィールドに追加します。rect[left、top、right、bottom]の形式の長方形の説明です。このメソッドには、IFieldオブジェクトに対する書き込み権限が必要です。

サンプルコード

注:このメソッドはテーブルでは使用できません。領域を削除するには、IFieldRegion.Delete() メソッドを使用します。

Cell( columnName : string, rowNum : int ) :IField 列名と行番号で表のセルを取得します。テーブル専用です。スクリプトルールでは使用できません。
CheckRules( ) 指定されたフィールドとその子のルールをチェックします。ルールでは使用できません。
Field( Path : string) :IField 指定された要素に関連する子要素を検索します。相対パスが使用されます。ルール設定で定義されているフィールド名の同義語のみがルールで使用できます。
GetFieldExtractor( ) IFieldExtractorオブジェクトを返します。
HasField( parameter : string) : bool 指定されたパスを持つフィールドが存在するかどうかをチェックします。相対パスが使用されます。ルール設定で定義されているフィールド名の同義語のみがルールで使用できます。
Suggest( VARIANT newSuggest )

フィールドにプロンプトを追加します。

注:値または文字列のフォームで指定できます。追加された値は小数点以下4桁で書かれています。

たとえば、field.Suggest( "12.90")メソッドは、 "12.90"の形式でプロンプトを追加し、field.Suggest(12.90)はプロンプトを12.9000として追加します。

プロパティ

名前 タイプ アクセス 説明
Caption string 読み取り専用 フォームに表示されるフィールドの名前。このプロパティの値は、Nameプロパティと同じでもかまいません。
Children IFields 読み取り専用 フィールドの子アイテム(テーブルのセル)。スクリプトルールでは使用できません。
FullName string 読み取り専用 文書に関連する完全なフィールド名。文書内のフィールドの一意の識別子。以下によるドキュメントフィールドの検索に使用できま:Fieldメソッド。スクリプトルールでは、返される値はNameと一致し、一意ではありません。
HasRuleError bool 読み取り/書き込み

ルールの警告またはエラーがフィールドに関連付けられているかどうかを指定します。

注:スクリプトルールでは、このプロパティは、エラーメッセージにフィールドを表示するかどうかを指定します。

ルールには、以下で指定したフィールドのコレクションが含まれます:ルールプロパティダイアログボックスで選択します。ルールのチェックに失敗すると、エラーメッセージIRuleContext.ErrorMessageで指定)とコレクションのフィールドへのリンクが文書エディタに表示されます。このプロパティをfalseに設定すると、エラーに関連付けられたリンクのリストからフィールドが除外されます。

IsExportable bool 読み取り専用 フィールドがエクスポートのためのものかどうかを指定します(文書定義の設定に従います)。
IsIndexed bool 読み取り専用 フィールドがインデックス可能かどうかを示します。「はい」の場合、文書定義の文書およびページの外部フィールドからフィールド値を使用できます。
IsMatched bool 読み取り専用 フィールドが一致するかどうかを指定します。
IsSuspicious bool 読み取り専用 フィールド値が確実に認識されるかどうかを指定します。
IsValid bool 読み取り専用 フィールドに書式エラーがないかどうかを指定します。
IsVerified bool 読み取り/書き込み

フィールドが検証されるかどうかを指定します。
注:以下ではプロパティが機能しません:フィールドグループ
ルールのプロパティをtrueにフィールドの "書き込み"権限がなくても、設定可能です。フラグの選択を解除するには、 "書き込み"権限が必要です。

フラグがtrueの場合、フィールドはすでに確認済みのように文書エディタでグレー表示されます。フラグがfalseの場合、フィールドは白で表示され、確認する必要があります。フィールドが確認されると、フラグは以下に設定されます:true

注:このフラグをfalseに設定しても、フィールドをデータ検証ステージにルーティングすることはできません。このために、フィールドのNeedVerificationプロパティ、またはICharacterParamsインターフェースを使用します。

IsVisible bool 読み取り/書き込み フィールドを文書レイアウトに反映するかどうかを指定します(文書定義の設定に従って)。
Items IFields 読み取り専用 フィールドのインスタンス(テーブルフィールドの行)。
Name string 読み取り専用 文書定義のアイテム名。
NeedVerification bool 読み取り/書き込み

フィールド自体(文字ではない)が確認を必要とするかどうかを指定します。

フラグがtrueの場合、フィールドは、フィールドが検証を必要とすることを意味する文書エディタの赤い背景に対して表示されます。もし、フィールド検証に送信フィールドプロパティでこのオプションを選択すると、フィールドプロパティフィールドはデータ検証ステージにルーティングされます。フィールドが確認されると、フラグは以下に設定されます:false

フィールド全体ではなく特定の文字を検証する必要があるかどうかを指定するには、NeedVerificationプロパティ(ICharacterParamsインターフェイスを使用します

ReadOnly bool 読み取り専用 フィールドに「文書定義」の設定に従って「読み取り専用」権限があるかどうかを指定します。ルールで使用されている場合、そのルールがフィールドに対して「書き込み」権限を持っていることを示します。
ReadOnlyInForm bool 読み取り/書き込み フォーム上のフィールドが(文書定義の設定に従って)「読み取り専用」アクセス許可を持っているかどうかを指定します。
Regions** IFieldRegions 読み取り専用 フィールド領域の配列。オーバーフローするフィールドには複数の領域があります。
Rows IFields 読み取り専用 テーブル行のセット。テーブル以外のフィールドでは使用できません。
Symbols ICharactersParams 読み取り専用 シンボルのプロパティに関する詳細情報。
Text string 読み取り/書き込み フィールド値のテキスト表現。
Type TExportFieldType 読み取り専用 フィールドのタイプ。
Value VARIANT 読み取り/書き込み バリアントフォームのフィールドの値。Integerとその絶対値を含むフィールド状態の設定が2147483647より大きくない場合、プロパティはInt32型のオブジェクトを返します。フィールドの絶対値が2147483647より大きい場合、プロパティはdouble型のオブジェクトを返します。

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

16.01.2023 10:03:08

Please leave your feedback about this article

Usage of Cookies. In order to optimize the website functionality and improve your online experience ABBYY uses cookies. You agree to the usage of cookies when you continue using this site. Further details can be found in our Privacy Notice.