全局函数 - ABBYY Vantage Documentation

面积运算
距离类型运算
数值数据类型的运算
矩形和区域操作
字符串操作
访问 XML 文件
类型转换与检查
坐标运算
访问数据目录
访问技能中 Text 类型的 Parameter
杂项

面积运算

Function	Description
`Area Max( Area a1, Area a2 )`	返回 a1 和 a2 中的较大值。
`Area Min( Area a1, Area a2 )`	返回 a1 和 a2 中的较小值。
`Area ObjectsArea( Rect, ImageObjectType )`	返回指定矩形内指定类型对象的面积。在全局坐标系中工作。
`Area ObjectsIntersectionArea( Rect, ImageObjectType )`	返回指定矩形内指定类型对象的面积。如果对象的面积超出指定矩形，则返回对象面积与指定矩形的交集面积。在全局坐标系中工作。

距离类型运算

Function	Description
`Distance Abs( Distance )`	返回距离的绝对值。
`Distance AverageInterLineInterval()`	返回页面上文本行的平均高度。仅当文档的最小页数和最大页数都设置为 1 时才能使用该函数。对于多页文档，请使用 Page 类型的相应方法：`Page( N ).AverageLineHeight`。
`Distance AverageLineHeight()`	返回页面上文本行之间的平均距离。仅当文档的最小页数和最大页数都设置为 1 时才能使用该函数。对于多页文档，请使用 Page 类型的相应方法：`Page( N ).AverageInterLineInterval`。
`Distance Min( Distance d1, Distance d2 )`	返回 d1 和 d2 中的较小值。
`Distance Max( Distance d1, Distance d2 )`	返回 d1 和 d2 中的较大值。

数值数据类型的运算

Function	Description
`Int abs( Int )`	返回一个数的绝对值。
`Int Ceil( Real )`	返回不小于参数的最小整数。
`Int Floor( Real )`	返回不大于参数的最大整数。
`Int Max( Int n1, Int n2 )`	返回 n1 和 n2 中的最大值。
`Int Min( Int n1, Int n2 )`	返回 n1 和 n2 中的最小值。
`Int Round( Real )`	返回最接近该参数的整数。
`Real Min( Real d1, Real d2 )`	返回 d1 和 d2 中的最小值。
`Real Max( Real d1, Real d2 )`	返回 d1 和 d2 中的最大值。

矩形和区域操作

Function	Description
`Rect DocumentRect()`	返回整个文档在全局坐标系中的矩形。
`Rect PageRect()`	返回整个图像的矩形。仅当文档中的最小页数和最大页数均设置为 1 时才能使用此函数。
`Region FormRegion( RectArray included, RectArray excluded )`	创建一个区域，其中包含 `included` 数组中的矩形，并排除 `excluded` 数组中的矩形。

字符串操作

Function	Description
`String Chr( Int )`	返回根据指定字符的 Unicode 代码（代码必须用十进制表示）生成的字符串。
`String LCase( String )`	返回从指定字符串转换而来、其所有字符均为小写形式的字符串。
`String RealToStrVariants( Real value, String fractionalPartSeparators, Int maxDigitsCountInFractionalPart = 2 )`	为指定实数 value、小数分隔符 fractionalPartSeparators 以及小数部分的最大位数 maxDigitsCountInFractionalPart 创建多个字符串表示形式，并用竖线分隔。
`String Str( ... )`	数据类型的字符串表示形式。可用于 Int、Logic、Real、XInterval、YInterval、DistInterval、FuzzyRect、Hypothesis、RectArray、Region、Area、Quality、Distance、PageInterval。
`String RemoveSpaces( String )`	返回从指定字符串转换而来、已移除其中所有空格的字符串。
`String UCase( String )`	返回从指定字符串转换而来、其所有字符均为大写形式的字符串。

访问 XML 文件

Function	Description
`StringArray ReadFromXML( String filename, String xPathQuery )`	从名为 “filename” 的 XML 文件中读取字符串数组。字符串是通过计算传入的 xPath 查询 “xPathQuery” 获得的。有关使用 XML 文件的更多信息，请参见 User Dictionaries。注意：为使代码更清晰，您可以针对经常使用的 xPath 查询定义包含可替换参数的常量，并在函数调用中使用这些常量。
`String ReadSingleStringFromXML( String filename, String xPathQuery )`	从名为 “filename” 的 XML 文件中读取一个字符串。该字符串是通过计算传入的 xPath 查询 “xPathQuery” 获得的。有关使用 XML 文件的更多信息，请参见 User Dictionaries。

类型转换与检查

Function	Description
`Logic IsReal( String numberString, String separators = ".,", Logic isStrictMode = false )`	检查字符串 inputString 是否可以安全地转换为实数。允许使用的小数分隔符列表由参数 separators 指定。
`Logic IsRealFuzzy( String, String separators = defaultDecimalSeparators, Logic isStrictMode = false )`	在考虑字符串中可能存在的识别错误的情况下，检查字符串 inputString 是否可以安全地转换为实数。
`Logic IsInt( String inputString, Logic isStrictMode = false )`	检查字符串 inputString 是否可以安全地转换为整数。
`Logic IsIntFuzzy( String inputString, Logic isStrictMode = false )`	在考虑字符串中可能存在的识别错误的情况下，检查字符串 inputString 是否可以安全地转换为整数。
`Real StrToRealFuzzy( String, String separators = defaultDecimalSeparators, Logic isStrictMode = false )`	在考虑可能的识别错误的情况下，返回将字符串 inputString 的值转换为实数的结果。
`Real StrToReal( String numberString, String separators = ".,", Logic isStrictMode = false )`	返回将字符串 inputString 转换为实数的结果。转换时会忽略空格。
`Int StrToInt( String inputString, Logic isStrictMode = false )`	返回将字符串 inputString 的值转换为整数的结果。转换时会忽略空格。
`Int StrToIntFuzzy( String, Logic isStrictMode = false )`	在考虑可能的识别错误的情况下，返回将字符串 inputString 的值转换为整数的结果。
`Int LogicToInt( Logic value )`	如果值为 `true`，则返回 “1”；如果值为 `false`，则返回 “0”。

坐标运算

Function	Description
`XCoordinate Min( XCoordinate x1, XCoordinate x2 )`	返回 x1 与 x2 中的最小值。
`XCoordinate Max( XCoordinate x1, XCoordinate x2 )`	返回 x1 与 x2 中的最大值。
`XCoordinate MiddleBetween( XCoordinate x1, XCoordinate x2 )`	返回通过 ( x1 + x2 ) / 2 计算的 X 坐标值。
`XCoordinate Between( XCoordinate x1, XCoordinate x2, Real ratio )`	返回通过 x1 + ( x2 – x1 ) * ratio 计算的 X 坐标值。
`YCoordinate Min( YCoordinate y1, YCoordinate y2 )`	返回 y1 与 y2 中的最小值。
`YCoordinate Max( YCoordinate y1, YCoordinate y2 )`	返回 y1 与 y2 中的最大值。
`YCoordinate MiddleBetween( YCoordinate y1, YCoordinate y2 )`	返回通过 ( y1 + y2 ) / 2 计算的 YInterval 值。
`YCoordinate Between( YCoordinate y1, YCoordinate y2, Real ratio )`	返回通过 y1 + ( y2 – y1 ) * ratio 计算的 YInterval 值。
`XInterval MiddleBetween( Xinterval x1, XInterval x2 )`	返回通过 ( x1 + x2 ) / 2 计算的 XInterval 值。
`XInterval Between( Xinterval x2, Xinterval x2, Real ratio )`	返回通过 x1 + ( x2 – x1 ) * ratio 计算的 XInterval 值。
`YInterval MiddleBetween( Yinterval y1, Yinterval y2 )`	返回通过 ( y1 + y2 ) / 2 计算的 YInterval 值。
`YInterval Between( Yinterval y1, Yinterval y2, Real ratio )`	返回通过 y1 + ( y2 – y1 ) * ratio 计算的 YInterval 值。

访问数据目录

注意： 要访问数据目录，首先应创建一个引用该目录的技能 Parameter，然后在方法调用中使用该 Parameter 名称。

Function	Description
`Logic TestAccessToCatalog( String catalogParameterName )`	测试对由 catalogParameterName Parameter 引用的数据目录的访问是否可用。
`Logic TestCatalogSearchCriteria( String catalogParameterName, StringArray searchColumns, NamedValueArray searchCriteria )`	检查为数据目录设置的搜索条件是否有效。搜索条件使用命名值数组进行设置，其中每个命名值表示一个列名及其期望值。searchColumns 数组指定在响应中要返回的数据目录记录的列。
`StringArray FieldNamesOfCatalog( String catalogParameterName )`	返回由 catalogParameterName Parameter 引用的数据目录中所有列名的列表。列按索引号升序排列。
`StringArray FieldNamesOfCatalog( String catalogParameterName, StringArray searchColumnNames )`	返回出现在 searchColumnNames 数组中的数据目录列名列表（不区分大小写）。列按索引号升序排列。可以使用此方法来确定列索引。
`Int RecordCountOfCatalog( String catalogParameterName, StringArray searchColumns, NamedValueArray searchCriteria = EmptyNamedValueArray )`	返回数据目录中满足指定搜索条件的记录数。
`Void PrepareRecordsetOfCatalog( String catalogParameterName, StringArray searchColumns, NamedValueArray searchCriteria = EmptyNamedValueArray, Int maxRecordsCount = 1000 )`	获取满足搜索条件的数据目录记录。
`StringArray RecordOfCatalog( String catalogParameterName, StringArray searchColumns, NamedValueArray searchCriteria = EmptyNamedValueArray, Int rowIndex )`	返回一条满足搜索条件的数据目录记录。
`Quality ValidateByCatalog( String word, String catalogParameterName, Int columnIndex, NamedValueArray searchCriteria = EmptyNamedValueArray, Int maxErrors, Rational maxErrorsPart, Logic ignoreSpaces = true, Int maxRecordsCount = 1000 )`	通过将指定的 word 字符串与数据目录中索引为 columnIndex 的列的值进行比较来检查该字符串。返回指定字符串与数据目录该列中最佳匹配值之间的匹配质量。
`Int GetCatalogColumnIndex( String catalogParameterName, String columnName )`	返回在由 catalogParameterName Parameter 引用的数据目录中找到的第一个具有给定名称的列的索引。列名不区分大小写。
`IntArray GetCatalogColumnIndices( String catalogParameterName, String columnName )`	返回在由 catalogParameterName Parameter 引用的数据目录中找到的所有具有给定名称的列的索引。列名不区分大小写。

访问技能中 Text 类型的 Parameter

Function	Description
`Logic NamedParameterStringExists( String parameterName )`	检查技能中是否存在具有给定名称的 Text 类型 Parameter。Parameter 名称区分大小写。
`String GetNamedParameterString( String parameterName )`	返回具有给定名称的 Text 类型 Parameter 的值。Parameter 名称区分大小写。

杂项

Function	Description
`InputFieldArray InputFields()`	返回一个对象集合，即在之前文档处理阶段中在文档中找到的字段。
`Int PagesCount()`	返回文档中的页面数量。
`Page Page( Int PageNumber )`	返回表示给定页码页面的 Page 对象。
`Logic IsOnSameLine( Hypothesis, Hypothesis )`	检查两个假设在垂直方向上是否相交。

预定义字段区域描述变量用户词典