Funzioni globali - ABBYY Vantage Documentation

Operazioni sulle Aree
Operazioni con le distanze
Operazioni con tipi di dati numerici
Operazioni con Rectangle e Region
Operazioni sulle stringhe
Accesso ai file XML
Conversione e verifiche dei tipi
Operazioni con le coordinate
Accesso ai cataloghi di dati
Accesso ai Parameter dello Skill di tipo Testo
Varie

Operazioni sulle Aree

Function	Description
`Area Max( Area a1, Area a2 )`	Restituisce il valore massimo tra a1 e a2.
`Area Min( Area a1, Area a2 )`	Restituisce il valore minimo tra a1 e a2.
`Area ObjectsArea( Rect, ImageObjectType )`	Restituisce l’area degli oggetti del tipo specificato all’interno del rettangolo indicato. Opera in coordinate globali.
`Area ObjectsIntersectionArea( Rect, ImageObjectType )`	Restituisce l’area degli oggetti del tipo specificato all’interno del rettangolo indicato. Se l’area degli oggetti supera il rettangolo indicato, restituisce l’intersezione tra l’area degli oggetti e il rettangolo indicato. Opera in coordinate globali.

Operazioni con le distanze

Function	Description
`Distance Abs( Distance )`	Restituisce il valore assoluto di una distanza.
`Distance AverageInterLineInterval()`	Restituisce l’altezza media delle righe di testo nella pagina. La funzione può essere utilizzata solo se il numero minimo e massimo di pagine del documento è impostato su 1. Per un documento multipagina, utilizzare il metodo corrispondente del tipo Page: `Page( N ).AverageLineHeight`.
`Distance AverageLineHeight()`	Restituisce la distanza media tra le righe di testo nella pagina. La funzione può essere utilizzata solo se il numero minimo e massimo di pagine del documento è impostato su 1. Per un documento multipagina, utilizzare il metodo corrispondente del tipo Page: `Page( N ).AverageInterLineInterval`.
`Distance Min( Distance d1, Distance d2 )`	Restituisce il valore minimo tra d1 e d2.
`Distance Max( Distance d1, Distance d2 )`	Restituisce il valore massimo tra d1 e d2.

Operazioni con tipi di dati numerici

Funzione	Descrizione
`Int abs( Int )`	Restituisce il valore assoluto di un numero.
`Int Ceil( Real )`	Restituisce il più piccolo intero non inferiore all’argomento.
`Int Floor( Real )`	Restituisce il più grande intero non superiore all’argomento.
`Int Max( Int n1, Int n2 )`	Restituisce il valore massimo tra n1 e n2.
`Int Min( Int n1, Int n2 )`	Restituisce il valore minimo tra n1 e n2.
`Int Round( Real )`	Restituisce l’intero più vicino all’argomento.
`Real Min( Real d1, Real d2 )`	Restituisce il valore minimo tra d1 e d2.
`Real Max( Real d1, Real d2 )`	Restituisce il valore massimo tra d1 e d2.

Operazioni con Rectangle e Region

Funzione	Descrizione
`Rect DocumentRect()`	Restituisce il rettangolo dell’intero documento (in coordinate globali).
`Rect PageRect()`	Restituisce il rettangolo dell’intera immagine. La funzione può essere utilizzata solo se il numero massimo e minimo di pagine nel documento è impostato su 1.
`Region FormRegion( RectArray included, RectArray excluded )`	Crea una regione che include l’array dei rettangoli inclusi ed esclude l’array dei rettangoli esclusi.

Operazioni sulle stringhe

Funzione	Descrizione
`String Chr( Int )`	Restituisce una stringa usando il codice Unicode specificato del carattere (il codice deve essere in sistema decimale).
`String LCase( String )`	Restituisce una stringa ottenuta dalla stringa specificata convertendo tutti i caratteri in minuscolo.
`String RealToStrVariants( Real value, String fractionalPartSeparators, Int maxDigitsCountInFractionalPart = 2 )`	Crea rappresentazioni testuali, separate da una barra verticale, per il numero reale specificato “value”, i separatori della parte frazionaria “fractionalPartSeparators” e il numero massimo di cifre nella parte frazionaria.
`String Str( ... )`	Rappresentazione in stringa di un tipo di dato. Disponibile per Int, Logic, Real, XInterval, YInterval, DistInterval, FuzzyRect, Hypothesis, RectArray, Region, Area, Quality, Distance, PageInterval.
`String RemoveSpaces( String )`	Restituisce una stringa ottenuta dalla stringa specificata rimuovendo tutti gli spazi.
`String UCase( String )`	Restituisce una stringa ottenuta dalla stringa specificata convertendo tutti i caratteri in maiuscolo.

Accesso ai file XML

Funzione	Descrizione
`StringArray ReadFromXML( String filename, String xPathQuery )`	Legge un array di string da il file XML “filename”. Le string vengono ottenute valutando la query xPath passata “xPathQuery”. Per ulteriori informazioni sull’uso dei file XML, vedere Dizionari utente. Nota: Per rendere il codice più chiaro, è possibile definire costanti con parametri sostituibili per le query xPath utilizzate più frequentemente e usare queste costanti nelle chiamate di funzione.
`String ReadSingleStringFromXML( String filename, String xPathQuery )`	Legge una string dal file XML “filename”. La string viene ottenuta valutando la query xPath passata “xPathQuery”. Per ulteriori informazioni sull’uso dei file XML, vedere Dizionari utente.

Conversione e verifiche dei tipi

Function	Description
`Logic IsReal( String numberString, String separators = ".,", Logic isStrictMode = false )`	Verifica che la stringa inputString possa essere convertita in modo sicuro in un numero reale. L’elenco dei separatori decimali consentiti è definito dall’argomento “separators”.
`Logic IsRealFuzzy( String, String separators = defaultDecimalSeparators, Logic isStrictMode = false )`	Verifica se la stringa inputString può essere convertita in modo sicuro in un numero reale tenendo conto dei possibili errori di riconoscimento nella stringa.
`Logic IsInt( String inputString, Logic isStrictMode = false )`	Verifica che la stringa inputString possa essere convertita in modo sicuro in un numero intero.
`Logic IsIntFuzzy( String inputString, Logic isStrictMode = false )`	Verifica se la stringa inputString può essere convertita in modo sicuro in un numero intero tenendo conto dei possibili errori di riconoscimento nella stringa.
`Real StrToRealFuzzy( String, String separators = defaultDecimalSeparators, Logic isStrictMode = false )`	Restituisce il risultato della conversione del valore della stringa inputString in un numero reale, tenendo conto dei possibili errori di riconoscimento.
`Real StrToReal( String numberString, String separators = ".,", Logic isStrictMode = false )`	Restituisce il risultato della conversione della stringa inputString in un numero reale. Gli spazi vengono ignorati.
`Int StrToInt( String inputString, Logic isStrictMode = false )`	Restituisce il risultato della conversione del valore della stringa inputString in un numero intero. Gli spazi vengono ignorati.
`Int StrToIntFuzzy( String, Logic isStrictMode = false )`	Restituisce il risultato della conversione del valore della stringa inputString in un numero intero, tenendo conto dei possibili errori di riconoscimento.
`Int LogicToInt( Logic value )`	Restituisce “1” se il valore è `true` e “0” se il valore è `false`.

Operazioni con le coordinate

Funzione	Descrizione
`XCoordinate Min( XCoordinate x1, XCoordinate x2 )`	Restituisce il valore minimo tra x1 e x2.
`XCoordinate Max( XCoordinate x1, XCoordinate x2 )`	Restituisce il valore massimo tra x1 e x2.
`XCoordinate MiddleBetween( XCoordinate x1, XCoordinate x2 )`	Restituisce la coordinata X calcolata come ( x1 + x2 ) / 2.
`XCoordinate Between( XCoordinate x1, XCoordinate x2, Real ratio )`	Restituisce la coordinata X calcolata come x1 + ( x2 – x1 ) * ratio.
`YCoordinate Min( YCoordinate y1, YCoordinate y2 )`	Restituisce il valore minimo tra y1 e y2.
`YCoordinate Max( YCoordinate y1, YCoordinate y2 )`	Restituisce il valore massimo tra y1 e y2.
`YCoordinate MiddleBetween( YCoordinate y1, YCoordinate y2 )`	Restituisce la coordinata Y calcolata come ( y1 + y2 ) / 2.
`YCoordinate Between( YCoordinate y1, YCoordinate y2, Real ratio )`	Restituisce la coordinata Y calcolata come y1 + ( y2 – y1 ) * ratio.
`XInterval MiddleBetween( Xinterval x1, XInterval x2 )`	Restituisce XInterval calcolato come ( x1 + x2 ) / 2.
`XInterval Between( Xinterval x1, Xinterval x2, Real ratio )`	Restituisce XInterval calcolato come x1 + ( x2 – x1 ) * ratio.
`YInterval MiddleBetween( Yinterval y1, Yinterval y2 )`	Restituisce YInterval calcolato come ( y1 + y2 ) / 2.
`YInterval Between( Yinterval y1, Yinterval y2, Real ratio )`	Restituisce YInterval calcolato come y1 + ( y2 – y1 ) * ratio.

Accesso ai cataloghi di dati

Nota: Per accedere a un catalogo di dati, è innanzitutto necessario creare un Parameter dello Skill che faccia riferimento a quel catalogo e poi usare il nome del Parameter nelle chiamate ai metodi.

Function	Description
`Logic TestAccessToCatalog( String catalogParameterName )`	Verifica l’accesso al catalogo di dati a cui fa riferimento il Parameter catalogParameterName.
`Logic TestCatalogSearchCriteria( String catalogParameterName, StringArray searchColumns, NamedValueArray searchCriteria )`	Verifica la validità dei criteri di ricerca impostati per il catalogo di dati. I criteri di ricerca sono impostati utilizzando un array di valori denominati, in cui ciascun valore rappresenta un nome di colonna e il relativo valore atteso. L’array searchColumns specifica quali colonne del record del catalogo di dati includere nella risposta.
`StringArray FieldNamesOfCatalog( String catalogParameterName )`	Restituisce l’elenco di tutti i nomi di colonna nel catalogo di dati a cui fa riferimento il Parameter catalogParameterName. Le colonne sono ordinate per numero di indice in ordine crescente.
`StringArray FieldNamesOfCatalog( String catalogParameterName, StringArray searchColumnNames )`	Restituisce l’elenco dei nomi delle colonne del catalogo di dati presenti nell’array searchColumnNames (senza distinzione tra maiuscole e minuscole). Le colonne sono ordinate per numero di indice in ordine crescente. È possibile usare questo metodo per determinare gli indici delle colonne.
`Int RecordCountOfCatalog( String catalogParameterName, StringArray searchColumns, NamedValueArray searchCriteria = EmptyNamedValueArray )`	Restituisce il numero di record nel catalogo di dati che soddisfano i criteri di ricerca specificati.
`Void PrepareRecordsetOfCatalog( String catalogParameterName, StringArray searchColumns, NamedValueArray searchCriteria = EmptyNamedValueArray, Int maxRecordsCount = 1000 )`	Recupera i record del catalogo di dati che soddisfano i criteri di ricerca.
`StringArray RecordOfCatalog( String catalogParameterName, StringArray searchColumns, NamedValueArray searchCriteria = EmptyNamedValueArray, Int rowIndex )`	Restituisce un record dal catalogo di dati che soddisfa i criteri di ricerca.
`Quality ValidateByCatalog( String word, String catalogParameterName, Int columnIndex, NamedValueArray searchCriteria = EmptyNamedValueArray, Int maxErrors, Rational maxErrorsPart, Logic ignoreSpaces = true, Int maxRecordsCount = 1000 )`	Verifica la string specificata confrontandola con i valori della colonna con indice columnIndex nel catalogo di dati. Restituisce la qualità della corrispondenza tra la string specificata e la corrispondenza migliore nella colonna del catalogo di dati.
`Int GetCatalogColumnIndex( String catalogParameterName, String columnName )`	Restituisce l’indice della prima colonna con il nome indicato trovata nel catalogo di dati a cui fa riferimento il Parameter catalogParameterName. Il nome della colonna non distingue tra maiuscole e minuscole.
`IntArray GetCatalogColumnIndices( String catalogParameterName, String columnName )`	Restituisce gli indici di tutte le colonne con il nome indicato trovate nel catalogo di dati a cui fa riferimento il Parameter catalogParameterName. Il nome della colonna non distingue tra maiuscole e minuscole.

Accesso ai Parameter dello Skill di tipo Testo

Function	Description
`Logic NamedParameterStringExists( String parameterName )`	Verifica se nello Skill esiste un Parameter di tipo testo con il nome specificato. Il nome del Parameter è case-sensitive.
`String GetNamedParameterString( String parameterName )`	Restituisce il valore del Parameter di tipo testo con il nome specificato. Il nome del Parameter è case-sensitive.

Varie

Function	Description
`InputFieldArray InputFields()`	Restituisce una raccolta di oggetti: field trovati nel documento durante le fasi precedenti dell’elaborazione del documento.
`Int PagesCount()`	Restituisce il numero di pagine del documento.
`Page Page( Int PageNumber )`	Restituisce l’oggetto Page che rappresenta la pagina con il numero indicato.
`Logic IsOnSameLine( Hypothesis, Hypothesis )`	Verifica se le ipotesi si intersecano verticalmente.

Variabili predefinite per la descrizione delle regioni dei Field Dizionari utente

⌘I