Funções globais - ABBYY Vantage Documentation

Operações com áreas
Operações com distâncias
Operações com Tipos de Dados Numéricos
Operações com Rectangles e Regiões
Operações com strings
Acesso a arquivos XML
Conversão e Verificação de Tipos
Operações com Coordenadas
Acesso a catálogos de dados
Acesso a Parameters de Skill do tipo Text
Diversos

Operações com áreas

Function	Description
`Area Max( Area a1, Area a2 )`	Retorna o valor máximo entre a1 e a2.
`Area Min( Area a1, Area a2 )`	Retorna o valor mínimo entre a1 e a2.
`Area ObjectsArea( Rect, ImageObjectType )`	Retorna a área dos objetos do tipo especificado dentro do retângulo especificado. Opera em coordenadas globais.
`Area ObjectsIntersectionArea( Rect, ImageObjectType )`	Retorna a área dos objetos do tipo especificado dentro do retângulo especificado. Se a área dos objetos ultrapassar o retângulo especificado, retorna a interseção entre a área dos objetos e o retângulo especificado. Opera em coordenadas globais.

Operações com distâncias

Função	Descrição
`Distance Abs( Distance )`	Retorna o valor absoluto de uma distância.
`Distance AverageInterLineInterval()`	Retorna a altura média das linhas de texto na página. A função só pode ser usada se os números máximo e mínimo de páginas do documento estiverem definidos como 1. Para um documento de várias páginas, use o método correspondente do tipo Page: `Page( N ).AverageLineHeight`.
`Distance AverageLineHeight()`	Retorna a distância média entre as linhas de texto na página. A função só pode ser usada se os números máximo e mínimo de páginas do documento estiverem definidos como 1. Para um documento de várias páginas, use o método correspondente do tipo Page: `Page( N ).AverageInterLineInterval`.
`Distance Min( Distance d1, Distance d2 )`	Retorna o valor mínimo entre d1 e d2.
`Distance Max( Distance d1, Distance d2 )`	Retorna o valor máximo entre d1 e d2.

Operações com Tipos de Dados Numéricos

Função	Descrição
`Int abs( Int )`	Retorna o valor absoluto de um número.
`Int Ceil( Real )`	Retorna o menor inteiro que não seja menor que o argumento.
`Int Floor( Real )`	Retorna o maior inteiro que não seja maior que o argumento.
`Int Max( Int n1, Int n2 )`	Retorna o valor máximo entre n1 e n2.
`Int Min( Int n1, Int n2 )`	Retorna o valor mínimo entre n1 e n2.
`Int Round( Real )`	Retorna o inteiro mais próximo do argumento.
`Real Min( Real d1, Real d2 )`	Retorna o valor mínimo entre d1 e d2.
`Real Max( Real d1, Real d2 )`	Retorna o valor máximo entre d1 e d2.

Operações com Rectangles e Regiões

Função	Descrição
`Rect DocumentRect()`	Retorna o retângulo de todo o documento (em coordenadas globais).
`Rect PageRect()`	Retorna o retângulo de toda a imagem. A função só pode ser usada se os números máximo e mínimo de páginas do documento estiverem definidos como 1.
`Region FormRegion( RectArray included, RectArray excluded )`	Cria uma região que inclui a matriz de retângulos incluídos e exclui a matriz de retângulos excluídos.

Operações com strings

Function	Description
`String Chr( Int )`	Retorna uma string a partir do código Unicode especificado do caractere (o código deve estar em decimal).
`String LCase( String )`	Retorna uma string derivada da informada, convertendo todos os seus caracteres para minúsculas.
`String RealToStrVariants( Real value, String fractionalPartSeparators, Int maxDigitsCountInFractionalPart = 2 )`	Cria representações em string, separadas por barra vertical, para o número real “value”, com os separadores decimais fractionalPartSeparators e o número máximo de dígitos na parte fracionária.
`String Str( ... )`	Representação em string de um tipo de dado. Disponível para Int, Logic, Real, XInterval, YInterval, DistInterval, FuzzyRect, Hypothesis, RectArray, Region, Area, Quality, Distance, PageInterval.
`String RemoveSpaces( String )`	Retorna uma string derivada da informada, removendo todos os espaços.
`String UCase( String )`	Retorna uma string derivada da informada, convertendo todos os seus caracteres para maiúsculas.

Acesso a arquivos XML

Função	Descrição
`StringArray ReadFromXML( String filename, String xPathQuery )`	Lê um array de strings do arquivo XML “filename”. As strings são obtidas ao avaliar a consulta XPath informada em “xPathQuery”. Para mais informações sobre o uso de arquivos XML, consulte User Dictionaries. Observação: Para tornar o código mais claro, você pode definir constantes com parâmetros substituíveis para consultas XPath usadas com frequência e usar essas constantes nas chamadas de função.
`String ReadSingleStringFromXML( String filename, String xPathQuery )`	Lê uma string do arquivo XML “filename”. A string é obtida ao avaliar a consulta XPath informada em “xPathQuery”. Para mais informações sobre o uso de arquivos XML, consulte User Dictionaries.

Conversão e Verificação de Tipos

Function	Description
`Logic IsReal( String numberString, String separators = ".,", Logic isStrictMode = false )`	Verifica se a string inputString pode ser convertida com segurança em um número real. A lista de separadores decimais permitidos é definida pelo argumento “separators”.
`Logic IsRealFuzzy( String, String separators = defaultDecimalSeparators, Logic isStrictMode = false )`	Verifica se a string inputString pode ser convertida com segurança em um número real, levando em conta possíveis erros de reconhecimento na string.
`Logic IsInt( String inputString, Logic isStrictMode = false )`	Verifica se a string inputString pode ser convertida com segurança em um número inteiro.
`Logic IsIntFuzzy( String inputString, Logic isStrictMode = false )`	Verifica se a string inputString pode ser convertida com segurança em um inteiro, levando em conta possíveis erros de reconhecimento na string.
`Real StrToRealFuzzy( String, String separators = defaultDecimalSeparators, Logic isStrictMode = false )`	Retorna o resultado da conversão do valor da string inputString em um número real, levando em conta possíveis erros de reconhecimento.
`Real StrToReal( String numberString, String separators = ".,", Logic isStrictMode = false )`	Retorna o resultado da conversão da string inputString em um número real. Espaços são ignorados.
`Int StrToInt( String inputString, Logic isStrictMode = false )`	Retorna o resultado da conversão do valor da string inputString em um inteiro. Espaços são ignorados.
`Int StrToIntFuzzy( String, Logic isStrictMode = false )`	Retorna o resultado da conversão do valor da string inputString em um inteiro, levando em conta possíveis erros de reconhecimento.
`Int LogicToInt( Logic value )`	Retorna “1” se o valor for `true` e “0” se o valor for `false`.

Operações com Coordenadas

Function	Description
`XCoordinate Min( XCoordinate x1, XCoordinate x2 )`	Retorna o valor mínimo entre x1 e x2.
`XCoordinate Max( XCoordinate x1, XCoordinate x2 )`	Retorna o valor máximo entre x1 e x2.
`XCoordinate MiddleBetween( XCoordinate x1, XCoordinate x2 )`	Retorna a coordenada X calculada como ( x1 + x2 ) / 2.
`XCoordinate Between( XCoordinate x1, XCoordinate x2, Real ratio )`	Retorna a coordenada X calculada como x1 + ( x2 – x1 ) * ratio.
`YCoordinate Min( YCoordinate y1, YCoordinate y2 )`	Retorna o valor mínimo entre y1 e y2.
`YCoordinate Max( YCoordinate y1, YCoordinate y2 )`	Retorna o valor máximo entre y1 e y2.
`YCoordinate MiddleBetween( YCoordinate y1, YCoordinate y2 )`	Retorna a coordenada Y calculada como ( y1 + y2 ) / 2.
`YCoordinate Between( YCoordinate y1, YCoordinate y2, Real ratio )`	Retorna a coordenada Y calculada como y1 + ( y2 – y1 ) * ratio.
`XInterval MiddleBetween( Xinterval x1, XInterval x2 )`	Retorna o XInterval calculado como ( x1 + x2 ) / 2.
`XInterval Between( Xinterval x2, Xinterval x2, Real ratio )`	Retorna o XInterval calculado como x1 + ( x2 – x1 ) * ratio.
`YInterval MiddleBetween( Yinterval y1, Yinterval y2 )`	Retorna o YInterval calculado como ( y1 + y2 ) / 2.
`YInterval Between( Yinterval y1, Yinterval y2, Real ratio )`	Retorna o YInterval calculado como y1 + ( y2 – y1 ) * ratio.

Acesso a catálogos de dados

Observação: Para acessar um catálogo de dados, primeiro crie um parâmetro de Skill que faça referência a esse catálogo e, em seguida, use o nome desse parâmetro nas chamadas de método.

Function	Description
`Logic TestAccessToCatalog( String catalogParameterName )`	Testa o acesso ao catálogo de dados referenciado pelo parâmetro catalogParameterName.
`Logic TestCatalogSearchCriteria( String catalogParameterName, StringArray searchColumns, NamedValueArray searchCriteria )`	Verifica a validade dos critérios de pesquisa definidos para o catálogo de dados. Os critérios de pesquisa são definidos usando um array de valores nomeados, em que cada valor nomeado representa um nome de coluna e seu valor esperado. O array searchColumns especifica quais colunas do registro do catálogo de dados devem ser incluídas na resposta.
`StringArray FieldNamesOfCatalog( String catalogParameterName )`	Retorna a lista de todos os nomes de coluna no catálogo de dados referenciado pelo parâmetro catalogParameterName. As colunas são organizadas pelo número de índice em ordem crescente.
`StringArray FieldNamesOfCatalog( String catalogParameterName, StringArray searchColumnNames )`	Retorna a lista de nomes de coluna do catálogo de dados que aparecem no array searchColumnNames (sem distinção entre maiúsculas e minúsculas). As colunas são organizadas pelo número de índice em ordem crescente. Você pode usar este método para determinar os índices das colunas.
`Int RecordCountOfCatalog( String catalogParameterName, StringArray searchColumns, NamedValueArray searchCriteria = EmptyNamedValueArray )`	Retorna a quantidade de registros no catálogo de dados que atendem aos critérios de pesquisa especificados.
`Void PrepareRecordsetOfCatalog( String catalogParameterName, StringArray searchColumns, NamedValueArray searchCriteria = EmptyNamedValueArray, Int maxRecordsCount = 1000 )`	Recupera registros do catálogo de dados que atendem aos critérios de pesquisa.
`StringArray RecordOfCatalog( String catalogParameterName, StringArray searchColumns, NamedValueArray searchCriteria = EmptyNamedValueArray, Int rowIndex )`	Retorna um registro do catálogo de dados que atende aos critérios de pesquisa.
`Quality ValidateByCatalog( String word, String catalogParameterName, Int columnIndex, NamedValueArray searchCriteria = EmptyNamedValueArray, Int maxErrors, Rational maxErrorsPart, Logic ignoreSpaces = true, Int maxRecordsCount = 1000 )`	Verifica a string informada comparando-a com os valores da coluna de índice columnIndex no catálogo de dados. Retorna a qualidade da correspondência entre a string especificada e a melhor correspondência na coluna do catálogo de dados.
`Int GetCatalogColumnIndex( String catalogParameterName, String columnName )`	Retorna o índice da primeira coluna com o nome fornecido encontrada no catálogo de dados referenciado pelo parâmetro catalogParameterName. O nome da coluna não diferencia maiúsculas de minúsculas.
`IntArray GetCatalogColumnIndices( String catalogParameterName, String columnName )`	Retorna os índices de todas as colunas com o nome fornecido encontradas no catálogo de dados referenciado pelo parâmetro catalogParameterName. O nome da coluna não diferencia maiúsculas de minúsculas.

Acesso a Parameters de Skill do tipo Text

Function	Description
`Logic NamedParameterStringExists( String parameterName )`	Verifica se existe na skill um parâmetro de texto com o nome especificado. O nome do parâmetro diferencia maiúsculas de minúsculas.
`String GetNamedParameterString( String parameterName )`	Retorna o valor do parâmetro de texto com o nome especificado. O nome do parâmetro diferencia maiúsculas de minúsculas.

Diversos

Function	Description
`InputFieldArray InputFields()`	Retorna uma coleção de objetos — fields encontrados no documento durante as etapas anteriores do processamento do documento.
`Int PagesCount()`	Retorna o número de páginas do documento.
`Page Page( Int PageNumber )`	Retorna o objeto Page que representa a página com o número fornecido.
`Logic IsOnSameLine( Hypothesis, Hypothesis )`	Verifica se as hipóteses se intersectam verticalmente.

Variáveis predefinidas para descrição de regiões de campo Dicionários de usuário

⌘I