Your use of this site is conditioned on Your continued compliance with the Terms of Use.

I have read Terms of Use. I am aware I may use the Site and/or its Content for personal use only in accordance with the Terms of Use, as a part of my relationship with ABBYY. It’s expressly forbidden to use the Site and/or its Content for competitive and benchmarking purposes.

IF YOU DO NOT AGREE, DO NOT USE THE SITE.

Terms of Use

The sites https://www.abbyy.com/, https://help.abbyy.com/ and other ABBYY-owned sites (collectively, “Site”) are the property of ABBYY Development Inc. and affiliates, the ABBYY group companies ("ABBYY") and its licensors. BY USING THE SITE, YOU AGREE TO THESE TERMS OF USE; IF YOU DON’T AGREE, DO NOT USE THE SITE.

The services and information that ABBYY provides to You are subject to the following Terms of Use (referred to as “Terms”). ABBYY reserves the right, at its sole discretion, to change, modify, add or remove portions of these Terms, at any time. It is Your responsibility to check these Terms for amendments. ABBYY reserves the right to do any of the following, at any time, without notice: to modify, suspend or terminate operation of or access to the Site, or any portion of the Site, for any reason; to modify or change the Site, or any portion of the Site; and to interrupt the operation of the Site or any portion of the Site for maintenance or other reason. You may not use the Site or any Content for any purpose that is unlawful or prohibited by these Terms, or to solicit the performance of any illegal activity or other activity which infringes the rights of ABBYY or others. You agree that ABBYY may, in its sole discretion and without prior notice, terminate Your access to the Site and/or block Your future access to the Site if ABBYY finds that You have violated these Terms or other agreements. You agree that any violation by You of these Terms will constitute an unlawful and unfair business practice. You agree that ABBYY may, in its sole discretion and without prior notice, terminate Your access to the Site. You agree that ABBYY will not be liable to You or to any third party for termination of Your access to the Site as a result of any violation of these Terms.

Your continued use of the Site means that You agree to the amendments. As long as You comply with these Terms, ABBYY grants You a personal, non-exclusive, non-transferable, limited right to enter and use the Site.

Disclaimer of Warranty

All materials contained herein, the Site and any Content, service or features are provided "AS IS" and "AS-AVAILABLE" without warranty of any kind. ABBYY disclaims all warranties of any kind, including all warranties and conditions of accuracy, merchantability, whether express implied or statutory, fitness for a particular purpose, defects-free, virus-free, contamination title and non-infringement, specific results warranty. Any use of the materials of this site is at Your own discretion and risk and You are solely responsible for any damage to Your computer system, including but not limited to loss of data.

ABBYY DISCLAIMS ALL LIABILITY FOR THE ACTS, OMISSIONS AND CONDUCT OF ANY THIRD PARTIES IN CONNECTION WITH OR RELATED TO YOUR USE OF THE SITE AND/OR ANY SERVICES. YOU ASSUME TOTAL RESPONSIBILITY FOR YOUR USE OF THE SITE AND ANY LINKED SITES AND PAGES. YOUR SOLE REMEDY AGAINST ABBYY FOR DISSATISFACTION WITH THE SITE OR ANY CONTENT IS TO STOP USING THE SITE OR ANY SUCH CONTENT.

Limitation of Liability

Under no circumstances shall ABBYY be liable for any kind of damages, indirect or consequential, exemplary, incidental or punitive damages, including, without limitation loss of profits or revenues and/or costs of replacement goods and all damages resulting from (i) downloading of any software available, (ii) use of the Content or the Site, or the service, or the software, (iii) ABBYY's failure to provide services, whether in action of contract, negligence or other tortuous action even if ABBYY has been informed in advance of the possibility of such damages.If, notwithstanding the other provisions of these Terms, ABBYY is found to be liable to You for any damage or loss which arises out of or is in any way connected with Your use of the Site or any Content, ABBYY’s liability shall in no event exceed fifty US dollars. Some jurisdictions do not allow limitations of liability, so the foregoing limitation may not apply to You.

Transmission and Submission of Information

ABBYY does not guarantee the security of any information transmitted to or from the Site. Any material, information or other communication You transmit or post to this Site will be considered non-confidential. ABBYY will have no obligations with respect to such communications. Additionally, by using the Site, You acknowledge and agree that Internet transmissions are never completely secure. You understand that any message or information You send to the Site may be read or intercepted by others.

By transmitting or posting any information You grant ABBYY an unrestricted royalty free right to copy, disclose, distribute, otherwise dispose and use of such information.

While browsing through this site You agree to refrain from posting or transmitting to or from this Site any unlawful material that may violate any domestic and/or international legislation.

ABBYY may at it's own discretion monitor or review any areas on this site where users transmit or post materials or communicate solely with each other, including but not limited to any kind of chat rooms or user forums. ABBYY will have no liability related to the content of any such areas.

Relevant ABBYY Privacy Policy (Notice) and Cookie Policy (if applicable) apply to use of this Site, and its terms are made a part of these Terms by this reference. In conflict, Privacy Policy (Notice) and Cookie Policy provisions prevail. If You choose to provide ABBYY with your personal information (including but not limited to via web-forms located at the Site), your personal information will be treated in accordance with relevant Privacy Policy (Notice) which is available via link displayed on the same webpage where such information is collected.

Downloads

Any software that is made available to download from this Site is the copyrighted work of ABBYY and/or its suppliers. Such software shall be used in accordance with the respective terms of the end user license agreement (EULA) or terms of service which accompany the software. Any use of the Software not in accordance with the respective agreement is expressly prohibited. ABBYY’s obligations, if any, with regard to its products and services are governed by the agreements pursuant to which they are provided, and nothing on this Site should be construed to alter such agreements.

Should ABBYY make available certain materials for downloading from the Site and expressly agree upon it, You may use information on ABBYY products and services, provided that You (a use such information only for Your personal, non-commercial informational purpose, (b) make no modifications to any such information (c) do not remove any proprietary notices in all copies of such documentation, and (d) not make any additional representations or warranties relating to such documentation. It is expressly forbidden to use the Site or its Content for benchmarking and competitive purposes.

If there is a conflict between these Terms and the terms posted for or applicable to a specific portion of the Site or for any service offered on or through the Site, the latter terms shall control with respect to Your use of that portion of the Site or the specific service.

ABBYY may make changes to any products or services offered on the Site, or to the applicable prices for any such products or services, at any time, without notice. The materials on the Site with respect to products and services may be outdated, and ABBYY makes no commitment to update the materials on the Site with respect to such products and services. ABBYY provides access to ABBYY international data and documentation and may contain references to products and services that are not offered in every country. Such reference does not imply that ABBYY intends to offer such products or services in Your country. Although the Site is accessible worldwide, not all features, products or services referenced or offered through or on the Site are available to all persons or in all geographic locations. ABBYY reserves the right to limit, in its sole discretion, the provision and quantity of any Content, feature, product or service to any person or geographic area. Any offer for any feature, product or service made on the Site is void where prohibited.

Use of Content

All the text, communications, software, scripting, photos, text, video, visual interfaces, graphics, trademarks, logos, music, sounds, images, artwork and computer code and other materials (collectively "Content") are owned, controlled or licensed by or to ABBYY and are protected by intellectual property, competition laws and are provided by ABBYY as a service to its customers only and is exclusively for personal use. Except as expressly provided in these Terms, You may not use any portion of this Site or the Content without ABBYY’s express prior written consent. Usage for benchmarking or competitive purpose is expressly prohibited.

Trademarks

The trademarks, logos, and service marks (collectively "Trademarks") appearing on the ABBYY website are the property of ABBYY, its licensorsand other third-parties. All Trademarks are provided for Your information and do not grant You a license to use them. Neither title nor intellectual property rights are transferred to You.A list of third-party Trademarks and patents is available here.

Links to Third-Party Sites

This site may provide links to other third-party sites. ABBYY makes no representations whatsoever about any other site which You may access through this site. You acknowledge and agree that ABBYY is not responsible for the content of any linked site or any link contained in a linked site.

References on this site to any names, marks, products or services of any third parties or hypertext links to third party sites or information are provided solely as a convenience to You. ABBYY does not endorse or recommend content of such sites.

Mentioning non ABBYY products or services is for informational purposes only and constitutes neither an endorsement, nor a recommendation.

Foreign Legislation

These Terms constitute the entire agreement between You and ABBYY with regard to Your use of the Site, and any and all other written or oral agreements or understandings previously existing between You and ABBYY with respect to such use are hereby superseded. ABBYY’s failure to enforce strict performance of these Terms shall not be construed as a waiver by ABBYY of any provision or any right it has to enforce these Terms, nor shall any course of conduct between ABBYY and You or any other party be deemed to modify any provision of these Terms. These Terms shall not be interpreted or construed to confer any rights or remedies on any third parties.

ABBYY does not warrant compliance with any foreign legislation. If You access the Site, You are solely responsible for compliance with all applicable local laws.

You may not use or export or re-export any Content or any copy or adaptation of such Content, or any product or service offered on the Site, in violation of any applicable laws or regulations, including without limitation international export control laws and regulations, and/or for competition and benchmarking.

Subscription Terms

The Subscription terms incorporate terms on subscription, billing and payment procedure for the use of ABBYY Software on a subscription-based model. You can review the full terms here.

Partner Subscription Terms

The Partner Subscription Terms incorporate terms on subscription, billing and payment procedure for the use of ABBYY Software on a Subscription-based model by partners. You can review the full terms here.

Copyright © 2021 ABBYY Development Inc.

May 2021

Japanese (日本語)

オブジェクト

以下は、カスタムスクリプトの作成に使用できる関数のリストです。オブジェクトインスタンスにアクセスするには、commandArgs変数を使用してください。

この章で取り扱っている変数はいずれもグローバル変数で、プログラム全体をとおして表示されます。

フィールドを扱う関数

関数	摘要
getCurrentField()	現在のカスタムスクリプトを使用するフィールドオブジェクトのリンクを返します。
getFieldByName(namesPath)(*)	カスタムスクリプトが開かれているフィールドへのリンクを返します。例： ['Document Section 1', 'Group[10]','Field3']、ここでの[10]は繰り返しグループのインスタンスの番号です。 namesPathはフィールドとグループ名を含む配列で、フィールドへのパスまたはフィールドオブジェクトへのリンクを形成するものです。
getFieldValue(namesPath)(*)	以下を返します：文字列、テキストフィールドフィールド；チェックマーク値、チェックマークフィールド向け；文字列、チェックマークグループフィールド向け。 namesPath \| fieldObject：フィールド名とグループ名を含む配列で、フィールドへのパスまたはフィールドオブジェクトへのリンクを形成するもの、またはフィールドオブジェクトへのリンクを形成するものです。
setCurrentFieldValue(value、forced、onSaved)	カスタムスクリプトが開かれたフィールド値を変更します。パラメーター：値– フィールド値。 forced– フィールド値を更新し、新しいデータを記録します。このパラメーターはオプションです。 false– 文書定義のフィールド値は、save（）関数が呼び出された後にのみ更新されます。 true– 文書定義のフィールド値がすぐに更新されます。カスタムスクリプトの場合、モードに関係なく更新が行われます。このパラメーターは、デフォルトではつぎのように設定されています：false。 onSaved– コールバック関数。この関数が呼び出されるのは、つぎのような場合です：forcedのパラメーターがつぎのように設定されている→true。このパラメーターはオプションです。
setFieldValue(namesPath \| field、value、forced、onSaved)(*)	フィールド値を変更します。パラメーター： namesPath \| fieldObject：フィールド名とグループ名を含む配列で、フィールドへのパスを形成するか、またはフィールドオブジェクトへのリンクを形成するものです。値– 関連するフィールドの値。 forced– フィールド値を更新し、新しいデータを記録します。このパラメーターはオプションです。 false– 文書定義のフィールド値は、save（）関数が呼び出された後にのみ更新されます。 true– 文書定義のフィールド値がすぐに更新されます。カスタムスクリプトの場合、モードに関係なく更新が行われます。このパラメーターは、デフォルトではつぎのように設定されています：false。 onSaved– コールバック関数。この関数が呼び出されるのは、つぎのような場合です：forcedのパラメーターがつぎのように設定されている→true。このパラメーターはオプションです。
save（）	カスタムスクリプトが実行されるウィンドウを閉じ、変更を保存します。
cancel()	カスタムスクリプトが実行されるウィンドウを閉じますが、変更は保存しません。
*()*上記の一部の関数では、フィールドへのパスが入力パラメーターとして設定されています。これは、フィールド名と親要素（フィールドグループ、セクション）の名称で構成されます。テーブル、繰り返しテーブル、繰り返しグループの場合、0（ゼロ）から始まるインスタンス番号を設定する必要があります。例： ['Document Section 1', 'Group[10]','Field3']、* ここでの[10]は繰り返しグループのインスタンスの番号です。

データセットを扱う関数

関数	摘要
addEntity(entityInfo: {cacheName, columns, values}, onResult(newId))	データベースにエントリーを追加します。パラメーター： entityInfo– オブジェクト： cacheName–データセットの名前。 columns–データが記録される列の名前。文字列の配列。 values– 関連する列の値。文字列の配列。 onResult–データセットに作成されたレコードのIDを受け取るコールバック関数。
editEntity(entityInfo: {cacheName, columns, values}, onResult())	データベースのエントリーを編集します。パラメーター： entityInfo– オブジェクト： cacheName–データセットの名前。 columns–データが記録される列の名前。文字列の配列。 values– 関連する列の値。文字列の配列。 onResult–– コールバック関数。
getDict({cacheName, filters: [{FieldName, FieldValue}], cursorPos, allowMultipleColumnResults}, onResult (param: { FieldName, FieldValue, BoldMask}[][]) )	指定された値またはその一部のデータセット検索を実行します。一致する文字列をつぎの形式で返します： [{FieldName FieldValue BoldMask}]. パラメーター： cacheName–データセット名。 filters– 検索パラメーター： FieldName–フィールド名。すべてのフィールドを検索するため空のままにしておきます。 FieldValue– フィールド値。 cursorPos– 入力フィールド内のカーソルの位置。値が部分的に入力され、カーソルが入力された文字等の後にある場合、それらは検索する値のプレフィックスとみなされます。カーソルが部分的に入力された単語の前にある場合、それらの文字等は検索する値の末尾とみなされます。例えば、会社名を検索するときに「ADO」と入力し、その後ろにカーソルがある場合、値「AVOCADO」が選択されます。「ADO」と入力してカーソルをその前に置くと、「ADONIS」という値が選択されます allowMultipleColumnResults–検出されたフィールドの値を返します。データセットに含まれるエントリのなかには、ひとつのフィールド名（FieldName）が複数のフィールド値に対応するものがあります（FieldValue）。例えば、CompanyName列では、会社名のバリエーションを2つ以上設定することができます。この場合： true– 検索条件を満たすすべてのフィールド値を返し記録します、 false– 検索条件に最も適合する単一の結果を返し記録します。 onResult– 検索結果の配列を返すコールバック関数。各結果は、文字列配列であるデータセットからの単一の文字列となります。各文字列は、フィールド名、その値、および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}[][]))	指定値全体についてデータベース検索を実行します。検出されたすべてのフィールドの値を返します。パラメーター： cacheName― データセット名。 Filters– オブジェクト配列： FieldName― フィールド名。すべてのフィールドを検索するには、ここを空欄のままにしてください。 FieldValue– フィールド値。 onResult– 検索結果の配列を返すコールバック関数。各結果は、文字列配列であるデータセットからの単一の文字列となります。各文字列は、フィールド名、その値、およびBoldMaskパラメーターで構成されています。 BoldMask–文字列で、「0」と「1」からなり、検索中に見つかった値と長さが同じです。「1」は、見つかった値のうち、検索フィールドで対応する文字等と一致する文字等を表しており、「0」は一致しない文字等を表しています。例えば、つぎがデータセットに存在する場合： CompanyName: ABBYY いま仮に「ABB」という文字を検索するとします。そうすると、以下のものが返されてきます。 [ [ { FieldName: ‘CompanyName’, FieldValue: ‘ABBYY’, BoldMask: ‘11100’ }, ] ] 注：返される配列には、最初に検索条件に適合しなかった値をはじめ、いくつかの値を含めることができます。配列内の検索結果は、BoldMask パラメーター値により、降順にソートされます（検索条件に最も一致する文字列が先頭）。
データベース検索スクリプトのサンプル

文書形式で作業するための関数

関数	摘要
selectRow(tablePath、rowNumber)(*)	テーブル行を選択済みとしてマークします。 tablePath \| fieldObject：フィールド名とグループ名を含む配列で、テーブルフィールドへのパスを形成するか、またはテーブルオブジェクトへのリンクを形成するためのものです。 rowNumber– 選択する行の番号、ゼロベース。
deselectRow（tablePath、rowNumber?）(*)	テーブル行から選択を削除します。 tablePath \| fieldObject：フィールド名とグループ名を含む配列で、テーブルフィールドへのパスを形成するか、テーブルオブジェクトへのリンクを形成するためのものです。 rowNumber– 選択解除する行の番号、ゼロベース、省略した場合、テーブルのすべての行が選択から外れます。
scrollFormToField(namesPath)(*)	フォームエディタをスクロールして、フィールドを表示します。 namesPath \| fieldObject：フィールド名とグループ名を含む配列で、テーブルフィールドへのパスを形成するか、またはテーブルオブジェクトへのリンクを形成するためのものです。
getDomElementPosition(domId, onResult: (result?: {width, height, top, left, right, bottom}))	フォームエディタウィンドウ内の要素の位置を取得し、コールバック関数の結果を返します。 domId– 要素のIDで、形式はDOM。 onResult–ブラウザウィンドウの左上隅を基準とした要素のDOM座標（幅、高さ、上、左、右、下）を持つオブジェクトを受け取るコールバック関数。
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–コールバック関数。
*()*上記の一部の関数では、フィールドへのパスが入力パラメーターとして設定されています。これは、フィールド名と親要素（フィールドグループ、セクション）の名称で構成されます。テーブル、繰り返しテーブル、繰り返しグループの場合、ゼロから始まるインスタンス番号を設定する必要があります。例： ['Document Section 1', 'Group[10]','Field3']、* ここでの[10]は繰り返しグループのインスタンスの番号です。

commandArgsオブジェクトのプロパティ

変数

変数	型	摘要
commandArgs.params.document	文書	開いている文書のオブジェクトのコピーを保存します。これを使用することで、現在の文書のエラー、フィールド、領域にアクセスできるようになります。
commandArgs.params.currentField	（画像 \| チェックマーク \| チェックマークグループ \| フィールドグループ \| 表 \| テキストフィールド）	スクリプトが呼び出されたときのフィールドの状態を反映するフィールドオブジェクトへのリンクを返します。上記文書の一部。注：スクリプトが初期化された後にフィールド値が変更された場合は、変更は適用されません。
commandArgs.params.appPath	文字列	サーバーのドメイン名。
commandArgs.params.coordinates	オブジェクト [{X1,X2,Y1,Y2}]	カスタムスクリプトを呼び出したDOM要素の座標。
commandArgs.params.currentElementDomId	文字列	カスタムスクリプトを呼び出したDOM要素のID。

関数

関数	摘要
commandArgs.events.addEventHandler	カスタムスクリプトのグローバルコンテキストにイベントハンドラを追加します。
commandArgs.events.triggerHandlers	カスタムスクリプトのグローバルコンテキストでイベントトリガを実行します。
commandArgs.events.removeEventHandler	カスタムスクリプトのグローバルコンテキストのイベントハンドラを削除します。

フィールドグループフィールド

名前	型	権利	摘要
フィールド	（画像 \| チェックマーク \| チェックマークグループ \| フィールドグループ \| 表 \| テキストフィールド）[]	読み取り専用	フィールドの配列
HasTableLayout	ブーリアン	読み取り専用	フィールド領域を表にするかどうかを設定します。
キャプション	文字列	読み取り専用	カスタムフィールド名、キャプション
フィールドタイプ	番号	読み取り専用	フィールドのタイプ。可能な値： 4― フィールドグループ
ID	番号	読み取り専用	フィールドID
IsReadOnly	ブーリアン	読み取り専用	フィールドの編集を禁止するかどうかを設定します。
IsVisible	ブーリアン	読み取り専用	フィールドをデータフォームで表示するかどうかを設定します。
MaxRegions	番号	読み取り専用	フィールド領域の最大数。値が-1の場合、任意の領域数が許可されます。
名前	文字列	読み取り専用	フィールドのサービス名。
NamePath	String[]	読み取り専用	フィールドへのパスを形成するフィールド名とグループ名の配列。
NeedRecognize	ブーリアン	読み取り/書き込み	ルールが再度チェックされるときに、領域からフィールド値を取得するかどうかを設定します。
領域	{ Id: number; Status: number; PageId: Number; IsNew : Boolean; Coordinates: Object [{X1,X2,Y1,Y2}] }[]	読み取り専用	領域の配列。 ID–領域ID。ステータス– 領域のステータス。 0– 領域が重なっていません（または領域が削除されています） 1– 領域が認識されていません 2– 領域の値がフィールドに代入されますページID– 領域が配置されているページのID。 IsNew– 新しい領域を示すフラグ。 Coordinates– 画像内の領域の座標。

セクションフィールド

名前	型	権利	摘要
フィールド	（画像 \| チェックマーク \| チェックマークグループ \| フィールドグループ \| 表 \| テキストフィールド）[]	読み取り専用	フィールドの配列
ページID	Number[]	読み取り専用	– セクションが配置されているページのID。
IsFlexible	ブーリアン	読み取り専用	セクションをフレキシブルにするかどうかを設定します。
キャプション	文字列	読み取り専用	カスタムフィールド名、キャプション
フィールドタイプ	番号	読み取り専用	フィールドのタイプ。可能な値： 6― セクション
ID	番号	読み取り専用	フィールドID
IsReadOnly	ブーリアン	読み取り専用	フィールド編集を不可にするかセクション内で
IsVisible	ブーリアン	読み取り専用	フィールドをデータフォームで表示するかどうかを設定します。
MaxRegions	番号	読み取り専用	フィールド領域の最大数。値が-1の場合、任意の領域数が許可されます。
名前	文字列	読み取り専用	フィールドのサービス名
NamePath	String[]	読み取り専用	フィールドへのパスを形成するフィールド名とグループ名の配列。
NeedRecognize	ブーリアン	読み取り/書き込み	ルールが再度チェックされるときに、領域からフィールド値を取得するかどうかを設定します。
領域	{ Id: number; Status: number; PageId: Number; IsNew : Boolean; Coordinates: Object [{X1,X2,Y1,Y2}] }[]	読み取り専用	領域の配列。 ID - 領域ID。 Status – 領域のステータス。 0– 領域が重なっていません（または領域が削除されています） 1– 領域が認識されていません 2– 領域の値がフィールドに代入されます PageId – 領域が配置されているページのID。 IsNew – 新しい領域を示すフラグ。 Coordinates – 画像内の領域の座標。

テーブルフィールド

名前	型	権利	摘要
行	{ Id: number; RowNumber: number; HasColorImage: boolean; TableBlockID: number[]; Cells: (Picture \| Checkmark \| CheckmarkGroup \| TextField)[]; }[]	読み取り専用	表の行のリスト。表中のオブジェクトの行のパラメーター： ID– 行のID。 RowNumber– ゼロから数えた行のシーケンス番号。 TableBlockId– セクション、表、テーブルブロックのIDのうち、テーブルブロックへのパスを形成するもの。 Cells– 表中のセルのフィールド。フィールドにはつぎの種類があります：画像、チェックマーク、チェックマークグループ、テキスト。
キャプション	文字列	読み取り専用	カスタムフィールド名、キャプション
フィールドタイプ	番号	読み取り専用	フィールドのタイプ。可能な値： 7- 表
ID	番号	読み取り専用	フィールドID
IsReadOnly	ブーリアン	読み取り専用	フィールド編集を不可にするかどうかを設定します。
IsVisible	ブーリアン	読み取り専用	フィールドをデータフォームで表示するかどうかを設定します。
MaxRegions	番号	読み取り専用	フィールドをデータフォームで表示するかどうかを設定します-1の場合、任意の領域数が許可されます。
名前	文字列	読み取り専用	フィールドのサービス名。
NamePath	String[]	読み取り専用	フィールドへのパスを形成するフィールド名とグループ名の配列。
NeedRecognize	ブーリアン	読み取り/書き込み	ルールが再度チェックされるときに、領域からフィールド値を取得するかどうかを設定します。
領域	{ Id: number; Status: number; PageId: Number; IsNew : Boolean; Coordinates: Object [{X1,X2,Y1,Y2}] }[]	読み取り専用	領域の配列。 ID–領域ID。ステータス– 領域のステータス。 0– 領域が重なっていません（または領域が削除されています） 1– 領域が認識されていません 2– 領域の値がフィールドに代入されますページID– 領域が配置されているページのID。 IsNew– 新しい領域を示すフラグ。 Coordinates– 画像内の領域の座標。

テキスト入力フィールド

名前	型	権利	摘要
文字は、	Number[]	読み取り/書き込み	フィールドと同じ長さの配列値。0と1で構成されています。 0–フラグの0と同じ位置の値にある文字は、検証が必要です。
ыSuggests	String[]	読み取り専用	推奨フィールド値リスト
値	文字列	読み取り/書き込み	フィールド値
TextTypes	番号	読み取り専用	テキストフィールドの種類。可能な値： 0–テキストフィールド。 1– 数値フィールド。 2– 通貨金額フィールド。 3- 日付時刻フィールド。 4– 日付フィールド。 5– 時刻フィールド。 6– コードフィールド。
キャプション	文字列	読み取り専用	カスタムフィールド名、キャプション
フィールドタイプ	番号	読み取り専用	フィールドのタイプ。可能な値： 0- テキストフィールド
ID	番号	読み取り専用	フィールドID
IsReadOnly	ブーリアン	読み取り専用	フィールド編集を不可にするかどうかを設定します。
IsVisible	ブーリアン	読み取り専用	フィールドをデータフォームで表示するかどうかを設定します。
MaxRegions	番号	読み取り専用	フィールド領域の最大数。値が-1の場合、任意の領域数が許可されます。
名前	文字列	読み取り専用	フィールドのサービス名。
NamePath	String[]	読み取り専用	フィールドへのパスを形成するフィールド名とグループ名の配列。
NeedRecognize	ブーリアン	読み取り/書き込み	ルールが再度チェックされるときに、領域からフィールド値を取得するかどうかを設定します。
領域	{ Id: number; Status: number; PageId: Number; IsNew : Boolean; Coordinates: Object [{X1,X2,Y1,Y2}] }[]	読み取り専用	領域の配列。 ID–領域ID。ステータス– 領域のステータス。 0– 領域が重なっていません（または領域が削除されています） 1– 領域が認識されていません 2– 領域の値がフィールドに代入されますページID– 領域が配置されているページのID。 IsNew– 新しい領域を示すフラグ。 Coordinates– 画像内の領域の座標。
IsVerified	ブーリアン	読み取り/書き込み	フィールドを検証するかどうかを設定します。
NeedVerification	ブーリアン	読み取り専用	フィールドの検証が必要かどうかを設定します。
NeedDoubleVerification	ブーリアン	読み取り専用	フィールドの二重検証が必要かどうかを設定します
IsSummary	ブーリアン	読み取り専用	データフォーム上でのデータサマリーの形成にフィールドを使用するかどうかを設定します。

チェックマークフィールド

名前	型	権利	摘要
値	ブーリアン	読み取り/書き込み	フィールド値
キャプション	文字列	読み取り専用	カスタムフィールド名、キャプション
フィールドタイプ	番号	読み取り専用	フィールドのタイプ。可能な値： 2- チェックマーク
ID	番号	読み取り専用	フィールドID
IsReadOnly	ブーリアン	読み取り専用	フィールド編集を不可にするかどうかを設定します。
IsVisible	ブーリアン	読み取り専用	フィールドをデータフォームで表示するかどうかを設定します。
MaxRegions	番号	読み取り専用	フィールド領域の最大数。値が-1の場合、任意の領域数が許可されます。
名前	文字列	読み取り専用	フィールドのサービス名。
NamePath	String[]	読み取り専用	フィールドへのパスを形成するフィールド名とグループ名の配列。
NeedRecognize	ブーリアン	読み取り/書き込み	ルールが再度チェックされるときに、領域からフィールド値を取得するかどうかを設定します。
領域	{ Id: number; Status: number; PageId: Number; IsNew : Boolean; Coordinates: Object [{X1,X2,Y1,Y2}] }[]	読み取り専用	領域の配列。 ID–領域ID。ステータス– 領域のステータス。 0– 領域が重なっていません（または領域が削除されています） 1– 領域が認識されていません 2– 領域の値がフィールドに代入されますページID– 領域が配置されているページのID。 IsNew– 新しい領域を示すフラグ。 Coordinates– 画像内の領域の座標。
IsVerified	ブーリアン	読み取り/書き込み	フィールドを検証するかどうかを設定します。
NeedVerification	ブーリアン	読み取り専用	フィールドの検証が必要かどうかを設定します。
NeedDoubleVerification	ブーリアン	読み取り専用	フィールドの二重検証が必要かどうかを設定します。
IsSummary	ブーリアン	読み取り専用	データフォーム上でのデータサマリーの形成にフィールドを使用するかどうかを設定します。

チェックマークグループフィールド

名前	型	権利	摘要
MaxSelectedCount	番号	読み取り専用	選択したフィールド値の最大数
MinSelectedCount	番号	読み取り専用	選択したフィールド値の最小数
Values	Number[]	読み取り/書き込み	フィールド値。レコードIDの配列で、可能なフィールド値のリストを構成するもの（バリアント）。
バリアント	{Id:number, Name:string}[]	読み取り専用	想定されるフィールド値のリスト： ID–レコードID 名前- レコード名
キャプション	文字列	読み取り専用	カスタムフィールド名、キャプション
フィールドタイプ	番号	読み取り専用	フィールドのタイプ。可能な値： 3― チェックマークグループ
ID	番号	読み取り専用	フィールドID
IsReadOnly	ブーリアン	読み取り専用	フィールド編集を不可にするかどうかを設定します。
IsVisible	ブーリアン	読み取り専用	フィールドをデータフォームで表示するかどうかを設定します。
MaxRegions	番号	読み取り専用	フィールド領域の最大数。値が-1の場合、任意の領域数が許可されます。
名前	文字列	読み取り専用	フィールドのサービス名。
NamePath	String[]	読み取り専用	フィールドへのパスを形成するフィールド名とグループ名の配列。
NeedRecognize	ブーリアン	読み取り/書き込み	ルールが再度チェックされるときに、領域からフィールド値を取得するかどうかを設定します。
領域	{ Id: number; Status: number; PageId: Number; IsNew : Boolean; Coordinates: Object [{X1,X2,Y1,Y2}] }[]	読み取り専用	領域の配列。 ID–領域ID。ステータス– 領域のステータス。 0– 領域が重なっていません（または領域が削除されています） 1– 領域が認識されていません 2– 領域の値がフィールドに代入されますページID– 領域が配置されているページのID。 IsNew– 新しい領域を示すフラグ。 Coordinates– 画像内の領域の座標。
IsVerified	ブーリアン	読み取り/書き込み	フィールドを検証するかどうかを設定します。
NeedVerification	ブーリアン	読み取り専用	フィールドの検証が必要かどうかを設定します。
NeedDoubleVerification	ブーリアン	読み取り専用	フィールドの二重検証が必要かどうかを設定します。
IsSummary	ブーリアン	読み取り専用	データフォーム上でのデータサマリーの形成にフィールドを使用するかどうかを設定します。

画像フィールド

名前	型	権利	摘要
キャプション	文字列	読み取り専用	カスタムフィールド名、キャプション
フィールドタイプ	番号	読み取り専用	フィールドのタイプ。可能な値： 1– 画像
ID	番号	読み取り専用	フィールドID
IsReadOnly	ブーリアン	読み取り専用	フィールド編集を不可にするかどうかを設定します。
IsVisible	ブーリアン	読み取り専用	フィールドをデータフォームで表示するかどうかを設定します。
MaxRegions	番号	読み取り専用	フィールド領域の最大数。値が-1の場合、任意の領域数が許可されます。
名前	文字列	読み取り専用	フィールドのサービス名。
NamePath	String[]	読み取り専用	フィールドへのパスを形成するフィールド名とグループ名の配列。
領域	{ Id: number; Status: number; PageId: Number; IsNew : Boolean; Coordinates: Object [{X1,X2,Y1,Y2}] }[]	読み取り専用	領域の配列。 ID–領域ID。ステータス– 領域のステータス。 0– 領域が重なっていません（または領域が削除されています） 1– 領域が認識されていません 2– 領域の値がフィールドに代入されますページID– 領域が配置されているページのID。 IsNew– 新しい領域を示すフラグ。 Coordinates– 画像内の領域の座標。

セクションフィールドの繰り返しグループ

文書オブジェクトのプロパティ

名前	型	権利	摘要
AssemblingErrors	{ DocumentNodeRef: number[][]; Description: string; SectionName: string[] }[]	読み取り専用	以下に文書のビルドエラーがあります： DocumentNodeRef– フィールドIDの配列としての、フォーム内のフィールドへのリンクのリスト摘要- エラー解説 SectionName– エラーに関係するセクションのリスト
BatchId	番号	読み取り専用	ページID
エラー	{ DocumentNodeRef: number[][]; Severity: number; Message: string; RuleName: string; }[]	読み取り専用	以下に文書のエラーがあります： DocumentNodeRef– フィールドIDの配列としての、フォーム内のフィールドへのリンクのリスト重大度： 1– エラー、 0– 警告メッセージ– エラーテキスト RuleName― エラーの原因となったルールの名前。
フィールド	(Section \| SectionsGroup)[]	読み取り専用	セクションのリスト／重複するセクション
ID	番号	読み取り専用	文書 ID
インデックス	番号	読み取り専用	パッケージ内の文書のインデックス。
ページ	{ Id: number; Modification: number; HasColorImage: boolean; ImageResolution: number; KeyValue: string; SectionTemplateId: number; SectionTemplateName: string; FlexibleInstanceId: number; SectionTemplatePageNumber: number; Comment: string; ImageWidth: number; ImageHeight: number; }[]	読み取り専用	つぎのものを含む文書ページのリスト： ID–ページ ID Modification– ページのバージョン番号 HasColorImage– ページの色を指定します ImageResolution― 画像の解像度 KeyValue– キーフィールドページの値 SectionTemplateId– ページのIDセクション SectionTemplateName- ページセクション名 SectionTemplatePageNumber― セクション内のページの数 Comment– ページのレビュー ImageWidth–画像ページの幅 ImageHeight–ページ画像の高さ
ProjectId	番号	読み取り専用	プロジェクトID
TaskId	番号	読み取り専用	タスクID
TemplateId	番号	読み取り専用	文書定義ID
TemplateName	文字列	読み取り専用	定義ドキュメントの名前
TemplateVersion	番号	読み取り専用	文書の定義バージョン
バージョン	番号	読み取り専用	文書のバージョン

12.04.2024 18:16:06

Please leave your feedback about this article

Name

E-mail

Comment

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.