> ## 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. # オブジェクト > Web Verification Station のカスタム スクリプト用オブジェクト モデル。field、データ セット、ドキュメント フォームの関数に加え、commandArgs と field プロパティを含みます。 以下に、カスタム スクリプトの作成に使用できる関数の一覧を示します。オブジェクト インスタンスにアクセスするには、`commandArgs` 変数を使用します。 このセクションのすべての変数はグローバル変数であり、プログラム全体で参照できます。

関数

説明

getCurrentField()

現在のカスタム スクリプトで使用されているfield オブジェクトへのリンクを返します。

getFieldByName(namesPath) (\*)

カスタム スクリプトが開かれている field へのリンクを返します。

例:
\['Document Section 1', 'Group\[10]','Field3'],
ここで \[10] は、繰り返しグループのインスタンス番号です。

  • namesPath は、field へのパスを構成する field 名とグループ名を格納した配列、または field オブジェクトへのリンクです。

getFieldValue(namesPath) (\*)

戻り値:

  • TextField field の場合は string;
  • Checkmark field の場合はチェックマークの値;
  • Checkmark Group field の場合は string array。

namesPath | fieldObject:

  • field へのパスを構成する field 名と group 名を含む array、または field object へのリンク。
  • または、field object へのリンク。

setCurrentFieldValue(value, forced, onSaved)

カスタム スクリプトを開いている field の値を変更します。

パラメーター:

  • value – field の値。
  • forced – field の値を更新し、新しいデータを記録します。このパラメーターは省略可能です。
    • false – Document Definition 内の field の値は、save() 関数が呼び出された後にのみ更新されます。
    • true – Document Definition 内の field の値はすぐに更新されます。

      カスタム スクリプトでは、モードに関係なく更新されます。
      デフォルトでは、このパラメーターは false に設定されています。
  • onSaved – コールバック関数。forced パラメーターが true に設定されている場合に呼び出されます。このパラメーターは省略可能です。

setFieldValue(namesPath | field, value, forced, onSaved) (\*)

field の値を変更します。

パラメーター:

  • namesPath | fieldObject:
    • field へのパスを構成する、field 名と group 名を含む配列、
    • または field object へのリンク。
  • value – 対応する field の値。
  • forced – field の値を更新し、新しいデータを記録します。このパラメーターは省略可能です。
    • false – Document Definition 内の field の値は、save() 関数が呼び出された後にのみ更新されます。
    • true – Document Definition 内の field の値は直ちに更新されます。

      カスタム スクリプトでは、モードに関係なく更新されます。
      既定では、このパラメーターは false に設定されています。
  • onSaved – コールバック関数。forced パラメーターが true に設定されている場合に呼び出されます。このパラメーターは省略可能です。

save()

カスタム スクリプトを実行しているウィンドウを閉じ、変更を保存します。

cancel()

変更を保存せずに、カスタム スクリプトの実行ウィンドウを閉じます。

(\*) 上記に挙げた一部の関数では、field へのパスを入力パラメーターとして指定します。このパスは、field 名と親要素 (field グループ、セクション) の名前で構成されます。テーブル、繰り返しテーブル、および繰り返しグループでは、0 (ゼロ) から始まるインスタンス番号を指定する必要があります。

例:
\['Document Section 1', 'Group\[10]','Field3'],

ここで \[10] は、繰り返しグループのインスタンス番号です。

関数

説明

addEntity(entityInfo: \{cacheName, columns, values}, onResult(newId))

データセットにエントリを追加します。

パラメーター:

  • entityInfo – オブジェクト:
    • cacheName – データセット名。
    • columns – データを記録する列名。string の配列。
    • values – 対応する列の値。string の配列。
  • onResult – データセットに作成されたレコードの ID を受け取る Callback 関数。

editEntity(entityInfo: \{cacheName, columns, values}, onResult())

データベース内のエントリを編集します。

パラメーター:

  • entityInfo – オブジェクト:
    • cacheName – data set の名前です。
    • columns – データを記録する列名です。string の配列です。
    • values – 対応する列の値です。string の配列です。
  • onResult – コールバック関数です。

getDict(\{cacheName, filters: \[\{FieldName, FieldValue}], cursorPos, allowMultipleColumnResults}, onResult (param: \{ FieldName, FieldValue, BoldMask}\[]\[]) )

指定した値、またはその一部についてデータセットを検索します。一致した文字列を次の形式で返します。

\[\{FieldName
FieldValue
BoldMask}].

パラメーター:

  • cacheName – データセット名です。
  • filters – 検索パラメーター:
    • FieldName – field 名です。空のままにすると、すべての field を検索します。
    • FieldValue – field 値です。
  • cursorPos – 入力フィールド内のカーソル位置です。
    • 値が途中まで入力されていて、カーソルが入力済みの文字列の後ろにある場合、それらの文字は検索対象の値の先頭部分として扱われます。
    • カーソルが途中まで入力された単語の前にある場合、それらの文字は検索対象の値の末尾として扱われます。

      たとえば、会社名を検索するときに "ADO" と入力し、カーソルがその後ろにある場合は、値 "AVOCADO" が選択されます。
      "ADO" と入力し、カーソルがその前にある場合は、値 "ADONIS" が選択されます。
  • allowMultipleColumnResults – 見つかった field の値を返します。
    データセットには、1 つの field 名 (FieldName) に対して複数の field 値 (FieldValue) が対応するエントリーが含まれている場合があります。たとえば、会社名の 2 つ以上 の表記ゆれが CompanyName 列に指定されていることがあります。

    この場合:
    • true – 検索条件を満たすすべての field 値を返して記録します。
    • false – 検索条件に最も適合する 1 つの結果を返して記録します。
  • onResult – 検索結果の配列を返すコールバック関数です。各結果はデータセット内の 1 つの文字列で、この配列の各文字列は field 名、その値、および BoldMask パラメーターで構成されます。

    BoldMask – 検索で見つかった値と同じ長さの、‘0’ と ‘1’ からなる文字列です。'1' は、 見つかった値の文字のうち、検索フィールド内の対応する文字と一致する文字を表し、'0' は一致しない文字を表します。

たとえば、データセットに次の内容があるとします。

CompanyName: ABBYY

"ABB" という文字列を検索するとします。

その場合、次の内容が返されます。

\[

\[

\{

FieldName: ‘CompanyName’,

FieldValue: ‘ABBYY’,

BoldMask: ‘11100’

},

]

]

注: 返される配列には、最初は検索条件に適合していなかった値も含めて、複数の値が含まれる場合があります。配列内の検索結果は BoldMask パラメーターの値の降順 (つまり、検索条件に最もよく一致する文字列から) で並べ替えられます。

getDictAll(\{cacheName, filters: \{FieldName, FieldValue}}, }, onResult (param: \{ FieldName, FieldValue, BoldMask}\[]\[]))

指定した完全な値に対してデータベース検索を実行します。見つかったすべてのfieldの値を返します。

パラメーター:

  • cacheName – データセット名。
  • Filters – オブジェクト配列:
    • FieldName – field名。すべてのfieldを対象に検索する場合は、空欄のままにします。
    • FieldValue – fieldの値。
  • onResult – 検索結果の配列を返すコールバック関数。各結果はデータセット内の1つの文字列であり、それ自体が文字列配列です。各文字列は field名、その値、およびBoldMask パラメーターで構成されます。

    BoldMask – 検索で見つかった値と同じ長さの、‘0’ と ‘1’ から成る文字列です。'1' は、見つかった値の中で検索field内の対応する記号と一致する記号を表し、'0' は一致しない記号を表します。


    たとえば、データセットに次の値が含まれているとします:

    CompanyName: ABBYY

    記号 "ABB" を検索するとします。

    この場合、次の値が返されます:

\[

\[

\{

FieldName: ‘CompanyName’,

FieldValue: ‘ABBYY’,

BoldMask: ‘11100’

},

]

]

注: 返される配列には、最初の検索条件に一致しなかった値を含め、複数の値が含まれる場合があります。配列内の検索結果は、 BoldMask パラメーターの値の降順 (つまり、検索条件に最もよく一致する文字列から) で並べ替えられます。

データベース検索用のサンプル スクリプト

関数

説明

selectRow(tablePath, rowNumber) (\*)

テーブルの行を選択状態にします。

  • tablePath | fieldObject:
    • テーブル field へのパスを構成する field 名とグループ名の配列、
    • またはテーブルオブジェクトへのリンク。
  • rowNumber – 選択する行の番号。ゼロベースです。

deselectRow(tablePath, rowNumber?) (\*)

テーブルの行の選択を解除します。

  • tablePath | fieldObject:
    • テーブル field へのパスを構成する field 名とグループ名の配列、
    • またはテーブルオブジェクトへのリンク。
  • rowNumber – 選択解除する行の番号。ゼロベースです。省略した場合は、テーブル内のすべての行の選択が解除されます。

scrollFormToField(namesPath) (\*)

フォームエディターをスクロールして、field が表示されるようにします。

  • namesPath | fieldObject:
    • テーブル field へのパスを構成する field 名とグループ名の配列、
    • またはテーブルオブジェクトへのリンク。

getDomElementPosition(domId, onResult: (result?: \{width, height, top, left, right, bottom}))

フォームエディターウィンドウ内の要素の位置を取得し、その結果をコールバック関数に返します。

  • domId – DOM 形式の要素 ID。
  • onResult – ブラウザーウィンドウの左上隅を基準とした要素の DOM 座標 (width、height、top、left、right、bottom) を含むオブジェクトを受け取るコールバック関数です。

setStyles(styles, callback)

カスタムアクションのフレームウィンドウに CSS スタイルを追加します。

  • styles – CSS プロパティ名と値を含むオブジェクト。

    例:
    \{
    display: 'block',
    position: 'absolute',
    top: '0px',
    bottom: '0px',
    left: '0px',
    right: '0px',
    width: '100%',
    height: '100%',
    border: '0',
    overflow: 'hidden',
    'overflow-x': 'hidden',
    'overflow-y': 'hidden',
    'z-index': '10000'
    }
  • callback – コールバック関数。

(\*) 上記の一部の関数では、field へのパスを入力パラメーターとして指定します。これは、field 名と親要素 (field グループ、セクション) の名前で構成されます。テーブル、繰り返しテーブル、繰り返しグループについては、ゼロから始まるインスタンス番号を指定する必要があります。

例:
\['Document Section 1', 'Group\[10]','Field3'],

ここで、\[10] は繰り返しグループのインスタンス番号です。
**変数**

変数

型

説明

commandArgs.params.document

Document

開いているドキュメントのオブジェクトのコピーを格納します。これを使用すると、現在のドキュメント内の任意のエラー、field、または Region にアクセスできます。

commandArgs.params.currentField

(Picture | Checkmark | Checkmark Groups | FieldsGroup | Table | TextField)

スクリプト呼び出し時点での field の状態を反映した field オブジェクトへの参照を返します。これは、上記で指定したドキュメントの一部です。

注: field の値がスクリプトの初期化後に変更された場合、その変更は反映されません。

commandArgs.params.appPath

String

サーバーのドメイン名です。

commandArgs.params.coordinates

Object
\[\{X1,X2,Y1,Y2}]

カスタム スクリプトを呼び出した DOM 要素の座標です。

commandArgs.params.currentElementDomId

String

カスタム スクリプトを呼び出した DOM 要素の ID です。
**関数** | **関数** | **説明** | | ------------------------------------- | ------------------------------------------ | | commandArgs.events.addEventHandler | カスタム スクリプトのグローバル コンテキストにイベント ハンドラーを追加します。 | | commandArgs.events.triggerHandlers | カスタム スクリプトのグローバル コンテキストでイベントをトリガーします。 | | commandArgs.events.removeEventHandler | カスタム スクリプトのグローバル コンテキストからイベント ハンドラーを削除します。 |

名前

型

権限

説明

Fields

(Picture | Checkmark | Checkmark Groups | FieldsGroup | Table | TextField)\[]

読み取り専用

field の配列

HasTableLayout

Boolean

読み取り専用

field Region がテーブルかどうかを示します。

Caption

String

読み取り専用

カスタム field 名、キャプション

FieldType

Number

読み取り専用

field タイプ。指定可能な値:

4 – field グループ

Id

Number

読み取り専用

Field ID

IsReadOnly

Boolean

読み取り専用

field を編集できないかどうかを示します。

IsVisible

Boolean

読み取り専用

field がデータ フォームに表示されるかどうかを示します。

MaxRegions

Number

読み取り専用

field Region の最大数。値が -1 の場合、Region 数は無制限です。

Name

String

読み取り専用

field の内部名。

NamePath

String\[]

読み取り専用

field へのパスを構成する field 名とグループ名の配列。

NeedRecognize

Boolean

読み取り/書き込み

ルールが再チェックされたときに、Region から field 値を取得するかどうかを示します。

Regions

\{
Id: number;
Status: number;
PageId: Number;
IsNew : Boolean;
Coordinates: Object
\[\{X1,X2,Y1,Y2}];
}\[]

読み取り専用

Region の配列。

  • Id – Region ID。
  • Status – Region のステータス。
    • 0 – Region が重ね合わされていない (またはRegion が削除されている)
    • 1 – Region が認識されていない
    • 2 – Region の値が field に代入される
  • PageId – Region があるページの ID。
  • IsNew – 新しいRegion を示すフラグ。
  • Coordinates – 画像内のRegion の座標。

名前

型

権限

説明

Fields

(Picture | Checkmark | Checkmark Groups | FieldsGroup | Table | TextField)\[]

読み取り専用

fieldの配列

Pageids

Number\[]

読み取り専用

セクションが存在するページの識別子。

IsFlexible

Boolean

読み取り専用

セクションが可変であるかどうかを指定します。

Caption

String

読み取り専用

カスタム field 名、キャプション

FieldType

Number

読み取り専用

Field の型。指定可能な値:

6 – セクション

Id

Number

読み取り専用

Field ID

IsReadOnly

Boolean

読み取り専用

field を編集できないかどうかを指定します。

IsVisible

Boolean

読み取り専用

field がデータ フォームに表示されるかどうかを指定します。

MaxRegions

Number

読み取り専用

field Region の最大数。値が -1 の場合、Region の数は無制限です。

Name

String

読み取り専用

field の内部名

NamePath

String\[]

読み取り専用

field へのパスを構成する field 名とグループ名の配列。

NeedRecognize

Boolean

読み取り/書き込み

ルールの再チェック時に、Region から field 値を取得するかどうかを指定します。

Regions

\{
Id: number;
Status: number;
PageId: Number;
IsNew : Boolean;
Coordinates: Object
\[\{X1,X2,Y1,Y2}];
}\[]

読み取り専用

Region の配列。

  • Id – Region ID。
  • Status – Region のステータス。
    • 0 – Region が重ね合わされていない (または Region が削除されている)
    • 1 – Region が認識されていない
    • 2 – Region の値が field に設定される
  • PageId – Region が存在するページのID。
  • IsNew – 新しい Region を示すフラグ。
  • Coordinates – 画像内の Region の座標。

名称

型

権限

説明

行

\{
Id: number;
RowNumber: number;
HasColorImage: boolean;
TableBlockID: number\[];
Cells: (Picture | Checkmark | CheckmarkGroup | TextField)\[];
}\[]

読み取り専用

テーブル行のリストです。

テーブル内の行オブジェクトのパラメーターは次のとおりです。

  • Id – 行の ID。
  • RowNumber – 0 から始まる行番号です。
  • TableBlockId – テーブルブロックへのパスを構成するセクション、テーブル、テーブルブロックの識別子です。
  • Cells – テーブルセル内の field です。field には、画像、チェックマーク、チェックマークグループ、テキストの各型があります。

キャプション

String

読み取り専用

カスタム field 名、キャプション

FieldType

Number

読み取り専用

fieldの型。指定可能な値:

7 – テーブル

ID

Number

読み取り専用

field ID

IsReadOnly

Boolean

読み取り専用

field を編集できないかどうかを指定します。

IsVisible

Boolean

読み取り専用

field がデータ フォーム上に表示されるかどうかを指定します。

MaxRegions

Number

読み取り専用

データ フォーム上で field を表示するかどうかを指定します。-1 の場合、region の数に制限はありません。

Name

String

読み取り専用

fieldのサービス名。

NamePath

String\[]

読み取り専用

field までのパスを構成する、field 名とグループ名の配列です。

NeedRecognize

Boolean

読み取り/書き込み

ルールを再チェックするときに、region から field の値を取得するかどうかを指定します。

Regions

\{
Id: number;
Status: number;
PageId: Number;
IsNew : Boolean;
Coordinates: Object
\[\{X1,X2,Y1,Y2}];
}\[]

読み取り専用

Region の配列。

  • Id – Region の ID。
  • Status – Region のステータス。
    • 0 – Region は重ね合わされていません (または Region は削除されています)
    • 1 – Region は認識されていません
    • 2 – Region の値が field に設定されます
  • PageId – Region が配置されているページの ID。
  • IsNew – 新しい Region であることを示すフラグ。
  • Coordinates – 画像内の Region の座標。

名前

型

権限

説明

Flags

Number\[]

読み取り/書き込み

field Value と同じ長さの配列です。0 と 1 で構成されます。

0 – Flags の 0 と同じ位置にある Value 内の文字は、検証が必要です。

候補値

String\[]

読み取り専用

候補のfield値の一覧

Value

String

読み取り/書き込み

field値

TextType

Number

読み取り専用

Text fieldの型。指定可能な値：

  • 0 – Text field。
  • 1 – 数値 field。
  • 2 – 通貨金額 field。
  • 3 – DateTime field。
  • 4 – Date field。
  • 5 – Time field。
  • 6 – Code field。

キャプション

String

読み取り専用

カスタム field の名前、キャプション

FieldType

Number

読み取り専用

fieldの型。指定可能な値：

0 – Text field

ID

数値

読み取り専用

Field ID

IsReadOnly

真偽値

読み取り専用

field を編集できないかどうかを指定します。

IsVisible

Boolean

読み取り専用

field がデータ フォームに表示されるかどうかを指定します。

MaxRegions

Number

読み取り専用

field region の最大数。値が -1 の場合、region 数に制限はありません。

Name

String

読み取り専用

fieldのサービス名。

NamePath

String\[]

読み取り専用

field までのパスを構成する field 名とグループ名の配列。

NeedRecognize

Boolean

読み取り/書き込み

ルールの再チェック時に、region から field の値を取得するかどうかを指定します。

Regions

\{
Id: number;
Status: number;
PageId: Number;
IsNew : Boolean;
Coordinates: Object
\[\{X1,X2,Y1,Y2}];
}\[]

読み取り専用

regionの配列。

  • Id – regionのID。
  • Status – regionのステータス。
    • 0 – regionは重ね合わされていない (またはregionは削除されている)
    • 1 – regionは認識されていない
    • 2 – regionの値がfieldに設定される
  • PageId – regionが存在するページのID。
  • IsNew – 新しいregionを示すフラグ。
  • Coordinates – 画像内のregionの座標。

IsVerified

真偽値

読み取り / 書き込み

field が検証済みかどうかを指定します。

NeedVerification

Boolean

読み取り専用

field の確認が必要かどうかを指定します。

NeedDoubleVerification

Boolean

読み取り専用

そのfieldに二重検証が必要かどうかを指定します

IsSummary

ブール値

読み取り専用

データ フォーム上でデータ サマリーを作成する際に、この field を使用するかどうかを指定します。

名称

型

権限

説明

Value

真偽値

読み取り/書き込み

fieldの値

キャプション

String

読み取り専用

カスタムfield名、キャプション

FieldType

Number

読み取り専用

fieldの型。指定可能な値:

2 – チェックマーク

ID

数値

読み取り専用

Field ID

IsReadOnly

Boolean

読み取り専用

field を編集できないかどうかを指定します。

IsVisible

Boolean

読み取り専用

field がデータ フォームに表示されるかどうかを指定します。

MaxRegions

Number

読み取り専用

field region の最大数。値が -1 の場合、region の数は任意です。

Name

String

読み取り専用

fieldのサービス名。

NamePath

String\[]

読み取り専用

field へのパスを構成する field 名と group 名の配列です。

NeedRecognize

Boolean

読み取り/書き込み可能

ルールの再チェック時に、region から field の値を取得するかどうかを指定します。

Regions

\{
Id: number;
Status: number;
PageId: Number;
IsNew : Boolean;
Coordinates: Object
\[\{X1,X2,Y1,Y2}];
}\[]

読み取り専用

regionの配列。

  • Id – regionのID。
  • Status – regionのステータス。
    • 0 – region は重なっていない (または削除されている)
    • 1 – region は認識されていない
    • 2 – region の値が field に設定されている
  • PageId – region が存在するページの ID。
  • IsNew – 新しい region を示すフラグ。
  • Coordinates – 画像内の region の座標。

IsVerified

Boolean

読み取り/書き込み

fieldが検証済みかどうかを指定します。

NeedVerification

Boolean

読み取り専用

field に対して検証が必要かどうかを指定します。

NeedDoubleVerification

真偽値

読み取り専用

この field に二重検証が必要かどうかを示します。

IsSummary

Boolean

読み取り専用

データ フォーム上のデータ サマリーの作成にその field を使用するかどうかを指定します。

名前

型

権限

説明

MaxSelectedCount

Number

読み取り専用

選択されたfieldの値の最大数。

MinSelectedCount

Number

読み取り専用

選択されたfield値の最小数。

値

Number\[]

読み取り/書き込み

field の値。指定可能な field 値のリスト (候補) を構成するレコード ID の配列です。

候補

\{Id:number, Name:string}\[]

読み取り専用

指定可能なfield値の一覧:

  • Id – レコード ID
  • Name – レコード名

キャプション

String

読み取り専用

カスタムfield名、キャプション

FieldType

Number

読み取り専用

fieldの型。指定可能な値:

3 – チェックマークグループ

ID

数値

読み取り専用

field ID。

IsReadOnly

Boolean

読み取り専用

field の編集が禁止されているかどうかを指定します。

IsVisible

Boolean

読み取り専用

field がデータ フォームに表示されるかどうかを指定します。

MaxRegions

Number

読み取り専用

field region の最大数。値が -1 の場合、region の数に制限はありません。

Name

String

読み取り専用

fieldのサービス名。

NamePath

String\[]

読み取り専用

field へのパスを構成する、field 名とグループ名の配列。

NeedRecognize

Boolean

読み取り/書き込み

ルールの再チェック時に、region から field の値を取得するかどうかを指定します。

Regions

\{
Id: number;
Status: number;
PageId: Number;
IsNew : Boolean;
Coordinates: Object
\[\{X1,X2,Y1,Y2}];
}\[]

読み取り専用

Region の配列。

  • Id – Region の ID。
  • Status – Region のステータス。
    • 0 – Region は重ね合わされていません (Region は削除されています)
    • 1 – Region は認識されていません
    • 2 – Region の値が field に設定されます
  • PageId – Region が配置されているページの ID。
  • IsNew – 新しい Region であることを示すフラグ。
  • Coordinates – 画像内の Region の座標。

IsVerified

ブール値

読み取り/書き込み

field が検証済みかどうかを指定します。

NeedVerification

Boolean

読み取り専用

field の検証が必要かどうかを指定します。

NeedDoubleVerification

Boolean

読み取り専用

このfieldに二重検証が必要かどうかを指定します。

IsSummary

Boolean

読み取り専用

field がデータ フォーム上のデータ サマリーの生成に使用されるかどうかを指定します。

名前

型

権限

説明

Caption

String

読み取り専用

カスタム field 名、キャプション

FieldType

Number

読み取り専用

field タイプ。指定可能な値:

1 – 画像

Id

Number

読み取り専用

field ID。

IsReadOnly

Boolean

読み取り専用

field の編集が禁止されているかどうかを示します。

IsVisible

Boolean

読み取り専用

field がデータ フォームに表示されるかどうかを示します。

MaxRegions

Number

読み取り専用

field Region の最大数。値が -1 の場合、Region 数は無制限です。

Name

String

読み取り専用

field の内部名。

NamePath

String\[]

読み取り専用

field へのパスを構成する field 名とグループ名の配列。

Regions

\{
Id: number;
Status: number;
PageId: Number;
IsNew : Boolean;
Coordinates: Object
\[\{X1,X2,Y1,Y2}];
}\[]

読み取り専用

Region の配列。

  • Id – Region ID。
  • Status – Region のステータス。
    • 0 – Region が重ね合わされていない (または Region が削除されている)
    • 1 – Region が認識されていない
    • 2 – Region の値が field に反映される
  • PageId – Region があるページの ID。
  • IsNew – 新しい Region を示すフラグ。
  • Coordinates – 画像内の Region の座標。

名前

型

権限

説明

Id

Number

読み取り専用

field ID

Name

String

読み取り専用

field名

Sections

Section\[]

読み取り専用

Section 型の field 配列

FieldType

Number

読み取り専用

field 型。

指定可能な値:

8 – 繰り返しセクショングループ。

Name

型

権限

説明

AssemblingErrors

\{
DocumentNodeRef: number\[]\[];
Description: string;
SectionName: string\[]
}\[]

読み取り専用

ドキュメント内の組み立てエラー。各エラーには次が含まれます。

  • DocumentNodeRef – フォーム内の field へのリンクのリスト (field ID の配列)
  • Description – エラーの説明
  • SectionName – エラーに関連するセクションのリスト

BatchId

数値

読み取り専用

パッケージのID

エラー

\{
DocumentNodeRef: number\[]\[];
Severity: number;
Message: string;
RuleName: string;
}\[]

読み取り専用

ドキュメント内のエラー。各項目の意味は次のとおりです。

  • DocumentNodeRef – フォーム内の field へのリンクのリスト (field ID の配列)
  • Severity:
    • 1 – エラー
    • 0 – 警告
  • Message – エラーメッセージ
  • RuleName – エラーの原因となったルール名

Fields

(Section | SectionsGroup)\[]

読み取り専用

section/duplicate section の一覧

ID

数値

読み取り専用

ドキュメント識別子

Index

Number

読み取り専用

パッケージ内のドキュメントのインデックス

Pages

\{
Id: number;
Modification: number;
HasColorImage: boolean;
ImageResolution: number;
KeyValue: string;
SectionTemplateId: number;
SectionTemplateName: string;
FlexibleInstanceId: number;
SectionTemplatePageNumber: number;
Comment: string;
ImageWidth: number;
ImageHeight: number;
}\[]

読み取り専用

以下を含む文書ページのList：

  • Id – ページID
  • Modification – ページのリビジョン番号
  • HasColorImage – ページがカラー画像かどうかを示します
  • ImageResolution – 画像解像度
  • KeyValue – ページのキーフィールドの値
  • SectionTemplateId – ページのセクションID
  • SectionTemplateName – ページセクション名
  • SectionTemplatePageNumber – セクション内のページ番号
  • Comment – ページに関するコメント
  • ImageWidth – ページ画像の幅
  • ImageHeight – ページ画像の高さ

ProjectId

数値

読み取り専用

プロジェクト ID

TaskId

数値

読み取り専用

タスク ID

TemplateId

数値

読み取り専用

文書の定義ID

TemplateName

String

読み取り専用

定義ドキュメント名

TemplateVersion

Number

読み取り専用

ドキュメント定義のバージョン

バージョン

数値

読み取り専用

ドキュメントのバージョン