commandArgs 変数を使用します。
このセクションのすべての変数はグローバル変数であり、プログラム全体で参照できます。
fields を操作する関数
fields を操作する関数
getCurrentField() | 現在のカスタム スクリプトで使用されているfield オブジェクトへのリンクを返します。 |
getFieldByName(namesPath) (*) | カスタム スクリプトが開かれている field へのリンクを返します。 例:
|
getFieldValue(namesPath) (*) | 戻り値:
namesPath | fieldObject:
|
setCurrentFieldValue(value, forced, onSaved) | カスタム スクリプトを開いている field の値を変更します。 パラメーター:
|
setFieldValue(namesPath | field, value, forced, onSaved) (*) | field の値を変更します。 パラメーター:
|
save() | カスタム スクリプトを実行しているウィンドウを閉じ、変更を保存します。 |
cancel() | 変更を保存せずに、カスタム スクリプトの実行ウィンドウを閉じます。 |
(*) 上記に挙げた一部の関数では、field へのパスを入力パラメーターとして指定します。このパスは、field 名と親要素 (field グループ、セクション) の名前で構成されます。テーブル、繰り返しテーブル、および繰り返しグループでは、0 (ゼロ) から始まるインスタンス番号を指定する必要があります。 例: ここで [10] は、繰り返しグループのインスタンス番号です。 | |
データセットを扱うための関数
データセットを扱うための関数
addEntity(entityInfo: {cacheName, columns, values}, onResult(newId)) | データセットにエントリを追加します。 パラメーター:
|
editEntity(entityInfo: {cacheName, columns, values}, onResult()) | データベース内のエントリを編集します。 パラメーター:
|
getDict({cacheName, filters: [{FieldName, FieldValue}], cursorPos, allowMultipleColumnResults}, onResult (param: { FieldName, FieldValue, BoldMask}[][]) ) | 指定した値、またはその一部についてデータセットを検索します。一致した文字列を次の形式で返します。 [{FieldName パラメーター:
たとえば、データセットに次の内容があるとします。 CompanyName: ABBYY ”ABB” という文字列を検索するとします。 その場合、次の内容が返されます。 [ [ { FieldName: ‘CompanyName’, FieldValue: ‘ABBYY’, BoldMask: ‘11100’ }, ] ] 注: 返される配列には、最初は検索条件に適合していなかった値も含めて、複数の値が含まれる場合があります。配列内の検索結果は BoldMask パラメーターの値の降順 (つまり、検索条件に最もよく一致する文字列から) で並べ替えられます。 |
getDictAll({cacheName, filters: {FieldName, FieldValue}}, }, onResult (param: { FieldName, FieldValue, BoldMask}[][])) | 指定した完全な値に対してデータベース検索を実行します。見つかったすべてのfieldの値を返します。 パラメーター:
[ [ { FieldName: ‘CompanyName’, FieldValue: ‘ABBYY’, BoldMask: ‘11100’ }, ] ] 注: 返される配列には、最初の検索条件に一致しなかった値を含め、複数の値が含まれる場合があります。配列内の検索結果は、 BoldMask パラメーターの値の降順 (つまり、検索条件に最もよく一致する文字列から) で並べ替えられます。 |
ドキュメントフォームの操作に使用する関数
ドキュメントフォームの操作に使用する関数
commandArgs オブジェクトのプロパティ
commandArgs オブジェクトのプロパティ
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 | カスタム スクリプトを呼び出した DOM 要素の座標です。 |
commandArgs.params.currentElementDomId | String | カスタム スクリプトを呼び出した DOM 要素の ID です。 |
| 関数 | 説明 |
|---|---|
| commandArgs.events.addEventHandler | カスタム スクリプトのグローバル コンテキストにイベント ハンドラーを追加します。 |
| commandArgs.events.triggerHandlers | カスタム スクリプトのグローバル コンテキストでイベントをトリガーします。 |
| commandArgs.events.removeEventHandler | カスタム スクリプトのグローバル コンテキストからイベント ハンドラーを削除します。 |
field グループ field
field グループ field
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 | {
| 読み取り専用 | Region の配列。
|
セクション field
セクション field
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 | {
| 読み取り専用 | Region の配列。
|
テーブル 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 | {
| 読み取り専用 | Region の配列。
|
テキスト入力フィールド
テキスト入力フィールド
Flags | Number[] | 読み取り/書き込み | field Value と同じ長さの配列です。0 と 1 で構成されます。 0 – Flags の 0 と同じ位置にある Value 内の文字は、検証が必要です。 |
候補値 | String[] | 読み取り専用 | 候補のfield値の一覧 |
Value | String | 読み取り/書き込み | field値 |
TextType | Number | 読み取り専用 | Text 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 | {
| 読み取り専用 | regionの配列。
|
IsVerified | 真偽値 | 読み取り / 書き込み | field が検証済みかどうかを指定します。 |
NeedVerification | Boolean | 読み取り専用 | field の確認が必要かどうかを指定します。 |
NeedDoubleVerification | Boolean | 読み取り専用 | そのfieldに二重検証が必要かどうかを指定します |
IsSummary | ブール値 | 読み取り専用 | データ フォーム上でデータ サマリーを作成する際に、この field を使用するかどうかを指定します。 |
チェックマーク field
チェックマーク 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 | {
| 読み取り専用 | regionの配列。
|
IsVerified | Boolean | 読み取り/書き込み | fieldが検証済みかどうかを指定します。 |
NeedVerification | Boolean | 読み取り専用 | field に対して検証が必要かどうかを指定します。 |
NeedDoubleVerification | 真偽値 | 読み取り専用 | この field に二重検証が必要かどうかを示します。 |
IsSummary | Boolean | 読み取り専用 | データ フォーム上のデータ サマリーの作成にその field を使用するかどうかを指定します。 |
チェックマークグループfield
チェックマークグループfield
MaxSelectedCount | Number | 読み取り専用 | 選択されたfieldの値の最大数。 |
MinSelectedCount | Number | 読み取り専用 | 選択されたfield値の最小数。 |
値 | Number[] | 読み取り/書き込み | field の値。指定可能な field 値のリスト (候補) を構成するレコード ID の配列です。 |
候補 | {Id:number, Name:string}[] | 読み取り専用 | 指定可能なfield値の一覧:
|
キャプション | 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 | {
| 読み取り専用 | Region の配列。
|
IsVerified | ブール値 | 読み取り/書き込み | field が検証済みかどうかを指定します。 |
NeedVerification | Boolean | 読み取り専用 | field の検証が必要かどうかを指定します。 |
NeedDoubleVerification | Boolean | 読み取り専用 | このfieldに二重検証が必要かどうかを指定します。 |
IsSummary | Boolean | 読み取り専用 | field がデータ フォーム上のデータ サマリーの生成に使用されるかどうかを指定します。 |
画像 field
画像 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 | {
| 読み取り専用 | Region の配列。
|
セクションの繰り返しグループ field
セクションの繰り返しグループ field
名前 | 型 | 権限 | 説明 |
Id | Number | 読み取り専用 | field ID |
Name | String | 読み取り専用 | field名 |
Sections | Section[] | 読み取り専用 | Section 型の field 配列 |
FieldType | Number | 読み取り専用 | field 型。 指定可能な値: 8 – 繰り返しセクショングループ。 |
document オブジェクトのプロパティ
document オブジェクトのプロパティ
AssemblingErrors | {
| 読み取り専用 | ドキュメント内の組み立てエラー。各エラーには次が含まれます。
|
BatchId | 数値 | 読み取り専用 | パッケージのID |
エラー | {
| 読み取り専用 | ドキュメント内のエラー。各項目の意味は次のとおりです。
|
Fields | (Section | SectionsGroup)[] | 読み取り専用 | section/duplicate section の一覧 |
ID | 数値 | 読み取り専用 | ドキュメント識別子 |
Index | Number | 読み取り専用 | パッケージ内のドキュメントのインデックス |
Pages | {
| 読み取り専用 | 以下を含む文書ページのList:
|
ProjectId | 数値 | 読み取り専用 | プロジェクト ID |
TaskId | 数値 | 読み取り専用 | タスク ID |
TemplateId | 数値 | 読み取り専用 | 文書の定義ID |
TemplateName | String | 読み取り専用 | 定義ドキュメント名 |
TemplateVersion | Number | 読み取り専用 | ドキュメント定義のバージョン |
バージョン | 数値 | 読み取り専用 | ドキュメントのバージョン |
