Fonctions globales

Area Max( Area a1, Area a2 )

Renvoie la valeur maximale entre a1 et a2.

Area Min( Area a1, Area a2 )

Renvoie la plus petite valeur entre a1 et a2.

Area ObjectsArea( Rect, ImageObjectType )

La surface des objets du type spécifié à l’intérieur du rectangle spécifié. Fonctionne en coordonnées globales.

Area ObjectsIntersectionArea( Rect, ImageObjectType )

L’aire des objets du type spécifié à l’intérieur du rectangle spécifié, ainsi que l’aire d’intersection des objets du type spécifié qui dépassent du rectangle spécifié. Fonctionne en coordonnées globales.

Distance abs( Distance )

Renvoie la valeur absolue d’une distance.

Distance AverageLineHeight()

La hauteur moyenne des lignes de texte de la page.

Important ! Cette fonction ne peut être utilisée que si les nombres minimal et maximal de pages du document sont définis sur 1, c’est-à-dire si le document détecté ne comporte qu’une seule page. Si vous utilisez cette fonction pour un document multipage, la mise en correspondance d’un FlexiLayout renverra une erreur. Pour un document multipage, utilisez la méthode correspondante du type Page : Page( N ). AverageLineHeight.

Distance AverageInterLineInterval()

La distance moyenne entre les lignes de texte de la page.

Important ! La fonction ne peut être utilisée que si le nombre maximal et le nombre minimal de pages du document sont tous deux définis sur 1, c’est-à-dire que le document détecté ne comporte qu’une seule page. Si vous utilisez cette fonction pour un document multipage, la mise en correspondance d’un FlexiLayout renverra une erreur. Pour un document multipage, utilisez la méthode correspondante du type Page : Page( N ). AverageInterLineInterval.

Distance Min( Distance d1, Distance d2 )

Renvoie la valeur minimale entre d1 et d2.

Distance Max( Distance d1, Distance d2 )

Renvoie la valeur maximale entre d1 et d2.

Int abs( Int )

Renvoie la valeur absolue d’un nombre.

Int Ceil( Real )

Renvoie le plus petit entier supérieur ou égal à l’argument.

Int Floor( Real )

Renvoie le plus grand entier inférieur ou égal à l’argument.

Int LogicToInt( Logic value )

Retourne “1” si la valeur est true et “0” si la valeur est false.

Int Max( Int n1, Int n2 )

Renvoie la valeur maximale entre n1 et n2.

Int Min( Int n1, Int n2 )

Renvoie la plus petite valeur entre n1 et n2.

Int PagesCount()

Retourne le nombre de pages du document.

Int RecordCount( String connectionString, String selectString )

Renvoie le nombre d’enregistrements de la requête. Voir, par exemple, l’exemple de la fonction Record ci-dessous.

Int Round( Real )

Renvoie l’entier le plus proche de la valeur de l’argument.

Int StrToInt( String inputString, Logic isStrictMode = false )

Renvoie le résultat de la conversion de la valeur de chaîne inputString en nombre entier. Les espaces sont ignorés. Le paramètre isStrictMode (par défaut = false) définit si la chaîne peut inclure des caractères autres que des chiffres et des espaces. Si isStrictMode = false et que la chaîne contient un caractère qui n’est ni un chiffre ni un espace, tous les caractères suivants sont ignorés. Il est recommandé de vérifier au préalable que la conversion est possible avant d’appeler cette fonction. Pour ce faire, utilisez la fonction IsInt.

Int StrToIntFuzzy( String, Logic isStrictMode = false )

Renvoie le résultat de la conversion de la valeur de la chaîne inputString en entier, en tenant compte des éventuelles erreurs de reconnaissance dans la chaîne (voir la description de la fonction IsIntFuzzy pour plus de détails). Les espaces sont ignorés lors de la conversion. Le paramètre isStrictMode (dont la valeur par défaut est false) détermine si la chaîne peut contenir des caractères autres que des chiffres, des caractères ressemblant à des chiffres ou des espaces. Si isStrictMode = false et qu’un caractère autre qu’un chiffre est rencontré, tous les caractères qui le suivent sont ignorés. Avant de commencer la conversion, nous recommandons d’appeler la fonction IsIntFuzzy pour vérifier que la chaîne peut être convertie en toute sécurité.

Logic ExecuteSQL( String connectionString, String queryString )

Exécute la requête SQL spécifiée par l’utilisateur : queryString. L’argument connectionString définit la chaîne de connexion à la base de données.

Logic IsInt( String inputString, Logic isStrictMode = false )

Vérifie que la chaîne inputString peut être convertie en toute sécurité en entier. Le paramètre isStrictMode (par défaut = false) indique si la chaîne peut contenir des caractères autres que des chiffres et des espaces.

Logic IsIntFuzzy( String inputString, Logic isStrictMode = false )

Vérifie si la chaîne inputString peut être convertie en toute sécurité en entier, en tenant compte des erreurs de reconnaissance possibles dans la chaîne. Ce type de conversion convertit en entiers non seulement les chiffres (c.-à-d. les caractères “0123456789”), mais aussi les caractères qui ressemblent à des chiffres (par ex. “oOBsl”). Le paramètre isStrictMode (défini sur false par défaut) détermine si la chaîne peut contenir des caractères autres que des chiffres, des caractères qui ressemblent à des chiffres ou des espaces.

Logic IsOnSameLine( Hypothesis, Hypothesis )

Vérifie si les hypothèses se chevauchent verticalement.

Logic IsReal( String numberString, String separators = “.,”, Logic isStrictMode = false )

Vérifie que la chaîne inputString peut être convertie en un nombre réel. La liste des séparateurs décimaux autorisés est définie par l’argument “separators”. Par défaut, les séparateurs autorisés sont le point, la virgule et le séparateur défini par l’utilisateur (configuré dans les paramètres régionaux du système d’exploitation, voir RegionalDecimalPoint). Le paramètre isStrictMode (par défaut = false) définit si la chaîne peut contenir des caractères autres que des chiffres, des espaces et des séparateurs.

Logic IsRealFuzzy( String, String separators = defaultDecimalSeparators, Logic isStrictMode = false )

Vérifie si la chaîne inputString peut être convertie de manière fiable en un nombre réel en tenant compte d’éventuelles erreurs de reconnaissance dans la chaîne. (voir la description de la fonction IsIntFuzzy pour plus de détails). La liste des séparateurs décimaux autorisés est spécifiée par l’argument « separators ». Par défaut, les séparateurs suivants sont autorisés : le point, la virgule et le séparateur spécifié dans les paramètres régionaux du système d’exploitation de l’utilisateur (voir RegionalDecimalPoint). Le paramètre isStrictMode (défini sur false par défaut) détermine si la chaîne peut contenir des caractères autres que des chiffres, des caractères ressemblant à des chiffres, des espaces ou des séparateurs.

Logic TestDBConnection( String connectionString )

Vérifie la connexion à la base de données. L’argument connectionString contient la chaîne de connexion.

Logic TestDBSelect( String connectionString, String selectString )

Vérifie si la base de données est accessible et si la requête SQL est correcte (si la table et le champ spécifiés existent). L’argument connectionString contient la chaîne de connexion. L’argument selectString contient la requête SQL, qui commence par la commande SELECT.

Logic TestFileAccess( String fileName )

Vérifie si le fichier texte est accessible.

Logic WriteToFile( String filename, String text )

Ajoute la chaîne « text » dans le fichier « filename ». Si aucun fichier ne porte ce nom, un nouveau fichier est créé.

Page Page( Int PageNumber )

Renvoie le type décrivant la page donnée.

Quality ValidateByDB( String word, String connectionString, String selectString, Int maxErrors, Real maxErrorsPart, Logic ignoreSpaces, Int maxRecordsCount = 1000 )

Vérifie le mot spécifié en le comparant à une base de données (voir Utilisation des bases de données et des fichiers texte dans le langage FlexiLayout). L’argument connectionString définit la chaîne de connexion à la base de données. L’argument selectString définit une requête SQL qui commence par la commande SELECT. L’argument maxErrors définit le nombre maximal absolu d’erreurs dans le mot, et l’argument maxErrorsPart définit le nombre maximal relatif d’erreurs dans le mot. Le paramètre ignoreSpaces détermine si les espaces doivent être pris en compte lors de la comparaison. Pour accélérer la recherche, seules les maxRecordsCount premières variantes sont utilisées (la valeur par défaut est 1000). Renvoie la qualité de la mise en correspondance entre le mot spécifié et la meilleure correspondance trouvée dans la base de données.

Remarque. Cette fonction peut être utilisée dans le champ Advanced Post-Search Relations pour une mise en correspondance approximative de la valeur de chaîne d’une hypothèse renvoyée par la méthode Value avec les variantes spécifiées.

Quality ValidateByFile( String word, String fileName, Int maxErrors, Real maxErrorsPart, Logic ignoreSpaces, Int maxRecordsCount = 1000 )

Vérifie le mot spécifié en le comparant aux variantes du fichier fileName, qui répertorie les variantes possibles d’une phrase (voir Utilisation des bases de données et des fichiers texte dans le langage FlexiLayout). L’argument maxErrors définit le nombre maximal absolu d’erreurs dans le mot, et maxErrorsPart définit le nombre maximal relatif d’erreurs dans le mot. ignoreSpaces détermine si les espaces doivent être pris en compte lors de la comparaison. Renvoie la qualité de la mise en correspondance entre le mot spécifié et la meilleure correspondance trouvée dans le fichier texte. Pour accélérer la recherche, seules les maxRecordsCount premières variantes sont utilisées (la valeur par défaut est 1000).

Remarque. Cette fonction peut être utilisée dans le champ Advanced Post-Search Relations pour effectuer une mise en correspondance approximative de la valeur string d’une hypothèse renvoyée par la méthode Value avec les variantes spécifiées.

Quality ValidateByText( String word, String variants, Int maxErrors, Real maxErrorsPart, Logic ignoreSpaces )

Vérifie le mot spécifié en le comparant aux variantes répertoriées. L’argument maxErrors définit le nombre maximal absolu d’erreurs dans le mot, et maxErrorsPart définit le nombre maximal relatif d’erreurs dans le mot. ignoreSpaces détermine si les espaces doivent être pris en compte lors de la comparaison. Renvoie la qualité de la mise en correspondance entre le mot spécifié et la meilleure correspondance parmi les variantes répertoriées dans l’argument variants.

Remarque. Cette fonction peut être utilisée dans le champ Relations post-recherche avancées pour la mise en correspondance approximative de la valeur de chaîne d’une hypothèse renvoyée par la méthode Value avec les variantes spécifiées.

Real Min( Real d1, Real d2 )

Renvoie la plus petite valeur entre d1 et d2.

Real Max( Real d1, Real d2 )

Renvoie la plus grande valeur entre d1 et d2.

Real StrToReal( String numberString, String separators = “.,”, Logic isStrictMode = false )

Renvoie le résultat de la conversion de la chaîne inputString en nombre réel. Les espaces sont ignorés. Le paramètre isStrictMode (par défaut = false) indique si la chaîne peut inclure des caractères autres que des chiffres, des espaces et des séparateurs. Si isStrictMode = false et que la chaîne contient un second séparateur décimal ou un caractère qui n’est ni un chiffre ni un espace, tous les caractères suivants sont ignorés. Il est recommandé de vérifier au préalable si la conversion est possible avant d’appeler cette fonction. Pour ce faire, utilisez la fonction IsReal.

Real StrToRealFuzzy( String, String separators = defaultDecimalSeparators, Logic isStrictMode = false )

Renvoie le résultat de la conversion de la valeur de la chaîne inputString en un nombre réel, en tenant compte d’éventuelles erreurs de reconnaissance dans la chaîne (voir la description de la fonction IsIntFuzzy pour plus de détails). Les espaces sont ignorés lors de la conversion. Le paramètre isStrictMode (défini sur false par défaut) détermine si la chaîne peut contenir des caractères autres que des chiffres, des caractères ressemblant à des chiffres, des espaces ou des séparateurs. Si isStrictMode = false et qu’un second séparateur décimal ou un caractère autre qu’un chiffre est rencontré, tous les caractères qui le suivent seront ignorés. Avant de lancer la conversion, nous recommandons d’appeler la fonction IsRealFuzzy pour vérifier si la chaîne peut être convertie sans risque.

Rect DocumentRect()

Renvoie le rectangle du document entier (en coordonnées globales).

Rect PageRect()

Le rectangle de l’image entière.

Important ! Cette fonction ne peut être utilisée que si le nombre maximal et le nombre minimal de pages du document sont définis sur 1, c’est-à-dire si le document détecté ne comporte qu’une seule page. Si vous utilisez cette fonction pour un document multipage, la mise en correspondance d’un FlexiLayout renverra une erreur. Pour un document multipage, cette fonction ne peut être utilisée que dans la section Relations de pré-recherche. Voir Fonctions qui limitent la zone de recherche.

Region FormRegion( RectArray included, RectArray excluded )

Crée une région comprenant le tableau des rectangles inclus et excluant le tableau des rectangles exclus.

StringArray ReadFromXML( String filename, String xPathQuery )

Lit le tableau de string à partir du fichier XML « filename ». Les string sont obtenues en évaluant la requête XPath transmise « xPathQuery ».

StringArray Record( String connectionString, String selectString, Int index )

Récupère les données d’un enregistrement spécifique. Pour une cellule dont la valeur est NULL, une chaîne vide est renvoyée.

String Chr( Int )

Retourne une chaîne à l’aide du code Unicode spécifié du caractère (le code doit être écrit en système décimal).

String LCase( String )

Renvoie une string obtenue en convertissant tous les caractères de la string spécifiée en minuscules.

String ReadSingleStringFromXML( String filename, String xPathQuery )

Lit la chaîne dans le fichier XML « filename ». La chaîne est obtenue en évaluant la requête XPath « xPathQuery » fournie.

String RealToStrVariants( Real value, String fractionalPartSeparators, Int maxDigitsCountInFractionalPart = 2 )

Crée des représentations sous forme de chaîne, séparées par une barre verticale (“|”), pour le nombre réel spécifié « value », les séparateurs décimaux fractionalPartSeparators et le nombre maximal de chiffres dans la partie fractionnaire. Par exemple, pour les arguments 19, ”.,”, 2, le résultat est “19|19.0|19.00|19,0|19,00”.

String Str( Int );

String Str( Logic );

String Str( Real );

String Str( XInterval );

String Str( YInterval );

String Str( DistInterval );

String Str( FuzzyRect );

String Str( Hypothesis );

String Str( RectArray );

String Str( Region );

String Str( Area );

String Str( Quality );

String Str( Distance );

String Str( PageInterval ).

Représentation d’un type de données sous forme de chaîne.

String RemoveSpaces( String )

Renvoie la string obtenue à partir de la string spécifiée après suppression de tous ses espaces.

String UCase( String )

Renvoie une string obtenue à partir de la string spécifiée en convertissant tous ses caractères en majuscules.

Void PrepareRecordset( String connectionString, String selectString, Int maxRecordsCount = 1000 )

Prépare la requête pour un accès rapide. Voir par exemple l’exemple de la fonction Record ci-dessous.

Void SetPagesCount( Int pagesCount )

Définit le nombre de pages du document. Cette fonction est utilisée dans les sections « Pre-search » ou « Post-search advanced code ». Elle doit être appelée à partir des éléments Header ou Footer, ou de leurs sous-éléments. Elle s’applique aux documents qui ne comportent pas d’indicateur de fin de document (le pied de page est absent ou facultatif).

XCoordinate Min( XCoordinate x1, XCoordinate x2 )

Renvoie la plus petite valeur entre x1 et x2.

XCoordinate Max( XCoordinate x1, XCoordinate x2 )

Renvoie la valeur maximale entre x1 et x2.

XCoordinate MiddleBetween( XCoordinate x1, XCoordinate x2 )

Renvoie la coordonnée X calculée selon la formule ( x1+ x2 ) / 2.

XCoordinate Between( XCoordinate x1, XCoordinate x2, Real ratio )

Renvoie la coordonnée X obtenue selon la formule x1 + ( x2 – x1 ) * ratio.

YCoordinate Min( YCoordinate y1, YCoordinate y2 )

Renvoie la plus petite valeur entre y1 et y2.

YCoordinate Max( YCoordinate y1, YCoordinate y2 )

Renvoie la valeur maximale de y1 et y2.

YCoordinate MiddleBetween( YCoordinate y1, YCoordinate y2 )

Renvoie un YInterval calculé comme ( y1+ y2 ) / 2.

YCoordinate Between( YCoordinate y1, YCoordinate y2, Real ratio )

Renvoie un YInterval calculé comme suit : y1+ ( y2 – y1 ) * ratio.

XInterval MiddleBetween( Xinterval x1, XInterval x2 )

Renvoie un XInterval calculé selon ( x1+ x2 ) / 2.

XInterval Between( Xinterval x2, Xinterval x2, Real ratio )

Renvoie un XInterval calculé comme suit : x1+ ( x2 – x1 ) * ratio.

YInterval MiddleBetween( Yinterval y1, Yinterval y2 )

Renvoie un YInterval calculé comme ( y1+ y2 ) / 2.

YInterval Between( Yinterval y1, Yinterval y2, Real ratio )

Renvoie le YInterval calculé selon y1 + ( y2 – y1 ) * ratio.

.

Void RecognizeText()

Reconnaît le texte dans le rectangle relatif défini par la propriété « Zone de pré-reconnaissance » dans les paramètres du projet. La reconnaissance porte sur toutes les pages du document.

Void RecognizeText( IntArray pages )

Reconnaît le texte dans le rectangle relatif spécifié dans la propriété « Pre-recognition area » des paramètres du projet. Seules les pages spécifiées par la partie « pages » de la chaîne sont prises en compte dans la reconnaissance.

Void RecognizeText( SearchAreaPageSetType pageSetType )

Reconnaît le texte dans le rectangle relatif spécifié dans la propriété « Zone de pré-reconnaissance » des paramètres du projet. Seules les pages indiquées par la partie « pageSetType » de la chaîne sont incluses dans la reconnaissance.

Void RecognizeText( Rect rect )

Reconnaît le texte dans le rectangle « rect ».

Void RecognizeText( Rect rect, IntArray pages )

Reconnaît le texte dans le rectangle « rect ». Seules les pages spécifiées dans la partie « pages » de la string sont prises en compte pour la reconnaissance.

Void RecognizeText( Rect rect, SearchAreaPageSetType pageSetType )

Reconnaît le texte dans le rectangle « rect », uniquement sur les pages du document spécifiées par « pageSetType ».

Void RecognizeText( RectArray rectArray )

Reconnaît le texte dans le tableau « rectArray » de rectangles.

Void RecognizeText( RectArray rectArray, IntArray pages )

Reconnaît le texte dans le tableau de rectangles « rectArray ». Seules les pages spécifiées dans la partie « pages » de la chaîne sont prises en compte pour la reconnaissance.

Void RecognizeText( RectArray rectArray, SearchAreaPageSetType pageSetType )

Reconnaît le texte dans le tableau « rectArray » de rectangles. Seules les pages spécifiées par la partie « pageSetType » de la chaîne sont prises en compte pour la reconnaissance.

Void RecognizeText( Region region )

Reconnaît le texte dans la région « region ».

Void RecognizeText( Region region, IntArray pages )

Reconnaît le texte dans la région « region ». Seules les pages indiquées dans la partie « pages » de la chaîne sont prises en compte pour la reconnaissance.

Void RecognizeText( Region region, SearchAreaPageSetType pageSetType )

Reconnaît le texte dans la région « region ». Seules les pages spécifiées par l’élément « pageSetType » de la chaîne sont prises en compte pour la reconnaissance.

RectArray RecognizedRects()

Une fonction de débogage permettant d’afficher un tableau de rectangles déjà reconnus.