函数定义

下面是按字母排序的可用于派生的公式属性定义的函数列表。

Abbrev

说明

返回当前节点的名称(缩写)。

语法

Abbrev(): String 

示例

Abbrev()

返回值是节点的名称。

Add

说明

将两个指定的整数值相加并返回结果。

语法

Add(Int1,Int2:Integer):Integer

示例

Add(1,4)

返回值为 5。

AddedBy

说明

返回“添加者”更改跟踪属性的值。

语法

AddedBy():String

示例

AddedBy()

返回向版本中添加当前节点的用户的名称。

AddedOn

说明

以日期/时间形式返回“添加时间”更改跟踪属性的值。

语法

AddedOn():Date/Time

示例

AddedOn()

返回向版本中添加当前节点的日期和时间。

AddFloat

说明

将两个指定的浮点值相加并返回结果。

语法

AddFloat(Float1,Float2:Float):Float

示例

AddFloat(2.14,3.75)

返回值为 5.89。

AncestorProp

说明

返回属性等于指定值的第一个祖先的属性值。

此函数的适用范围为本地,如果在全局上下文中使用,则无法正常运行。

注:

如果当前节点满足条件,则将其返回。

语法

AncestorProp(Operator:String,Property:String,Value:String,FromTop:Boolean,ReturnProp:String)

Operator 是比较属性和值时要使用的运算符。有效值:=、<、>、>= 和 <=。

Property 是要使用的属性的名称。

Value 是要比较的值。

FromTop 指定是否从层次的顶级节点搜索。如果为 False,则从当前节点开始执行搜索。

ReturnProp 是要返回的属性的名称。

And

说明

如果所有指定布尔表达式计算结果都为 True,则返回 True。

语法

And(Expression1,Expression2,...ExpressionN:Boolean):Boolean 

示例

And(1,T,True)

返回值为 True。

ArrayCount

说明

返回指定列表(数组)中的项目数。

语法

ArrayCount(List:String,Delimiter:String):Integer

List 指定要在其中进行搜索的字符串列表。

Delimiter 是用于分隔字符串列表中项的字符。支持的特殊字符:

  • [逗号]

  • [空格]

  • [制表符]

注:

必须使用分隔符的名称(而不是字符)并将名称括在括号中。

示例

ArrayCount(Diet Cola;Root Beer;Cola,[comma])

返回值为 3。

ArrayIndex

说明

返回指定的项目在列表(数组)中首次出现的位置。如果找不到项目,则返回零 (0)。

语法

ArrayIndex(Item:String,List:String,Delimiter:String):Integer 

Item 指定要测试的字符串值。

List 指定要在其中进行搜索的字符串列表。

Delimiter 是用于分隔字符串列表中项的字符。支持的特殊字符:

  • [逗号]

  • [空格]

  • [制表符]

注:

必须使用分隔符的名称(而不是字符)并将名称括在括号中。

示例

ArrayIndex(Cola,Diet Cola;Root Beer;Cola,[comma])

返回值为 3。

ArrayItem

说明

返回列表(数组)中指定索引位置的项目。

语法

ArrayItem(List:String,Delimiter:String,Index:Integer):String

List 指定要在其中进行搜索的字符串列表。

Delimiter 是用于分隔字符串列表中项的字符。支持的特殊字符:

  • [逗号]

  • [空格]

  • [制表符]

注:

必须使用分隔符的名称(而不是字符)并将名称括在括号中。

Index 是字符串在列表中的位置。负值表示列表中的最后一项。

示例

ArrayItem(Diet Cola;Root Beer;Cola,;,3)

返回值为 Cola。

AscNodeProp

说明

返回指定属性引用的关联节点的属性值。

语法

AscNodeProp(LookUpProperty,ReturnProperty)

LookupProperty 是指向节点的属性的名称。属性的数据类型必须为 Node 或 AscNode。

ReturnProperty 是要返回的关联节点属性名称。属性必须为全局属性。

AvgList

说明

返回列表中项目的平均值,忽略空白项目。如果列表包含不是指定项目类型的项目,则返回空白字符串。

语法

AvgList(InputList:String,Delimiter:String,ItemType:String):String

InputList 指定要使用的列表。

Delimiter 是用于分隔字符串列表中项的字符。支持的特殊字符:

  • [逗号]

  • [空格]

  • [制表符]

注:

必须使用分隔符的名称(而不是字符)并将名称括在括号中。

ItemType 指示列表成员所需的项目数据类型。有效值:integer、float 和 datetime。默认值为 float。

示例

AvgList(1;2;3,[comma],Integer)

返回值为 2。

BoolToStr

说明

返回转换为 True 或 False 的布尔值。如果输入不表示布尔值,则返回 False。

语法

BoolToStr(Expression:Boolean):String 

示例

BoolToStr(1)

返回值为 True。

Changed

说明

以布尔值形式返回“节点已更改”更改跟踪属性的值。

语法

Changed()

ChangedBy

说明

返回上次更新版本中当前节点的用户的名称。

语法

ChangedBy():String

示例

ChangedBy()

ChangedOn

说明

返回“更改时间”更改跟踪属性的值。

语法

ChangedOn():Date/Time

示例

ChangedOn()

返回上次在版本中更新当前节点的日期和时间。

Concat

说明

将两个或多个指定的字符串串联为一个字符串并返回结果。

语法

Concat(Item1,Item2,... ItemN:String):String 

示例

Concat(Abbrev,-,Descr())

如果当前节点名称为 100 并且当前节点说明为 Colas,则返回值为 100–Colas。

ConcatWithDelimiter

说明

将两个或多个字符串串联为一个带分隔符的列表并返回结果。

语法

ConcatWithDelimiter(Delimiter:String,SkipBlanks:Boolean,Items:String)

Delimiter 是用于分隔字符串列表中项的字符。支持的特殊字符:

  • [逗号]

  • [空格]

  • [制表符]

注:

必须使用分隔符的名称(而不是字符)并将名称括在括号中。

SkipBlanks 指示是否跳过字符串列表中的空白值。有效值:1、0、T、F、t、f。

Items 指定要串联的一系列字符串。

示例

ConcatWithDelimiter([comma],1,Item1,Item2,Item3,Item4)

返回值为 Item1; Item2; Item3; Item4。

Decode

说明

返回输入字符串以及由适当字符取代的 [openparen]、[closeparen]、[comma]、[tab]、[space]、[crlf]、[cr] 和 [lf] 的所有实例。

注:

此函数用于升级使用特殊字符的属性定义名称。这些特殊字符可能会导致派生属性公式的解析问题。此函数主要用于将使用过时的派生程序类的现有属性转换为 Formula 派生程序类。

语法

Decode(CodedString:String):String

CodedString 是对其执行函数的字符串值。

DefaultProp

说明

返回属性的默认值。

语法

DefaultProp(Property:String)

Property 是要使用的属性的名称。

Descr

说明

返回当前节点的说明。

语法

Descr():String

示例

如果当前节点说明为 Colas,则返回值为 Colas。

Divide

说明

将两个指定的整数值相除并返回结果。

语法

Divide(Int1,Int2:Integer):Integer

示例

Divide(200,10)

返回值为 20。

DivideFloat

说明

将两个浮点数(浮点)相除并返回结果。

语法

Divide(Float1,Float2:Float):Float

示例

DivideFloat(2.535,1.5)

返回值为 1.69。

DualAncestorProp

说明

返回两个属性等于指定值的第一个祖先的属性值。

此函数的适用范围为本地,如果在全局上下文中使用,则无法正常运行。

语法

DualAncestorProp(Operator1:String,Property1:String,Value1:String,Operator2:String,Property2:String,Value2:String,FromTop:Boolean,ReturnProp:String):String

Operator1 是比较第一个属性和值时要使用的运算符。有效值:=、<、>、>= 和 <=。

Property1 是要检查的第一个属性的名称。

Value1 是要比较的第一个值。

Operator2 是比较第二个属性和值时要使用的运算符。有效值:=、<、>、>= 和 <=。

Property2 是要检查的第二个属性的名称。

Value2 是要比较的第二个值。

FromTop 指定是否从层次的顶级节点搜索。如果为 False,则从当前节点开始执行搜索。

ReturnProp 是要返回的祖先属性名称。

Equals

说明

如果两个指定的值相等,则返回 True。此函数区分大小写。

语法

Equals(ParamType:String,Param1:String,Param2:String):Boolean

ParamType 是要用于比较值的数据类型。有效值:string、integer、float 和 date。默认值为 integer。

Param1 是要比较的第一个值。

Param2 是要比较的第二个值。

示例

Equals(integer,01,1)

返回值为 True。

FlipList

说明

返回表示指定列表的反转列表的字符串。

语法

FlipList(List,Delimiter:String):String

List 指定要翻转的字符串列表。

Delimiter 是用于分隔字符串列表中项的字符。支持的特殊字符:

  • [逗号]

  • [空格]

  • [制表符]

注:

必须使用分隔符的名称(而不是字符)并将名称括在括号中。

示例

FlipList(DietCola;Orange Soda;Root Beer;Lemonade,[comma])

返回值为 Lemonade,Root Beer,Orange Soda,Diet Cola。

FloatToStr

说明

返回转换为字符串的浮点值。如果输入值不表示浮点值,则返回零 (0)。

语法

FloatToStr(Float1:Float):String

示例

FloatToStr(1.001)

返回值为 1.001。

Format

说明

使用指定的格式字符串参数类型标识符和指定类型的参数值设置值的格式。此函数只限使用一个值参数。

语法

Format(Format:String,ParamType:String, ValueToFormat:String):String

Format 是要应用的格式。

ParamType 是要用于比较值的数据类型。有效值:string、integer、float 和 date。默认值为 integer。

ValueToFormat 是对其执行函数的值。

示例

Format('%8.2f',Float,123.456)

返回值为 123.46。

FormattedDate

说明

返回使用指定格式字符串格式化的日期属性的值。

语法

FormattedDate(PropertyName:String,FormatString:String): String

PropertyName 是要使用的属性的名称。

FormatString 指定要应用的日期格式。

GreaterThan

说明

比较两个值,如果第一个值大于第二个值,则返回 True。

语法

GreaterThan(Value1:Integer,Value2:Integer,ParamType:String):Boolean

Value1 是要比较的第一个值。

Value2 是要比较的第二个值。

ParamType 是要用于比较值的数据类型。有效值:string、integer、float 和 date。默认值为 integer。

示例

GreaterThan(1,2)

返回值 False。

GreaterThanOrEqual

说明

比较两个值,如果第一个值大于或等于第二个值,则返回 True。

语法

GreaterThanOrEqual(Value1:Integer,Value2:Integer,ParamType:String):Boolean

Value1 是要比较的第一个值。

Value2 是要比较的第二个值。

ParamType 是要用于比较值的数据类型。有效值:string、integer、float 和 date。默认值为 integer。

示例

GreaterThanOrEqual(2,2)

返回值为 True。

HasCharacters

说明

如果指定的输入包含字符类中的字符、特殊字符或 CharList 中列出的字符,则返回 True。

语法

HasCharacters(Input:String,CharList:String):Boolean

Input 是要测试的字符串值。

CharList 是要测试的字符列表,包括可选的特殊值。特殊字符值括在括号中并使用逗号分隔。有效值:[alpha]、[numeric]、[whitespace]、[punctuation]、[uppercase]、[lowercase]、[comma]、[space]、[tab]、[crlf]、[cr]、[lf]、[openparen] 和 [closeparen]。

HasChildWith

说明

如果指定的表达式对于当前节点的所有子代都为 True,则返回 True。

语法

HasChildWith(Expression:Boolean):Boolean 

示例

HasChildWith(GreaterThan(ID(),200))

如果当前节点的任何子代的 ID 大于 200,则返回值为 True。

HasParentNode

说明

如果当前本地节点具有父节点,则返回 True。

此函数的适用范围为本地,如果在全局上下文中使用,则无法正常运行。

语法

HasParentNode():Boolean

示例

HasParentNode()

如果节点是层次顶级节点或任何后代节点的子代,则返回值为 True。

HasSiblingWith

说明

如果指定的表达式对于当前节点的所有同级都为 True,则返回 True。

此函数的适用范围为本地,如果在全局上下文中使用,则无法正常运行。

语法

HasSiblingWith(Expression:Boolean):Boolean 

示例

HasSiblingWith(PropValue(Leaf))

如果有任何子代为叶节点,则返回值为 True。

HierNodePropValue

说明

返回指定节点的指定属性在指定层次中的值。

语法

HierNodePropValue(HierAbbrev:String,NodeAbbrev:String,PropAbbrev:String):String

HierAbbrev 是要使用的层次的名称。

NodeAbbrev 是要使用的节点的名称。

PropAbbrev 是要使用的属性的名称。

示例

HierNodePropValue(Assets,1000,Description)

如果 Assets 层次中节点 1000 的说明为 "Banking",则返回值为 Banking。

ID

说明

返回当前节点的 ID。

语法

ID():Integer

示例

ID()

如果当前节点 ID 为 2000,则返回值为 2000。

If

说明

如果指定的表达式计算结果为 True,则返回 TrueResult 参数的值。否则将返回 FalseResult 参数的值。

语法

If(Expression:Boolean, TrueResult:String,FalseResult:String):String

Expression 是要计算的布尔表达式。

TrueResult 是在条件为 True 时返回的字符串值。

FalseResult 是在条件为 False 时返回的字符串值。

示例

If(Equals(String,Descr(),),Abbrev(),Concat(Abbrev,-,Descr()))

如果节点名称为 Colas 并且当前节点说明为空,则返回值为 Colas。

如果节点名称为 100 并且当前节点说明为 Colas,则返回值为 100–Colas。

InheritedPropOrigin

说明

返回继承属性值的来源节点的名称。如果指定的属性为全局属性,那么也会返回原始层次。如果指定的属性不是继承属性,或者如果找不到节点或属性,则返回 False。

如果在参数中传递了本地属性,则此函数的适用范围可以为本地。

语法

InheritedPropOrigin(PropAbbrev:String,Node:String):String

示例

InheritedPropOrigin(Custom.AccountType,Abbrev())

PropAbbrev 是要使用的属性的名称。

Node 是要使用的节点的名称。

InRange

说明

如果指定的值在指定的值范围内,则返回 True。如果输入参数为字符串,那么 Min 和 Max 参数指定要检查的字符串长度范围。对于其他类型,Min 和 Max 指定要检查的数字或日期值范围。

注:

如果 MinExclusive/MaxExclusive 为 True,那么等于 Min/Max 的值包括在范围内,否则排除在外。

语法

InRange(DataType:String,Input:String,Min:String,Max:String,MinExclusive:String,MaxExclusive:String):Boolean

DataType 是要使用的数据类型。有效值:string、integer、float 和 datetime。

Input 是要测试的字符串值。

Min 是长度或范围检查的最小值。

Max 是长度或范围检查的最大值。

MinExclusive 指定是否从要检查的范围中排除 Min 值。

MaxExclusive 指定是否从要检查的范围中排除 Max 值。

示例

InRange(Integer,5,1,10,False,False)

返回值为 True。

InternalPrefix

说明

返回当前节点名称的非数字前缀。

语法

InternalPrefix()

Intersection

说明

返回两个指定值列表共有项的集合。结果的顺序取决于项目在指定的第一个列表中的显示顺序。

语法

Intersection(List1:String,List2:String,Delimiter:String):String

List1 指定要在其中进行搜索的字符串列表。

List2 指定要在其中进行搜索的字符串列表。

Delimiter 是用于分隔字符串列表中项的字符。支持的特殊字符:

  • [逗号]

  • [空格]

  • [制表符]

注:

必须使用分隔符的名称(而不是字符)并将名称括在括号中。

示例

Intersection(A;B;C;D;E,C;E;F;A,[comma])

返回值为 A,C,E。

IntToStr

说明

返回转换为字符串数据类型的指定整数值。如果输入值不表示整数,则返回零 (0)。

语法

IntToStr(Int1:Integer):String

示例

IntToStr(12345)

返回值为 12345。

InvertedLevel

说明

返回当前节点下后代的最大深度。

语法

InvertedLevel()

IsAlpha

说明

如果指定的字符串只包含字母字符(不区分大小写),则返回 True。

语法

IsAlpha(String:String):Boolean

示例

IsAlpha(A23D)

返回值 False。

IsAlphaNumeric

说明

如果指定的字符串只包含字母或数字字符(不区分大小写),则返回 True。

语法

IsAlphaNumeric(String:String,AllowBlanks:Boolean):Boolean

String 是要测试的字符串值。

AllowBlanks 指定是否应该将空白字符串视为数字。默认值为 False。

示例

IsAlphaNumeric(ABC123,True)

返回 True。

IsBlank

说明

如果指定的输入值为空字符串(零长度),则返回 True。

语法

IsBlank(Input:String):Boolean

示例

IsBlank(Descr())

如果节点说明为空,则返回 True。

IsBottomNode

说明

如果指定的节点没有子节点,则返回 True。如果找不到节点,则返回 False。

语法

IsBottomNode(Node:String):Boolean

Node 是要使用的节点的名称。

示例

IsBottomNode(Abbrev)

如果节点没有子代,则返回 True。

IsDataType

说明

如果输入值与指定的数据类型匹配,则返回 True。

语法

IsDataType(DataType:String,Input:String):Boolean

DataType 是要使用的数据类型。有效值:boolean、string、integer、float 和 datetime。

Input 是要测试的字符串值。

示例

IsDataType(123,Integer)

返回 True。

IsDefinedPropVal

说明

如果指定节点的指定属性具有定义(覆盖)的值,则返回 True。如果找不到节点或属性,则返回 False。

如果在参数中传递了本地属性,则此函数的适用范围可以为本地。

语法

IsDefinedPropVal(PropAbbrev:String,Node:String):Boolean

PropAbbrev 是要使用的属性的名称。

Node 是要使用的节点的名称。

示例

IsDefinedPropVal(Custom.AccountType,Abbrev())

如果“帐户类型”属性具有定义(覆盖)的值,则返回 True。

IsNodeAbove

说明

如果第一个节点在当前层次中是第二个节点的祖先,则返回 True。如果找不到 Node1 或 Node2,则返回 False。

此函数的适用范围为本地,如果在全局上下文中使用,则无法正常运行。

语法

IsNodeAbove(Node1:String,Node2:String):Boolean

Node1 是要使用的第一个节点的名称。

Node2 是要使用的第二个节点的名称。

示例

IsNodeAbove(Parent,Child)

如果节点父代是子节点的祖先,则返回 True。

IsNodeBelow

说明

如果第一个节点在当前层次中是第二个节点的后代,则返回 True。如果找不到 Node1 或 Node2,则返回 False。

语法

IsNodeBelow(Node1:String,Node2:String):Boolean

Node1 是要使用的第一个节点的名称。

Node2 是要使用的第二个节点的名称。

示例

IsNodeBelow(Child,Parent)

如果节点子代是父节点的后代,则返回 True。

IsNumeric

说明

如果指定的值只包含数字字符 (0-9),则返回 True。

语法

IsNumeric(String: String,AllowBlanksAsNumeric:Boolean):Boolean

String 是要测试的字符串值。

AllowBlanksAsNumeric 指定是否允许将空值视为字符串。默认值为 False。

示例

IsNumeric(12345)

返回值为 True。

IsRangeListSubset

说明

如果指定的值是指定范围列表的子集,则返回 True。

语法

IsRangeListSubset(RangeList:Range List,SubsetRangeList:Range List,Delimiter:String):Boolean

RangeList 是要搜索的整数范围列表,使用指定的分隔符分隔。

SubsetRangeList 是要搜索的整数范围列表的子集,使用指定的分隔符分隔。

Delimiter 是用于分隔字符串列表中项的字符。支持的特殊字符:

  • [逗号]

  • [空格]

  • [制表符]

注:

必须使用分隔符的名称(而不是字符)并将名称括在括号中。

Length

说明

返回指定字符串值中的字符数。

语法

Length(String:String):Integer

示例

Length(Desc())

如果当前节点的说明为 Colas,则返回值为 5。

LessThan

说明

比较两个值,如果第一个值小于第二个值,则返回 True。

语法

LessThan(Value1:Integer,Value2:Integer,ParamType:String):Boolean

Value1 是要比较的第一个值。

Value2 是要比较的第二个值。

ParamType 是要用于比较值的数据类型。有效值:string、integer、float 和 date。默认值为 integer。

示例

LessThan(1,2)

返回值为 True。

LessThanOrEqual

说明

比较两个值,如果第一个值小于或等于第二个值,则返回 True。

语法

LessThanOrEqual(Value1:Integer,Value2:Integer,ParamType:String):Boolean

Value1 是要比较的第一个值。

Value2 是要比较的第二个值。

ParamType 是要用于比较值的数据类型。有效值:string、integer、float 和 date。默认值为 integer。

示例

LessThanOrEqual(3,3)

返回值为 True。

ListAncestors

说明

返回起始于顶级节点的当前节点祖先名称的列表,以逗号分隔。如果当前节点不是本地节点,则返回空白字符串。

此函数的适用范围为本地,如果在全局上下文中使用,则无法正常运行。

语法

ListAncestors(SortOrder:String):String

SortOrder 指定节点返回列表的排序顺序。支持的排序顺序值:

  • [hier] - 本地上下文的默认值。节点列表按照当前层次的标准层次排序顺序返回。

  • [alpha] - 返回按照节点名称排序的节点列表。

  • [nodeid] - 仅限用于向后兼容。节点列表按照返回列表中每个节点的节点 ID 的数字排序返回。

注:

必须使用括号将 SortOrder 参数括起来。

示例

ListAncestors([alpha])

如果 A、B、C 和 D 是 Z 的子代,而 Z 是 Y 的子代,并且当前节点是 D,则返回值为 Z,Y。

ListChildren

说明

返回当前节点的子代列表,以逗号分隔。

语法

ListChildren(SortOrder:String):String

SortOrder 指定节点返回列表的排序顺序。支持的排序顺序值:

  • [hier] - 本地上下文的默认值。节点列表按照当前层次的标准层次排序顺序返回。

  • [alpha] - 返回按照节点名称排序的节点列表。

  • [nodeid] - 仅限用于向后兼容。节点列表按照返回列表中每个节点的节点 ID 的数字排序返回。

注:

必须使用括号将 SortOrder 参数括起来。

示例

ListChildren([alpha])

如果 A、B、C 和 D 是 Z 的子代并且当前的节点为 Z,那么返回值为 A、B、C、D。

ListContains

说明

如果指定的列表包含指定的值,则返回 True。

语法

ListContains(List:String,Item:String,Delimiter: String):Boolean

List 指定要在其中进行搜索的字符串列表。

Item 指定对其执行函数的字符串值。

Delimiter 是用于分隔字符串列表中项的字符。支持的特殊字符:

  • [逗号]

  • [空格]

  • [制表符]

注:

必须使用分隔符的名称(而不是字符)并将名称括在括号中。

示例

ListContains(PropValue(NodeList),Colas,[comma])

返回值为 True。

ListDescendants

说明

返回当前节点的后代列表,以逗号分隔。

语法

ListDescendants(SortOrder:String):String 

SortOrder 指定节点返回列表的排序顺序。支持的排序顺序值:

  • [hier] - 本地上下文的默认值。节点列表按照当前层次的标准层次排序顺序返回。

  • [alpha] - 返回按照节点名称排序的节点列表。

  • [nodeid] - 仅限用于向后兼容。节点列表按照返回列表中每个节点的节点 ID 的数字排序返回。

注:

必须使用括号将 SortOrder 参数括起来。

示例

ListDescendants([hier])

如果 A、B、C 和 D 是 Z 的子代,而 Z 是 Y 的子代,并且当前节点为 Y,则返回值为 Z, A, B, C, D。

ListDistinct

说明

返回指定列表中唯一项的列表(删除了重复项)。

语法

ListDistinct(InputList:String,Delimiter:String):String

InputList 指定要使用的列表。

Delimiter 是用于分隔字符串列表中项的字符。支持的特殊字符:

  • [逗号]

  • [空格]

  • [制表符]

注:

必须使用分隔符的名称(而不是字符)并将名称括在括号中。

示例

ListDistinct(A;B:C;A;D,[comma])

返回值为 A,B,C,D。

ListNodePropValues

说明

返回指定节点列表的指定属性的属性值列表。对于找不到的任何节点,在列表中返回空白字符串。

如果在参数中传递了本地属性,则此函数的适用范围可以为本地。

语法

ListNodePropValues(NodeList:String,Delimiter:String,PropAbbrev:String):String

NodeList 是逗号分隔的节点名称列表。

Delimiter 是用于分隔字符串列表中项的字符。支持的特殊字符:

  • [逗号]

  • [空格]

  • [制表符]

注:

必须使用分隔符的名称(而不是字符)并将名称括在括号中。

PropAbbrev 是要使用的属性的名称。

示例

ListNodePropValues(100;200;300,[comma],Core.Leaf)

如果节点 100、200 和 300 为叶节点,则返回 True,True,True。

ListNodesWith

说明

返回指定节点列表中指定表达式计算结果为 True 的节点的列表。

语法

ListNodesWith(NodeList:String,Delimiter:String,Expression:String):String

NodeList 是逗号分隔的节点名称列表。

Delimiter 是用于分隔字符串列表中项的字符。支持的特殊字符:

  • [逗号]

  • [空格]

  • [制表符]

注:

必须使用分隔符的名称(而不是字符)并将名称括在括号中。

Expression 是要计算的布尔表达式。

示例

ListNodesWith(100;200;300,[comma],NodeIsLeaf())

如果节点 100、200 和 300 为叶节点,则返回 True,True,True。

ListRelatedNodesWith

说明

返回指定表达式计算结果为 True、与当前节点相关的节点的列表。

如果关系参数为 Ancestors 或 Siblings,则此函数的适用范围为本地。

语法

ListRelatedNodesWith(Relation:String,Expression:String,SortOrder:String,Max:Integer):String

Relation 可以为:

  • Ancestors - 可以在指定的表达式中引用本地属性

  • Siblings - 可以在指定的表达式中引用本地属性

  • Children - 可以在指定的表达式中引用本地和全局属性

  • Descendants - 可以在指定的表达式中引用本地和全局属性

Expression 是要计算的布尔表达式。

SortOrder 指定节点返回列表的排序顺序。支持的排序顺序值:

  • [hier] - 本地上下文的默认值。节点列表按照当前层次的标准层次排序顺序返回。

  • [alpha] - 返回按照节点名称排序的节点列表。

  • [nodeid] - 仅限用于向后兼容。节点列表按照返回列表中每个节点的节点 ID 的数字排序返回。

注:

必须使用括号将 SortOrder 参数括起来。

Max 是指示要返回的节点最大数目的整数值。零或无值表示没有限制并返回所有节点。

示例

ListRelatedNodesWith(children,True,[alpha],1000)

如果这些节点为当前节点的子节点,则返回 100,200,300。

ListSiblings

说明

返回当前节点的同级的列表(以逗号分隔)。

此函数的适用范围为本地,如果在全局上下文中使用,则无法正常运行。

语法

ListSiblings(SortOrder:String):String

SortOrder 指定节点返回列表的排序顺序。支持的排序顺序值:

  • [hier] - 本地上下文的默认值。节点列表按照当前层次的标准层次排序顺序返回。

  • [alpha] - 返回按照节点名称排序的节点列表。

  • [nodeid] - 仅限用于向后兼容。节点列表按照返回列表中每个节点的节点 ID 的数字排序返回。

示例

ListSiblings([alpha])

如果 A、B、C 和 D 是 Z 的子代并且当前的节点为 B,则返回值为 A, C, D。

LowerCase

说明

返回指定字符串值转换为小写字符后的结果。

语法

LowerCase(String:String):String

示例

LowerCase(HOBBES)

返回值为 hobbes。

LTrim

说明

返回指定值删除了字符串开头的所有空格后的结果。

语法

LTrim(String: String): String 

示例

LTrim("   101203")

返回值为 101203。

MaxList

说明

返回指定列表中的最大项目,忽略空白项目。如果列表包含不是指定类型的项目,则返回空白字符串。

语法

MaxList(InputList: String,Delimiter: String,ItemType: String)

InputList 指定要使用的列表。

Delimiter 是用于分隔字符串列表中项的字符。支持的特殊字符:

  • [逗号]

  • [空格]

  • [制表符]

注:

必须使用分隔符的名称(而不是字符)并将名称括在括号中。

ItemType 指示列表成员所需的项目数据类型。有效值:integer、float 和 datetime。默认值为 float。

示例

MaxList(1;2;3,[comma],Integer)

返回值为 3。

MinList

说明

返回指定列表中的最小项目,忽略空白项目。如果列表包含不是指定类型的项目,则返回空白字符串。

语法

MinList(InputList:String,Delimiter:String,ItemType:String)

InputList 指定要使用的列表。

Delimiter 是用于分隔字符串列表中项的字符。支持的特殊字符:

  • [逗号]

  • [空格]

  • [制表符]

注:

必须使用分隔符的名称(而不是字符)并将名称括在括号中。

ItemType 指示列表成员所需的项目数据类型。有效值:integer、float 和 datetime。默认值为 float。

示例

MinList(1;2;3,[comma],Integer)

返回值为 1。

Modulus

说明

返回两个指定整数相除所得到的模数(余数)。

语法

Modulus(Dividend: Integer, Divisor: Integer): Integer 

Dividend 是被除的分数的分子。

Divisor 是被除的分数的分母。

示例

Modulus(5,2)

返回值为 1。

Multiply

说明

将两个指定的整数相乘并返回结果。

语法

Multiply(Int1: Integer, Int2: Integer): Integer 

示例

Multiply(2,5)

返回值为 10。

MultiplyFloat

说明

将两个指定的浮点数(浮点)相乘并返回结果。

语法

Multiply(Float1: Float, Float2: Float): Float

示例

MultiplyFloat(4.76,2.3)

返回值为 10.948。

NextSibling

说明

根据用于当前层次的排序顺序,返回当前节点的下一同级。

此函数的适用范围为本地,如果在全局上下文中使用,则无法正常运行。

语法

NextSibling(): String

示例

NextSibling()

如果 A、B、C 和 D 是 Z 的子代并且当前的节点为 B,那么返回值为 C。

NodeAccessGroups

说明

返回当前用户对于当前节点的节点访问组的列表,以逗号分隔。

此函数的适用范围为本地,如果在全局上下文中使用,则无法正常运行。

语法

NodeAccessGroups(): String 

示例

NodeAccessGroups()

返回值为 Accounts, Finance。

NodeExists

说明

如果指定的节点存在,则返回 True。

语法

NodeExists(NodeAbbrev: string): Boolean 

NodeAbbrev 是要使用的节点的名称。

示例

NodeExists(2000)

如果节点 2000 存在,则返回值为 True。

NodeInHier

说明

如果在指定的层次中存在指定的节点,则返回 True。

语法

NodeInHier(NodeAbbrev, HierAbbrev: string): Boolean 

NodeAbbrev 是要使用的节点的名称。

HierAbbrev 是要使用的层次的名称。

示例

NodeInHier(2000,Assets)

如果节点 2000 位于 Assets 层次中,则返回值为 True。

NodeIsLeaf

说明

如果当前节点是叶节点,则返回 True。

语法

NodeIsLeaf(): Boolean 

示例

NodeIsLeaf()

如果当前节点是叶节点,则返回值为 True。

NodeIsValidForPropertyHiers

说明

如果指定的节点满足指定属性的层次限制,则返回 True。如果属性未存储节点值或如果未针对属性定义限制,同样返回 True。

如果在参数中传递了本地属性,则此函数的适用范围可以为本地。

语法

NodeIsValidForPropertyHiers(NodeAbbrev: String, PropAbbrev: String): Boolean

NodeAbbrev 是要使用的节点的名称。

PropAbbrev 是要使用的属性的名称。

NodePropValue

说明

返回指定节点的指定属性在当前层次中的值(适用于本地节点),或在当前版本中的值(适用于全局节点)。

如果在参数中传递了本地属性,则此函数的适用范围可以为本地。

语法

NodePropValue(NodeAbbrev: String, PropAbbrev: String): String 

NodeAbbrev 是要使用的节点的名称。

PropAbbrev 是要使用的属性的名称。

示例

NodePropValue(2000,Abbrev())

返回值为 2000。

Not

说明

返回指定布尔表达式的布尔值的相反值。

语法

Not(Expression: Boolean): Boolean 

示例

Not(NodeIsLeaf())

如果节点是枝节点,则返回值为 True。

Now

说明

返回当前系统日期和/或时间。

语法

Now([DateTimeType: String]): DateTime

DataTimeType 是可选的,指定要返回哪个日期部分。有效值:Date、Time、Datetime。默认值为 Date。

示例

Now()

返回当前日期和时间;例如 3/25/2010 9:20:44 AM。

Now(Time)

仅返回当前时间;例如 9:20:44 AM。

Now(Date)

仅返回当前日期;例如 3/25/2010。

NumChildWith

说明

返回当前节点中指定表达式计算结果为 True 的子代的数量。

语法

NumChildWith(Expression: Boolean): Integer 

示例

NumChildWith(NodeIsLeaf())

如果节点有两个叶子代,则返回值为 2。

NumDescendantsWith

说明

返回当前节点中指定表达式计算结果为 True 的后代的数量。

语法

NumDescendantsWith(Expression: Boolean): Integer 

示例

NumDescendantsWith(NodeIsLeaf())

如果节点具有两个子代并且每个子代具有 10 个叶子代,则返回值为 20。

Or

说明

如果指定的布尔表达式中有任何一个计算结果为 True,则返回 True。

语法

Or(Expression1, Expression2,... ExpressionN: Boolean): Boolean

示例

Or(NodeIsLeaf(),Equals(Integer,PropValue(Level),3))

如果当前节点是叶节点,或者位于层次中的第 3 级,则返回值为 True。

OrigPropValue

说明

使用 HasSiblingWith 或 NumDescendantsWith 函数时,返回发起节点的指定属性的值。

如果在参数中传递了本地属性,则此函数的适用范围可以为本地。

语法

OrigPropValue(PropAbbrev: String): String 

PropAbbrev 是要使用的属性的名称。

示例

HasSiblingWith(GreaterThan(OrigPropValue(ID),ID())

如果当前节点的 ID 为 200 并且它具有任何节点 ID 大于 200 的同级,则返回值为 True。

PadChar

说明

返回使用指定填充字符加长的指定字符串。可以在原始字符串的左侧或右侧填充。生成的字符串长度至少等于指定的位数。如果原始字符串长于指定的位数,则返回原始列表。

语法

PadChar(String: String, PadChar: String; PadLeft: Boolean; NewLength: Integer): String 

String 是对其执行函数的字符串值。

PadChar 是要用于填充字符串的字符。

PadLeft 指定是否从左侧填充字符串。有效值:1、0、T、F、t 或 f。

NewLength 是指定结果长度的整数。

示例

PadChar(102,0,1,6)

返回值为 000102。

PadList

说明

返回使用指定填充字符加长的指定列表。可以在原始列表的左侧或右侧填充。生成的列表长度至少等于指定的位数。如果原始列表长于指定的位数,则返回原始列表。

语法

PadList(String, DelimChar, PadChr:String, PadLeft: Boolean, NewLength:Integer): String 

StringList 是要应用填充的字符串列表,使用指定的分隔符分隔。

Delimiter 是用于分隔字符串列表中项的字符。支持的特殊字符:

  • [逗号]

  • [空格]

  • [制表符]

注:

必须使用分隔符的名称(而不是字符)并将名称括在方括号中。

PadChar 是要用于填充字符串的字符。

PadLeft 指定是否从左侧填充字符串。有效值:1、0、T、F、t 或 f。

NewLength 是指定结果长度的整数。

示例

PadList(1;2;3;4,;,T,3)

返回值为 001;002;003,004。

ParentPropValue

说明

返回当前节点父节点的指定属性的值。如果节点没有父代,或者如果当前节点不是本地节点,则返回空白字符串。

此函数的适用范围为本地,如果在全局上下文中使用,则无法正常运行。

语法

ParentPropValue(PropAbbrev: String): String 

PropAbbrev 是要使用的属性的名称。

示例

ParentPropValue(Abbrev)

如果父节点名称为 Colas,则返回值为 Colas。

Pos

说明

使用区分大小写的搜索返回指定子字符串的第一个字符在指定字符串中的位置 (索引)。如果在字符串值内找不到该子字符串,则返回零值。

语法

Pos(SubString: String, String: String): Integer 

Substring 是一个要搜索的字符串值。

String 是对其执行函数的字符串值。

示例

Pos(D,ABCDEFG)

返回值为 4。

PreviousSibling

说明

根据用于当前层次的排序顺序,返回当前节点的上一同级。

此函数的适用范围为本地,如果在全局上下文中使用,则无法正常运行。

语法

PreviousSibling(): String

示例

PreviousSibling()

如果 A、B、C 和 D 是 Z 的子代并且当前的节点为 B,那么返回值为 A。

PropControllingHier

说明

返回指定属性在当前版本中的控制层次名称。

语法

PropControllingHier(PropAbbrev: String): String 

PropAbbrev 是要使用的属性的名称。

示例

PropControllingHier(TimeBalance)

返回值为 Accounts。

PropDefaultValue

说明

返回指定属性定义的默认值。

语法

PropDefaultValue(PropAbbrev: String): String 

PropAbbrev 是要使用的属性的名称。

示例

PropDefaultValue(Currency)

返回值为 USD。

PropertyCategories

说明

返回当前用户的属性类别列表,以逗号分隔。

语法

PropertyCategories(AccessType: String) :String

AccessType 是属性类别的访问级别。有效值:ReadOnly、ReadWrite 或两者。

示例

PropertyCategories(Both)

返回值为 System, All, Essbase, Enterprise, HFM, Planning。

PropMaxValue

说明

返回指定属性定义的最大值。

语法

PropMaxValue(PropAbbrev: String): Integer 

PropAbbrev 是要使用的属性的名称。

示例

PropMaxValue(Volume)

返回值为 10。

PropMinValue

说明

返回指定属性定义的最小值。

语法

PropMinValue(PropAbbrev: String): Integer

PropAbbrev 是要使用的属性的名称。

示例

PropMinValue(Volume)

返回值为 1。

PropValue

说明

返回当前节点指定属性的值。

如果在参数中传递了本地属性,则此函数的适用范围可以为本地。

语法

PropValue(PropAbbrev: String): String 

PropAbbrev 是要使用的属性的名称。

示例

PropValue(Volume)

返回值为 2。

RangeListContains

说明

如果指定的范围列表包含指定的值,则返回 True。

语法

RangeListContains(RangeList: String, Value: Integer, Delimiter: String): Boolean

RangeList 是要搜索的整数范围列表,使用指定的分隔符分隔。例如 1-100,201-300

Value 是要在范围列表中搜索的整数值。

Delimiter 是用于分隔字符串列表中项的字符。支持的特殊字符:

  • [逗号]

  • [空格]

  • [制表符]

注:

必须使用分隔符的名称(而不是字符)并将名称括在括号中。

示例

RangeListContains(PropValue(MyRangeList),1,[Comma])

如果 MyRangeList 属性的值为 1-10, 101-10000,则返回值为 True,因为 1 包含在指定的范围中。但是,RangeListContains(PropValue(MyRangeList),11,[Comma]) 却返回 False,因为 11 未包含在指定范围内。

注:

如果将 MyRangeList 更改为 "1-5,6-10,101-1000",则 Data Relationship Management 会将此值替换为 "1-10,101-1000",因为它会核实 RangeList 并组合具有连续边界的范围。

ReplacementAbbrev

说明

如果当前节点处于非活动状态并且指定了合并节点,则返回当前节点的替换(合并)节点名称。

语法

ReplacementAbbrev(): String 

示例

ReplacementAbbrev()

ReplacePropValue

说明

如果当前节点处于非活动状态并且指定了合并节点,则返回当前节点的替换(合并)节点的指定属性值。

如果在参数中传递了本地属性,则此函数的适用范围可以为本地。

语法

ReplacePropValue(PropAbbrev: String): String 

PropAbbrev 是要使用的属性的名称。

示例

ReplacePropValue(Description)

ReplaceStr

说明

返回使用新模式替换了旧模式的实例的字符串。

语法

ReplaceStr(String: String,OldPattern: String,NewPattern: String,ReplaceAll: Boolean): String

String 是对其执行函数的字符串值。

NewPattern 是要替代所找到的字符串的字符串值。

OldPattern 是要搜索的字符串值。

ReplaceAll 指定是否使用替代字符串替代搜索字符串的所有匹配项。有效值:1、0、T、F、t 或 f。

示例

ReplaceStr(A1;A2;A3,A,B,T)

返回值为 B1;B2;B3。

RTrim

说明

返回指定值删除了字符串末尾的所有空格后的结果。

语法

RTrim(String: String): String 

String 是对其执行函数的字符串值。

示例

RTrim("100   "))

返回值为 100。

SortList

说明

按照排序顺序返回指定的列表。

语法

SortList(InputList: String,Delimiter: String,IgnoreCase: Boolean,ItemType: String)

InputList 指定要使用的列表。

Delimiter 是用于分隔字符串列表中项的字符。支持的特殊字符:

  • [逗号]

  • [空格]

  • [制表符]

注:

必须使用分隔符的名称(而不是字符)并将名称括在方括号中。

IgnoreCase 指定排序时是否忽略大小写。默认值为 False。

ItemType 指示结果列表项的目标数据类型。有效值:string、integer、float date、time 和 datetime。默认值为 string。如果有任何项目无法转换为指定的类型,则函数返回空白字符串。

StripPadChar

说明

从指定字符串的开头删除指定的填充字符,并返回修改后的值。如果原始字符串包含的填充字符少于为 StripCount 指定的值,则返回原始字符串值。

语法

StripPadChar(String: String, PadChar: String, StripCount: Integer): String

String 是对其执行函数的字符串值。

PadChar 是要用于填充字符串的字符。

StripCount 是指定要从字符串中删除的字符数的整数。零将删除所有填充字符。

示例

StripPadChar(0003333,0,6)

返回值为 3333。

StrToBool

说明

返回基于指定字符串的布尔值。如果字符串以 Y、T 或 1(一)开头,则不管大小写或者后续的字符是什么,都返回 True 值。如果字符串以 N、F 或 0(零)开头,则不管大小写或者后续的字符是什么,都返回 False 值。

语法

StrToBool(String: String): Boolean

String 是对其执行函数的字符串值。

示例

StrToBool(0)

返回值 False。

StrToFloat

说明

返回指定字符串的浮点值。对于空格或空白字符串,返回零 (0)。

如果指定的字符串不表示浮点数,则返回错误。

语法

StrToFloat(String: String): Float 

String 是对其执行函数的字符串值。

示例

StrToFloat(11.101)

返回值为 11.101。

StrToInt

说明

返回指定字符串的整数值。对于空格或空白字符串,返回零 (0)。

如果指定的字符串不表示整数,则返回错误。

语法

StrToInt(String: String): Integer 

String 是对其执行函数的字符串值。

示例

StrToInt(101)

返回值为 101。

Stuff

说明

返回指定值在用指定字符串替换了指定字符后的结果。

语法

Stuff(PropAbbrev: String, CharsToReplace: String, ReplacementChars: String): String 

PropAbbrev 是要使用的属性的名称。

CharsToReplace 是要搜索的字符串值。

ReplacementChars 是要替代所找到的字符串的字符串值。

示例

Stuff(Abbrev(),GEO,RIO)

如果 Abbrev 为 GEO101,则返回值为 RIO101。

SubString

说明

返回指定字符串中从指定索引开始、包含指定字符数的一部分。

语法

SubString(String: String, Index: Integer, Count: Integer): String

SubString 是对其执行函数的字符串值。

Index 是表示搜索子字符串的起始索引位置的整数。零表示字符串中的第一个字符位置。

Count 是表示从起始索引开始要搜索的字符数的数字。

示例

SubString(Colas,1,2)

返回值为 Co。

Subtract

说明

从第一个值减去第二个整数值并返回结果。

语法

Subtract(Minuend: Integer,Subtrahend: Integer): Integer 

Minuend 是一个整数值

Subtrahend 是一个整数值。

示例

Subtract(10,2)

返回值为 8。

SubtractFloat

说明

从第一个值减去第二个浮点值并返回结果。

语法

SubtractFloat(Minuend,Subtrahend: Float): Float

Minuend 是浮点值

Subtrahend 是浮点值。

示例

SubtractFloat(8.09,3.76)

返回值为 4.33。

SumList

说明

返回列表中项目的总和,忽略空白项目。如果列表包含不是指定项目类型的项目,则返回空白字符串。

语法

SumList(InputList: String,Delimiter: String,ItemType: String):Integer

InputList 指定要使用的列表。

Delimiter 是用于分隔字符串列表中项的字符。支持的特殊字符:

  • [逗号]

  • [空格]

  • [制表符]

注:

必须使用分隔符的名称(而不是字符)并将名称括在括号中。

ItemType 指示列表成员所需的项目数据类型。有效值:integer 和 float。默认值为 float。

示例

SumList(1;2;3,;,Integer)

返回值为 6。

Trim

说明

返回指定值删除了字符串开头和末尾的所有空格后的结果。

语法

Trim(String: String): String 

String 是对其执行函数的字符串值。

示例

Trim("   101   ")

返回值为 101。

UpperCase

说明

返回转换为大写形式的字符串值。

语法

UpperCase(String: String): String 

String 是对其执行函数的字符串值。

示例

UpperCase(smaller)

返回值为 SMALLER。

UserName

说明

返回当前用户的用户名。

语法

UserName(): String 

示例

UserName()

返回值是用户名。

XOr

说明

当且仅当指定布尔表达式之一的计算结果为 True 时,才会返回 True。

语法

XOr(Expression1:Boolean, Expression2: Boolean): Boolean 

示例

XOr(NodeIsLeaf(),Equals(Integer,PropValue(Level),3))

如果节点是叶节点,或者位于层次中的第 3 级,则返回值为 True。