Opérations sur les zones
| Fonction | Description |
|---|---|
Area Max( Area a1, Area a2 ) | Renvoie la valeur maximale entre a1 et a2. |
Area Min( Area a1, Area a2 ) | Renvoie la valeur minimale entre a1 et a2. |
Area ObjectsArea( Rect, ImageObjectType ) | Renvoie la surface des objets du type spécifié à l’intérieur du rectangle spécifié. Fonctionne en coordonnées globales. |
Area ObjectsIntersectionArea( Rect, ImageObjectType ) | Renvoie la surface des objets du type spécifié à l’intérieur du rectangle spécifié. Si la surface des objets dépasse le rectangle spécifié, renvoie l’intersection entre la surface des objets et le rectangle spécifié. Fonctionne en coordonnées globales. |
Opérations sur les distances
| Function | Description |
|---|---|
Distance Abs( Distance ) | Retourne la valeur absolue d’une distance. |
Distance AverageInterLineInterval() | Retourne la hauteur moyenne des lignes de texte sur la page. 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. Pour un document multi-pages, utilisez la méthode correspondante du type Page : Page( N ).AverageLineHeight. |
Distance AverageLineHeight() | Retourne l’intervalle moyen entre les lignes de texte sur la page. 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. Pour un document multi-pages, utilisez la méthode correspondante du type Page : Page( N ).AverageInterLineInterval. |
Distance Min( Distance d1, Distance d2 ) | Retourne la valeur minimale entre d1 et d2. |
Distance Max( Distance d1, Distance d2 ) | Retourne la valeur maximale entre d1 et d2. |
Opérations sur les types de données numériques
| Fonction | Description |
|---|---|
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 Max( Int n1, Int n2 ) | Renvoie la valeur maximale parmi n1 et n2. |
Int Min( Int n1, Int n2 ) | Renvoie la valeur minimale parmi n1 et n2. |
Int Round( Real ) | Renvoie l’entier le plus proche de l’argument. |
Real Min( Real d1, Real d2 ) | Renvoie la valeur minimale parmi d1 et d2. |
Real Max( Real d1, Real d2 ) | Renvoie la valeur maximale parmi d1 et d2. |
Opérations avec les Rectangles et les Régions
| Fonction | Description |
|---|---|
Rect DocumentRect() | Renvoie le rectangle de l’ensemble du document (en coordonnées globales). |
Rect PageRect() | Renvoie le rectangle de l’ensemble de l’image. Cette fonction ne peut être utilisée que si le nombre minimal et maximal de pages du document est fixé à 1. |
Region FormRegion( RectArray included, RectArray excluded ) | Crée une région qui inclut le tableau des rectangles inclus et exclut le tableau des rectangles exclus. |
Opérations sur les strings
| Fonction | Description |
|---|---|
String Chr( Int ) | Retourne une string à partir du code Unicode spécifié du caractère (le code doit être écrit en décimal). |
String LCase( String ) | Retourne une string obtenue à partir de la string spécifiée en convertissant tous ses caractères en minuscules. |
String RealToStrVariants( Real value, String fractionalPartSeparators, Int maxDigitsCountInFractionalPart = 2 ) | Crée des représentations sous forme de string, séparées par une barre verticale, pour le nombre réel spécifié « value », les séparateurs de la partie fractionnaire fractionalPartSeparators et le nombre maximal de chiffres dans la partie fractionnaire. |
String Str( ... ) | Représentation d’un type de données sous forme de string. Disponible pour Int, Logic, Real, XInterval, YInterval, DistInterval, FuzzyRect, Hypothesis, RectArray, Region, Area, Quality, Distance, PageInterval. |
String RemoveSpaces( String ) | Retourne une string obtenue à partir de la string spécifiée en supprimant tous les espaces. |
String UCase( String ) | Retourne une string obtenue à partir de la string spécifiée en convertissant tous ses caractères en majuscules. |
Accès aux fichiers XML
| Fonction | Description |
|---|---|
StringArray ReadFromXML( String filename, String xPathQuery ) | Lit un tableau de chaînes à partir du fichier XML « filename ». Les chaînes sont obtenues en évaluant la requête XPath « xPathQuery » transmise. Pour plus d’informations sur l’utilisation des fichiers XML, voir User Dictionaries. Remarque : pour rendre le code plus lisible, vous pouvez définir des constantes avec des paramètres remplaçables pour les requêtes XPath fréquemment utilisées et utiliser ces constantes dans les appels de fonction. |
String ReadSingleStringFromXML( String filename, String xPathQuery ) | Lit une chaîne à partir du fichier XML « filename ». La chaîne est obtenue en évaluant la requête XPath « xPathQuery » transmise. Pour plus d’informations sur l’utilisation des fichiers XML, voir User Dictionaries. |
Conversion et contrôles de types
| Function | Description |
|---|---|
Logic IsReal( String numberString, String separators = ".,", Logic isStrictMode = false ) | Vérifie que la string inputString peut être convertie en toute sécurité en nombre réel. La liste des séparateurs décimaux autorisés est définie par l’argument “separators”. |
Logic IsRealFuzzy( String, String separators = defaultDecimalSeparators, Logic isStrictMode = false ) | Vérifie si la string inputString peut être convertie en toute sécurité en nombre réel en tenant compte des éventuelles erreurs de reconnaissance dans la string. |
Logic IsInt( String inputString, Logic isStrictMode = false ) | Vérifie que la string inputString peut être convertie en toute sécurité en nombre entier. |
Logic IsIntFuzzy( String inputString, Logic isStrictMode = false ) | Vérifie si la string inputString peut être convertie en toute sécurité en nombre entier en tenant compte des éventuelles erreurs de reconnaissance dans la string. |
Real StrToRealFuzzy( String, String separators = defaultDecimalSeparators, Logic isStrictMode = false ) | Renvoie le résultat de la conversion de la valeur de la string inputString en nombre réel en tenant compte des éventuelles erreurs de reconnaissance. |
Real StrToReal( String numberString, String separators = ".,", Logic isStrictMode = false ) | Renvoie le résultat de la conversion de la string inputString en nombre réel. Les espaces sont ignorés. |
Int StrToInt( String inputString, Logic isStrictMode = false ) | Renvoie le résultat de la conversion de la valeur de la string inputString en nombre entier. Les espaces sont ignorés. |
Int StrToIntFuzzy( String, Logic isStrictMode = false ) | Renvoie le résultat de la conversion de la valeur de la string inputString en nombre entier en tenant compte des éventuelles erreurs de reconnaissance. |
Int LogicToInt( Logic value ) | Renvoie “1” si la valeur est true et “0” si la valeur est false. |
Opérations sur les coordonnées
| Fonction | Description |
|---|---|
XCoordinate Min( XCoordinate x1, XCoordinate x2 ) | Renvoie la valeur minimale 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 comme ( x1 + x2 ) / 2. |
XCoordinate Between( XCoordinate x1, XCoordinate x2, Real ratio ) | Renvoie la coordonnée X calculée comme x1 + ( x2 – x1 ) * ratio. |
YCoordinate Min( YCoordinate y1, YCoordinate y2 ) | Renvoie la valeur minimale entre y1 et y2. |
YCoordinate Max( YCoordinate y1, YCoordinate y2 ) | Renvoie la valeur maximale entre y1 et y2. |
YCoordinate MiddleBetween( YCoordinate y1, YCoordinate y2 ) | Renvoie la coordonnée Y calculée comme ( y1 + y2 ) / 2. |
YCoordinate Between( YCoordinate y1, YCoordinate y2, Real ratio ) | Renvoie la coordonnée Y calculée comme y1 + ( y2 – y1 ) * ratio. |
XInterval MiddleBetween( Xinterval x1, XInterval x2 ) | Renvoie l’intervalle X calculé comme ( x1 + x2 ) / 2. |
XInterval Between( Xinterval x2, Xinterval x2, Real ratio ) | Renvoie l’intervalle X calculé comme x1 + ( x2 – x1 ) * ratio. |
YInterval MiddleBetween( Yinterval y1, Yinterval y2 ) | Renvoie l’intervalle Y calculé comme ( y1 + y2 ) / 2. |
YInterval Between( Yinterval y1, Yinterval y2, Real ratio ) | Renvoie l’intervalle Y calculé comme y1 + ( y2 – y1 ) * ratio. |
Accès aux catalogues de données
| Function | Description |
|---|---|
Logic TestAccessToCatalog( String catalogParameterName ) | Teste l’accès au catalogue de données référencé par le Parameter catalogParameterName. |
Logic TestCatalogSearchCriteria( String catalogParameterName, StringArray searchColumns, NamedValueArray searchCriteria ) | Vérifie la validité des critères de recherche définis pour le catalogue de données. Les critères de recherche sont définis à l’aide d’un tableau de valeurs nommées, où chaque valeur nommée représente un nom de colonne et sa valeur attendue. Le tableau searchColumns précise quelles colonnes de l’enregistrement du catalogue de données doivent être incluses dans la réponse. |
StringArray FieldNamesOfCatalog( String catalogParameterName ) | Renvoie la liste de tous les noms de colonnes du catalogue de données référencé par le Parameter catalogParameterName. Les colonnes sont triées par numéro d’index par ordre croissant. |
StringArray FieldNamesOfCatalog( String catalogParameterName, StringArray searchColumnNames ) | Renvoie la liste des noms de colonnes du catalogue de données qui figurent dans le tableau searchColumnNames (insensible à la casse). Les colonnes sont triées par numéro d’index par ordre croissant. Vous pouvez utiliser cette méthode pour déterminer les index de colonnes. |
Int RecordCountOfCatalog( String catalogParameterName, StringArray searchColumns, NamedValueArray searchCriteria = EmptyNamedValueArray ) | Renvoie le nombre d’enregistrements du catalogue de données qui répondent aux critères de recherche spécifiés. |
Void PrepareRecordsetOfCatalog( String catalogParameterName, StringArray searchColumns, NamedValueArray searchCriteria = EmptyNamedValueArray, Int maxRecordsCount = 1000 ) | Récupère les enregistrements du catalogue de données qui répondent aux critères de recherche. |
StringArray RecordOfCatalog( String catalogParameterName, StringArray searchColumns, NamedValueArray searchCriteria = EmptyNamedValueArray, Int rowIndex ) | Renvoie un enregistrement du catalogue de données qui répond aux critères de recherche. |
Quality ValidateByCatalog( String word, String catalogParameterName, Int columnIndex, NamedValueArray searchCriteria = EmptyNamedValueArray, Int maxErrors, Rational maxErrorsPart, Logic ignoreSpaces = true, Int maxRecordsCount = 1000 ) | Vérifie la string spécifiée en la comparant aux valeurs de la colonne d’index columnIndex dans le catalogue de données. Renvoie la qualité de correspondance entre la string spécifiée et la meilleure correspondance issue de la colonne du catalogue de données. |
Int GetCatalogColumnIndex( String catalogParameterName, String columnName ) | Renvoie l’index de la première colonne portant le nom donné trouvée dans le catalogue de données référencé par le Parameter catalogParameterName. Le nom de la colonne n’est pas sensible à la casse. |
IntArray GetCatalogColumnIndices( String catalogParameterName, String columnName ) | Renvoie les index de toutes les colonnes portant le nom donné trouvées dans le catalogue de données référencé par le Parameter catalogParameterName. Le nom de la colonne n’est pas sensible à la casse. |
Accès aux Parameters de Skill de type Text
| Function | Description |
|---|---|
Logic NamedParameterStringExists( String parameterName ) | Vérifie si un paramètre texte portant le nom indiqué existe dans le Skill. Le nom du Parameter est sensible à la casse. |
String GetNamedParameterString( String parameterName ) | Renvoie la valeur du paramètre texte portant le nom indiqué. Le nom du Parameter est sensible à la casse. |
Divers
| Fonction | Description |
|---|---|
InputFieldArray InputFields() | Renvoie une collection d’objets — les champs trouvés dans le document lors des étapes précédentes du traitement. |
Int PagesCount() | Renvoie le nombre de pages du document. |
Page Page( Int PageNumber ) | Renvoie l’objet Page représentant la page portant le numéro indiqué. |
Logic IsOnSameLine( Hypothesis, Hypothesis ) | Vérifie si les hypothèses s’intersectent verticalement. |