全局函数 - ABBYY Developer Documentation

区域运算
距离运算
数值数据类型的运算
矩形与区域操作
字符串操作
访问 XML 文件
类型转换与检查
坐标运算
访问数据目录（data catalog）
访问类型为 Text 的 Skill 参数
杂项

区域运算

函数	说明
`Area Max( Area a1, Area a2 )`	返回 a1 和 a2 中的较大值。
`Area Min( Area a1, Area a2 )`	返回 a1 和 a2 中的较小值。
`Area ObjectsArea( Rect, ImageObjectType )`	返回指定矩形内指定类型对象的面积。采用全局坐标。
`Area ObjectsIntersectionArea( Rect, ImageObjectType )`	返回指定矩形内指定类型对象的面积。若对象面积超出指定矩形，则返回对象面积与该矩形的相交部分。采用全局坐标。

距离运算

函数	描述
`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 中的较大值。

矩形与区域操作

函数	描述
`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 以及小数部分的最大位数，生成以竖线分隔的多种字符串表示。
`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	描述
`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 计算的 Y 坐标。
`YCoordinate Between( YCoordinate y1, YCoordinate y2, Real ratio )`	返回按 y1 + ( y2 – y1 ) * ratio 计算的 Y 坐标。
`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。

访问数据目录（data catalog）

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

Function	Description
`Logic TestAccessToCatalog( String catalogParameterName )`	测试由参数 catalogParameterName 引用的数据目录的访问可用性。
`Logic TestCatalogSearchCriteria( String catalogParameterName, StringArray searchColumns, NamedValueArray searchCriteria )`	检查为数据目录设置的搜索条件是否有效。搜索条件通过命名值数组设置，其中每个命名值表示列名及其期望值。searchColumns 数组指定响应中需要包含的数据目录记录的列。
`StringArray FieldNamesOfCatalog( String catalogParameterName )`	返回由参数 catalogParameterName 引用的数据目录的所有列名列表。列按索引号升序排列。
`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 引用的数据目录中首个匹配给定名称的列索引。列名不区分大小写。
`IntArray GetCatalogColumnIndices( String catalogParameterName, String columnName )`	返回由参数 catalogParameterName 引用的数据目录中所有匹配给定名称的列索引。列名不区分大小写。

访问类型为 Text 的 Skill 参数

Function	Description
`Logic NamedParameterStringExists( String parameterName )`	检查 Skill 中是否存在具有指定名称的文本参数。参数名称区分大小写。
`String GetNamedParameterString( String parameterName )`	返回具有指定名称的文本参数的值。参数名称区分大小写。

杂项

函数	说明
`InputFieldArray InputFields()`	返回一个对象集合——在此前文档处理阶段在文档中找到的field。
`Int PagesCount()`	返回文档的页数。
`Page Page( Int PageNumber )`	返回表示指定页码的 Page 对象。
`Logic IsOnSameLine( Hypothesis, Hypothesis )`	检查两个假设在垂直方向上是否相交。

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

⌘I