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

French (Français)

Objets

Cet article fournit la description d'un modèle d'objet d'un script utilisateur utilisé pour le poste de vérification Web.

Fonctions pour travailler avec des champs

Définition	Description
getCurrentField()	Renvoie un lien vers un objet de champ qui utilise le script utilisateur ouvert.
getFieldByName(namesPath) (*)	Renvoie un lien vers un objet de champ basé sur un tableau de noms dans la demande. Exemple : ['Document Section 1', 'Group[10]','Field3'] where [10] correspond au numéro de l'instance du groupe répétitif dans Groupe. namesPath est un tableau contenant les noms des champs et des groupes qui constituent le chemin d'accès au champ ou un lien vers un objet de champ.
getFieldValue(namesPath) (*)	Renvoie : une chaîne pour un champ TextField ; une valeur de coche pour un champ Checkmark ; un tableau de chaînes pour un champ Checkmark Group. namesPath \| fieldObject : un tableau contenant les noms des champs et des groupes qui constituent le chemin d'accès au champ ou un lien vers un objet de champ, ou un lien vers l'objet de champ.
setCurrentFieldValue(value, forced, onSaved)	Modifie la valeur du champ pour lequel le script utilisateur a été ouvert. Paramètres : value – la valeur de champ. forced - Indique si la valeur sera enregistrée dans le champ immédiatement après la modification du champ ou seulement après avoir appelé la fonction save(). Ce paramètre est facultatif et est défini sur False par défaut. false – dans la définition de document, la valeur de champ ne sera mise à jour qu'après l'appel de la fonction save(). true – dans la définition de document, la valeur de champ sera mise à jour immédiatement. Dans le cas d'un script personnalisé, une mise à jour aura lieu quel que soit le mode. Par défaut, ce paramètre est réglé sur false. onSaved - Une fonction de rappel. La fonction est appelée si le paramètre forced est défini sur True. Ce paramètre est facultatif.
setFieldValue(namesPath \| field, value, forced, onSaved) (*)	Modifie les valeurs de champ. Paramètres : namesPath \| fieldObject : un tableau contenant des noms de champ et de groupe qui constituent le chemin d'accès au champ, ou un lien vers l'objet de champ. value - la valeur du champ correspondant. forced - met à jour la valeur de champ et enregistre les nouvelles données. Ce paramètre est facultatif. false - dans la définition de document, la valeur de champ ne sera mise à jour qu'après l'appel de la fonction save() . true - dans la définition de document, la valeur de champ sera mise à jour immédiatement. Dans le cas d'un script personnalisé, une mise à jour aura lieu quel que soit le mode. Par défaut, ce paramètre est réglé sur False. onSaved - Une fonction de rappel. La fonction est appelée si le paramètre forced est défini sur True. Ce paramètre est facultatif
save()	Ferme la fenêtre dans laquelle le script personnalisé est exécuté et enregistre les modifications.
cancel()	Ferme la fenêtre dans laquelle le script personnalisé est exécuté sans enregistrer les modifications.
*()** Pour certaines fonctions énumérées ci-dessus, le chemin d'accès au champ est spécifié comme paramètre d'entrée. Il inclut le nom du champ et les noms des éléments parents (groupe de champs, section). Pour les tableaux, les tableaux répétitifs et les groupes répétitifs, vous devez spécifier le nombre d'instances en partant de 0 (zéro). Exemple : ['Document Section 1', 'Group[10]','Field3'], où [10] est le nombre d'instances du groupe répétitif.

Fonctions pour travailler avec des jeux de données

Définition	Description
addEntity(entityInfo: {cacheName, columns, values}, onResult(newId))	Ajoute une entrée dans la base de données. Paramètres : entityInfo - un objet : cacheName - un nom pour le jeu de données. columns – les noms des colonnes dans lesquelles les données seront enregistrées. Tableau de chaînes. values - les valeurs des colonnes correspondantes. Tableau de chaînes. onResult - une fonction de rappel qui reçoit l'identificateur de l'enregistrement créé dans le jeu de données.
editEntity(entityInfo: {cacheName, columns, values}, onResult())	Modifie une entrée de la base de données. Paramètres : entityInfo - un objet : cacheName - un nom pour le jeu de données. columns - les noms des colonnes dans lesquelles les données seront enregistrées. Tableau de chaînes. values - les valeurs des colonnes correspondantes. Tableau de chaînes. onResult - une fonction de rappel.
getDict({cacheName, filters: [{FieldName, FieldValue}], cursorPos, allowMultipleColumnResults}, onResult (param: { FieldName, FieldValue, BoldMask}[][]) )	Procède à la recherche d'un jeu de données pour une valeur donnée ou pour une partie de celle-ci. Renvoie les chaînes correspondantes au format suivant : [{FieldName FieldValue BoldMask}]. Paramètres : cacheName – Définit le nom du jeu de données. filters – des paramètres de recherche : FieldName – le nom du champ. À ignorer pour rechercher tous les champs. FieldValue – Définit la valeur du champ. cursorPos – Définit un emplacement pour le curseur dans un champ d'entrée. Dans le cas où une valeur a été saisie partiellement et que le curseur est placé après les symboles tapés, ils seront considérés comme un préfixe de la valeur recherchée. Si le curseur est placé avant un mot partiellement tapé, ces symboles seront considérés comme la fin de la valeur recherchée. Par exemple, si, lors de la recherche d'un nom de société, vous tapez « ADO » et placez le curseur après ces caractères, la valeur « AVOCADO » sera sélectionnée. Si vous tapez « ADO » et placez le curseur devant ces caractères, la valeur « ADONIS » sera sélectionnée. allowMultipleColumnResults - renvoie les valeurs des champs qui ont été trouvés. Le jeu de données peut contenir des entrées pour lesquelles un nom de champ (FieldName) correspond à plusieurs valeurs de champ (FieldValue). Par exemple, deux ou plusieurs variantes du nom d'une société peuvent être spécifiées dans la colonne CompanyName. Dans ce cas : true - renvoie et enregistre toutes les valeurs de champ qui satisfont aux conditions de recherche, false - renvoie et enregistre celui des résultats qui correspond le mieux aux conditions de recherche. onResult - une fonction de rappel qui renvoie un tableau de résultats de recherche. Chaque résultat est une chaîne unique du jeu de données, qui est un tableau de chaînes. Chaque chaîne inclut le nom de champ, sa valeur et le paramètre BoldMask . BoldMask - une chaîne de 0 et 1 de même longueur quela valeur trouvée lors de la recherche. 1 représente un symbole de la valeur trouvée qui concorde avec le symbole correspondant du champ de recherche et 0 représente un symbole qui ne présente pas cette concordance. Si, par exemple, ce qui suit est présent dans un jeu de données : CompanyName : ABBYY Supposons qu'une recherche soit effectuée pour les symboles « ABB ». Voici ce qui sera alors renvoyé : [ [ { FieldName : CompanyName, FieldValue : ABBYY, BoldMask : 11100 }, ] ] Remarque : Le tableau renvoyé peut contenir plusieurs valeurs, y compris celles qui ne correspondaient pas initialement aux conditions de recherche. Les résultats de la recherche dans le tableau seront triés par la valeur du paramètre BoldMask en ordre décroissant (c'est-à-dire en commençant par les chaînes qui correspondent le mieux aux conditions de recherche).
getDictAll({cacheName, filters: {FieldName, FieldValue}}, }, onResult (param: { FieldName, FieldValue, BoldMask}[][]))	Effectue une recherche dans la base de données pour la totalité de la valeur spécifiée. Renvoie les valeurs de tous les champs qui ont été trouvés. Paramètres : cacheName- le nom du jeu de données. Filters - un tableau d'objets : FieldName - le nom du champ. Pour effectuer une recherche à partir de tous les champs, ce champ doit être laissé vide. FieldValue - la valeur du champ. onResult - une fonction de rappel qui renvoie un tableau de résultats de recherche. Chaque résultat est une chaîne unique du jeu de données, qui est en lui-même un tableau de chaînes. Chaque chaîne inclut le nom de champ, sa valeur et le paramètreBoldMask . BoldMask – une chaîne de 0 et 1 de même longueur quela valeur trouvée durant la recherche. 1 représente un symbole de la valeur trouvée qui concorde avec le symbole correspondant du champ de recherche et 0 représente un symbole qui ne présente pas cette concordance. Si, par exemple, ce qui suit est présent dans un jeu de données : CompanyName: ABBYY Supposons qu'une recherche soit effectuée pour les symboles « AB ». Voici ce qui sera alors renvoyé : [ [ { FieldName : CompanyName, FieldValue : ABBYY, BoldMask : 11000 }, ] ] Remarque : Le tableau renvoyé peut contenir plusieurs valeurs, y compris celles qui ne correspondaient pas initialement aux conditions de recherche. Les résultats de la recherche dans le tableau seront triés par la valeur du paramètre BoldMask en ordre décroissant (c'est-à-dire en commençant par les chaînes qui correspondent le mieux aux conditions de recherche).
Exemple de script de recherche dans la base de données

Fonctions permettant de travailler avec le formulaire d'un document

Fonction	Description
selectRow(tablePath, rowNumber) (*)	Marque une ligne d'un tableau comme sélectionnée. tablePath \| fieldObject : un tableau des noms des champs et des groupes qui constituent le chemin d'accès au champ tableau, ou un lien vers un objet du tableau. rowNumber - le numéro de la ligne à sélectionner, à partir de zéro.
deselectRow(tablePath, rowNumber?) (*)	Supprime la sélection d'une ligne du tableau. tablePath \| fieldObject : un tableau des noms des champs et des groupes qui constituent le chemin d'accès au champ tableau, ou un lien vers un objet du tableau. rowNumber - le numéro de la ligne à désélectionner, à partir de zéro, en son absence, la sélection est supprimée de toutes les lignes du tableau.
scrollFormToField(namesPath) (*)	Fait défiler l'éditeur de formulaires pour faire apparaître le champ. namesPath \| fieldObject : un tableau des noms des champs et des groupes qui constituent le chemin d'accès au champ tableau, ou un lien vers un objet du tableau.
getDomElementPosition(domId, onResult: (result?: {width, height, top, left, right, bottom}))	Indique la position d'un élément dans la fenêtre de l'éditeur de formulaires et renvoie le résultat d'une fonction de rappel. domId - ID de l'élément au format DOM. onResult - une fonction de rappel qui reçoit l'objet avec les coordonnées DOM de l'élément (largeur, hauteur, haut, gauche, droite, bas) par rapport au coin supérieur gauche de la fenêtre du navigateur.
setStyles(styles, callback)	Ajoute les styles CSS à la fenêtre du cadre d'action personnalisé. styles - un objet avec les noms et valeurs de la propriété CSS. exemple : { affichage : 'bloc', position : 'absolue', haut : '0px', bas : '0px', gauche : '0px', droite : '0px', largeur : '100%', hauteur : '100%', bordure : '0', chevauchement : 'masqué', 'chevauchement-x' : 'masqué', 'chevauchement-y' : 'masqué', 'z-index' : '10000' } callback - une fonction de rappel.
*()** Pour certaines fonctions énumérées ci-dessus, le chemin d'accès au champ est spécifié comme paramètre d'entrée. Il inclut le nom du champ et les noms des éléments parents (groupe de champs, section). Pour les tableaux, les tableaux répétitifs et les groupes répétitifs, vous devez spécifier le nombre d'instances en partant de 0. Exemple : ['Document Section 1', 'Group[10]','Field3'], où [10] est le nombre d'instances du groupe répétitif.

Propriétés de l'objet commandArgs

Variables

Variable	Type	Description
commandArgs.params.document	Document	Enregistre une copie objet d'un document ouvert. Ceci peut être utilisé pour accéder à toute erreur, tout champ ou toute région du document en cours.
commandArgs.params.currentField	(Image \| Coche \| Groupes de coches \| FieldsGroup \| Tableau \| TextField)	Renvoie un lien vers un objet de champ qui reflète l'état du champ au moment où le script est appelé. Partie du document spécifié ci-dessus. Remarque : Si la valeur du champ a été modifiée après l'initialisation du script, les modifications ne seront pas appliquées.
commandArgs.params.appPath	Chaîne	Le nom de domaine du serveur.
commandArgs.params.coordinates	Objet [{X1,X2,Y1,Y2}]	Les coordonnées de l'élément DOM qui a appelé le script personnalisé.
commandArgs.params.currentElementDomId	Chaîne	L'ID de l'élément DOM qui a appelé le script personnalisé.

Fonctions

Fonction	Description
commandArgs.events.addEventHandler	Ajoute un gestionnaire d'événements dans le contexte global du script personnalisé.
commandArgs.events.triggerHandlers	Déclenche un événement dans le contexte global du script personnalisé.
commandArgs.events.removeEventHandler	Supprime un gestionnaire d'événements dans le contexte global du script personnalisé.

Field Group field

Nom	Type	Accès	Description
Fields	(Image \| Coche \| Groupes de coches \| FieldsGroup \| Tableau \| TextField)[]	Lecture seule	Tableau de champs
HasTableLayout	Booléen	Lecture seule	Indique si la région du champ est un tableau.
Caption	Chaîne	Lecture seule	Nom du champ personnalisé, légende
FieldType	Nombre	Lecture seule	Type de champ. Valeur possible : 4 - groupe de champs
Id	Nombre	Lecture seule	Identifiant de champ
IsReadOnly	Booléen	Lecture seule	Indique si la modification des champs est interdite.
IsVisible	Booléen	Lecture seule	Indique si le champ est visible sur le formulaire de données.
MaxRegions	Nombre	Lecture seule	Nombre maximum de régions de champ. Si la valeur est -1, n'importe quel nombre de régions est autorisé.
Name	Chaîne	Lecture seule	Nom de service du champ.
NamePath	Chaîne[]	Lecture seule	Tableau des noms des champs et des groupes qui constituent le chemin d'accès au champ.
NeedRecognize	Booléen	Lecture/écriture	Indique si la valeur du champ doit être récupérée dans la région lorsque les règles sont à nouveau vérifiées.
Regions	{ Id : nombre ; Status : nombre; PageId : nombre ; IsNew : Booléen; Coordinates : Objet [{X1,X2,Y1,Y2}]; }[]	Lecture seule	Tableau de régions. Id - identifiant de la région. Status - statut de la région. 0 - région non superposée (ou région supprimée) 1 - région non reconnue 2 - la valeur de la région est remplacée dans le champ PageId - identifiant de la page dans laquelle se trouve la région. IsNew - indicateur pour signaler les nouvelles régions. Coordinates – coordonnées de la région dans l'image.

Champ Section

Nom	Type	Accès	Description
Fields	(Image \| Coche \| Groupes de coches \| FieldsGroup \| Tableau \| TextField)[]	Lecture seule	Tableau de champs
Pageids	Nombre[]	Lecture seule	Identificateurs des pages dans lesquelles se trouve la section.
IsFlexible	Booléen	Lecture seule	Indique si la section est flexible.
Caption	Chaîne	Lecture seule	Nom du champ personnalisé, légende
FieldType	Nombre	Lecture seule	Type de champ. Valeur possible : 6 – section
Id	Nombre	Lecture seule	Identifiant de champ
IsReadOnly	Booléen	Lecture seule	Indique si la modification du champ est interdite
IsVisible	Booléen	Lecture seule	Indique si le champ est visible sur le formulaire de données.
MaxRegions	Nombre	Lecture seule	Nombre maximum de régions de champ. Si la valeur est -1, n'importe quel nombre de régions est autorisé.
Name	Chaîne	Lecture seule	Nom de service du champ
NamePath	Chaîne[]	Lecture seule	Tableau des noms des champs et des groupes qui constituent le chemin d'accès au champ.
NeedRecognize	Booléen	Lecture/écriture	Indique si la valeur du champ doit être récupérée dans la région lorsque les règles sont à nouveau vérifiées.
Regions	{ Id: number; Status: number; PageId: Nombre; IsNew : Booléen; Coordinates: Object [{X1,X2,Y1,Y2}]; }[]	Lecture seule	Tableau de régions. Id - identifiant de la région. Status - statut de la région. 0 - région non superposée (ou région supprimée) 1 - région non reconnue 2 - la valeur de la région est remplacée dans le champ PageId - identifiant de la page dans laquelle se trouve la région. IsNew - indicateur pour signaler les nouvelles régions. Coordinates – coordonnées de la région dans l'image.

Table field

Nom	Type	Accès	Description
Rows	{ Id : nombre ; RowNumber : nombre ; HasColorImage : booléen ; TableBlockID : nombre []; Cells : (Image \| Coche \| CheckmarkGroup \| TextField)[]; }[]	Lecture seule	Liste des lignes d'un tableau. Les paramètres de la ligne objet dans le tableau : Id - identifiant de la ligne. RowNumber - le numéro d'ordre de la ligne, en comptant à partir de zéro. TableBlockId - les identificateurs des sections, des tableaux, des blocs de tableaux constituant le chemin d'accès au bloc de tableaux. Cells - les champs dans les cellules du tableau. Les champs peuvent être des types suivants : image, coche, groupe de coches, texte.
Caption	Chaîne	Lecture seule	Nom du champ personnalisé, légende
FieldType	Nombre	Lecture seule	Type de champ. Valeur possible : 7 - tableau
Id	Nombre	Lecture seule	Identifiant de champ
IsReadOnly	Booléen	Lecture seule	Indique si la modification du champ est interdite.
IsVisible	Booléen	Lecture seule	Indique si le champ est visible sur le formulaire de données.
MaxRegions	Nombre	Lecture seule	Indique si le champ est visible sur le formulaire de données -1, n'importe quel nombre de régions est autorisé.
Name	Chaîne	Lecture seule	Nom de service du champ
NamePath	Chaîne[]	Lecture seule	Tableau des noms des champs et des groupes qui constituent le chemin d'accès au champ.
NeedRecognize	Booléen	Lecture/écriture	Indique si la valeur du champ doit être récupérée dans la région lorsque les règles sont à nouveau vérifiées.
Regions	{ Id : nombre ; Status : nombre ; PageId : Nombre ; IsNew : Booléen ; Coordinates : Objet [{X1,X2,Y1,Y2}] ; }[]	Lecture seule	Tableau de régions. Id - identifiant de la région. Status - statut de la région. 0 - région non superposée (ou région supprimée) 1 - région non reconnue 2 - la valeur de la région est remplacée dans le champ PageId - identifiant de la page dans laquelle se trouve la région. IsNew - indicateur pour signaler les nouvelles régions. Coordinates – coordonnées de la région dans l'image.

Champ d'entrée de texte

Nom	Type	Accès	Description
Flags	Nombre[]	Lecture/écriture	tableau de la même longueur que le champ Valeur. Se compose de 0 et 1. 0 - un caractère qui, dans Valeur, est à la même position que celle occupée par 0 dans Indicateurs, nécessite une vérification.
Suggests	Chaîne[]	Lecture seule	Liste des valeurs de champ suggérées
Value	Chaîne	Lecture/écriture	Valeur du champ
TextType	Nombre	Lecture seule	Type de champ de texte. Valeur possible : 0 - champ de texte. 1 - champ numérique. 2 - champs du montant en devise. 3 - champ DateTime. 4 - champ de la date. 5 - champ de l'heure. 6 - champ du code.
Caption	Chaîne	Lecture seule	Nom du champ personnalisé, légende
FieldType	Nombre	Lecture seule	Type de champ. Valeur possible : 0 - champ de texte
Id	Nombre	Lecture seule	Identifiant de champ
IsReadOnly	Booléen	Lecture seule	Indique si la modification du champ est interdite.
IsVisible	Booléen	Lecture seule	Indique si le champ est visible sur le formulaire de données.
MaxRegions	Nombre	Lecture seule	Nombre maximum de régions de champ. Si la valeur est -1, n'importe quel nombre de régions est autorisé.
Name	Chaîne	Lecture seule	Nom de service du champ
NamePath	Chaîne[]	Lecture seule	Tableau des noms des champs et des groupes qui constituent le chemin d'accès au champ.
NeedRecognize	Booléen	Lecture/écriture	Indique si la valeur du champ doit être récupérée dans la région lorsque les règles sont à nouveau vérifiées.
Regions	{ Id : nombre ; Status : nombre ; PageId : Nombre ; IsNew : Booléen ; Coordinates : Objet [{X1,X2,Y1,Y2}] ; }[]	Lecture seule	Tableau de régions. Id - identifiant de la région. Status - statut de la région. 0 - région non superposée (ou région supprimée) 1 - région non reconnue 2 - la valeur de la région est remplacée dans le champ PageId - identifiant de la page dans laquelle se trouve la région. IsNew - indicateur pour signaler les nouvelles régions. Coordinates – coordonnées de la région dans l'image.
IsVerified	Booléen	Lecture/écriture	Indique si le champ a été vérifié.
NeedVerification	Booléen	Lecture seule	Indique si le champ nécessite une vérification.
NeedDoubleVerification	Booléen	Lecture seule	Indique si le champ nécessite une double vérification
IsSummary	Booléen	Lecture seule	Indique si le champ est utilisé pour la constitution du récapitulatif des données sur le formulaire de données.

Champ de coche

Nom	Type	Accès	Description
Value	Booléen	Lecture/écriture	Valeur du champ
Caption	Chaîne	Lecture seule	Nom du champ personnalisé, légende
FieldType	Nombre	Lecture seule	Type de champ. Valeur possible : 2 - coche
Id	Nombre	Lecture seule	Identifiant de champ
IsReadOnly	Booléen	Lecture seule	Indique si la modification du champ est interdite.
IsVisible	Booléen	Lecture seule	Indique si le champ est visible sur le formulaire de données.
MaxRegions	Nombre	Lecture seule	Nombre maximum de régions de champ. Si la valeur est -1, n'importe quel nombre de régions est autorisé.
Name	Chaîne	Lecture seule	Nom de service du champ
NamePath	Chaîne[]	Lecture seule	Tableau des noms des champs et des groupes qui constituent le chemin d'accès au champ.
NeedRecognize	Booléen	Lecture/écriture	Indique si la valeur du champ doit être récupérée dans la région lorsque les règles sont à nouveau vérifiées.
Regions	{ Id : nombre ; Status : nombre ; PageId : Nombre ; IsNew : Booléen ; Coordinates : Objet [{X1,X2,Y1,Y2}] ; }[]	Lecture seule	Tableau de régions. Id - identifiant de la région. Status - statut de la région. 0 - région non superposée (ou région supprimée) 1 - région non reconnue 2 - la valeur de la région est remplacée dans le champ PageId - identifiant de la page dans laquelle se trouve la région. IsNew - indicateur pour signaler les nouvelles régions. Coordinates – coordonnées de la région dans l'image.
IsVerified	Booléen	Lecture/écriture	Indique si le champ a été vérifié.
NeedVerification	Booléen	Lecture seule	Indique si le champ nécessite une vérification.
NeedDoubleVerification	Booléen	Lecture seule	Indique si le champ nécessite une double vérification.
IsSummary	Booléen	Lecture seule	Indique si le champ est utilisé pour la constitution du récapitulatif des données sur le formulaire de données.

Champ groupe de coches

Nom	Type	Accès	Description
MaxSelectedCount	Nombre	Lecture seule	Nombre maximum de valeurs de champ sélectionnées.
MinSelectedCount	Nombre	Lecture seule	Nombre minimum de valeurs de champ sélectionnées.
Values	Nombre[]	Lecture/écriture	Valeur du champ. Un tableau des identifiants de l'enregistrement qui composent la liste des valeurs de champ possibles (Variantes).
Variants	{Id:number, Name:string}[]	Lecture seule	Liste des valeurs de champ possibles : Id - identifiant de l'enregistrement Name - nom de l'enregistrement
Caption	Chaîne	Lecture seule	Nom du champ personnalisé, légende
FieldType	Nombre	Lecture seule	Type de champ. Valeur possible : 3 - groupe de coches
Id	Nombre	Lecture seule	Identifiant de champ.
IsReadOnly	Booléen	Lecture seule	Indique si la modification du champ est interdite.
IsVisible	Booléen	Lecture seule	Indique si le champ est visible sur le formulaire de données.
MaxRegions	Nombre	Lecture seule	Nombre maximum de régions de champ. Si la valeur est -1, n'importe quel nombre de régions est autorisé.
Name	Chaîne	Lecture seule	Nom de service du champ
NamePath	Chaîne[]	Lecture seule	Tableau des noms des champs et des groupes qui constituent le chemin d'accès au champ.
NeedRecognize	Booléen	Lecture/écriture	Indique si la valeur du champ doit être récupérée dans la région lorsque les règles sont à nouveau vérifiées.
Regions	{ Id: number; Status: number; PageId: Nombre; IsNew : Booléen; Coordinates: Object [{X1,X2,Y1,Y2}]; }[]	Lecture seule	Tableau de régions. Id - identifiant de la région. Status - statut de la région. 0 - région non superposée (la région est supprimée) 1 - région non reconnue 2 - la valeur de la région est remplacée dans le champ PageId - identifiant de la page dans laquelle se trouve la région. IsNew - indicateur pour signaler les nouvelles régions. Coordinates – coordonnées de la région dans l'image.
IsVerified	Booléen	Lecture/écriture	Indique si le champ a été vérifié.
NeedVerification	Booléen	Lecture seule	Indique si le champ nécessite une vérification.
NeedDoubleVerification	Booléen	Lecture seule	Indique si le champ nécessite une double vérification.
IsSummary	Booléen	Lecture seule	Indique si le champ est utilisé pour la constitution du récapitulatif des données sur le formulaire de données.

Champ d'image

Nom	Type	Accès	Description
Caption	Chaîne	Lecture seule	Nom du champ personnalisé, légende
FieldType	Nombre	Lecture seule	Type de champ. Valeur possible : 1 - image
Id	Nombre	Lecture seule	Identifiant de champ.
IsReadOnly	Booléen	Lecture seule	Indique si la modification du champ est interdite.
IsVisible	Booléen	Lecture seule	Indique si le champ est visible sur le formulaire de données.
MaxRegions	Nombre	Lecture seule	Nombre maximum de régions de champ. Si la valeur est -1, n'importe quel nombre de régions est autorisé.
Name	Chaîne	Lecture seule	Nom de service du champ
NamePath	Chaîne[]	Lecture seule	Tableau des noms des champs et des groupes qui constituent le chemin d'accès au champ.
Regions	{ Id : nombre ; Status : nombre ; PageId : Nombre ; IsNew : Booléen ; Coordinates : Objet [{X1,X2,Y1,Y2}] ; }[]	Lecture seule	Tableau de régions. Id - identifiant de la région. Status - statut de la région. 0 - région non superposée (ou région supprimée) 1 - région non reconnue 2 - la valeur de la région est remplacée dans le champ PageId - identifiant de la page dans laquelle se trouve la région. IsNew - indicateur pour signaler les nouvelles régions. Coordinates – coordonnées de la région dans l'image.

Groupe répétitif de champ Sections

Propriétés de l'objet du document

Nom	Type	Accès	Description
AssemblingErrors	{ DocumentNodeRef : nombre[][]; Description : chaîne ; SectionName: chaîne[] }[]	Lecture seule	Erreurs de construction dans le document lorsque : DocumentNodeRef - une liste de liens vers les champs du formulaire sous la forme d'un tableau d'identifiants de champs Description - une description de l'erreur SectionName - une liste des sections impliquées dans l'erreur
BatchId	Nombre	Lecture seule	L'identifiant du package
Errors	{ DocumentNodeRef : nombre[][] ; Severity : nombre ; Message : chaîne ; RuleName : chaîne ; }[]	Lecture seule	Erreurs dans le document lorsque : DocumentNodeRef - une liste de liens vers les champs du formulaire sous la forme d'un tableau d'identifiants de champs Severity : 1 - Erreur, 0 - Avertissement Message - texte d'erreur RuleName - le nom de la règle à l'origine de l'erreur
Fields	(Section \| SectionsGroup)[]	Lecture seule	Liste des sections/des sections en double
Id	Nombre	Lecture seule	Identifiant de document
Index	Nombre	Lecture seule	L'index du document dans le package.
Pages	{ Id : nombre ; Modification : nombre ; HasColorImage : booléen ; ImageResolution : nombre ; KeyValue : chaîne ; SectionTemplateId : nombre ; SectionTemplateName : chaîne ; FlexibleInstanceId : nombre ; SectionTemplatePageNumber : nombre ; Comment : chaîne ; ImageWidth : nombre ; ImageHeight : nombre ; }[]	Lecture seule	Liste des pages du document contenant les éléments suivants : Id - identifiant de la page Modification - le nombre de révisions de la page HasColorImage - indique la couleur de la page ImageResolution - la résolution de l'image KeyValue - la valeur de la page du champ clé SectionTemplateId - la section Identifiant de la page SectionTemplateName - le nom de la section de la page SectionTemplatePageNumber - le nombre de pages dans la section Comment - l'analyse de la page ImageWidth - la largeur de la page Image ImageHeight - la hauteur de l'image de la page
ProjectId	Nombre	Lecture seule	Identifiant du projet
TaskId	Nombre	Lecture seule	ID de tâche
TemplateId	Nombre	Lecture seule	Identifiant de la définition de document
TemplateName	Chaîne	Lecture seule	Le nom des définitions de document
TemplateVersion	Nombre	Lecture seule	La version de la définition de document
Version	Nombre	Lecture seule	Version du document

12.04.2024 18:16:03

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.