関数の定義

派生式プロパティの定義で使用できる関数のリストを、アルファベット順に示します。

Abbrev

説明

現在のノードの名前(略称)を戻します。

構文

Abbrev(): String 

例

Abbrev()

戻り値はノードの名前です。

Add

説明

指定された2つの整数値を加算し、結果を戻します。

構文

Add(Int1,Int2:Integer):Integer

例

Add(1,4)

戻り値は5です。

AddedBy

説明

「追加者」の変更追跡プロパティの値を戻します。

構文

AddedBy():String

例

AddedBy()

現在のノードをバージョンに追加したユーザーの名前を戻します。

AddedOn

説明

「追加日」の変更追跡プロパティの値を日付/時刻として戻します。

構文

AddedOn():Date/Time

例

AddedOn()

現在のノードがバージョンに追加された日時を戻します。

AddFloat

説明

指定された2つの浮動小数点値を加算し、結果を戻します。

構文

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は、文字列リストのアイテムを区切るために使用される文字です。サポートされる特殊文字:

• [comma]

• [space]

• [tab]

例

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

戻り値は3です。

ArrayIndex

説明

リスト(配列)内で、指定されたアイテムが出現する最初の位置を戻します。アイテムが見つからない場合はゼロ(0)を戻します。

構文

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

Itemは、テストする文字列値を指定します。

Listは、その内容を検索する文字列のリストを指定します。

Delimiterは、文字列リストのアイテムを区切るために使用される文字です。サポートされる特殊文字:

• [comma]

• [space]

• [tab]

例

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

戻り値は3です。

ArrayItem

説明

リスト(配列)内の指定されたインデックス位置にあるアイテムを戻します。

構文

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

Listは、その内容を検索する文字列のリストを指定します。

Delimiterは、文字列リストのアイテムを区切るために使用される文字です。サポートされる特殊文字:

• [comma]

• [space]

• [tab]

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は、文字列リストのアイテムを区切るために使用される文字です。サポートされる特殊文字:

• [comma]

• [space]

• [tab]

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

説明

指定された2つ以上の文字列を1つに連結し、結果を戻します。

構文

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

例

Concat(Abbrev,-,Descr())

現在のノード名が100で、現在のノードの説明がColasの場合、戻り値は100-Colasです。

ConcatWithDelimiter

説明

2つ以上の文字列を1つの区切りリストに連結し、結果を戻します。

構文

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

Delimiterは、文字列リストのアイテムを区切るために使用される文字です。サポートされる特殊文字:

• [comma]

• [space]

• [tab]

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]のすべてのインスタンスを適切な文字に置き換えて、入力文字列を戻します。

構文

Decode(CodedString:String):String

CodedStringは、関数を実行する対象の文字列値です。

DefaultProp

説明

プロパティのデフォルト値を戻します。

構文

DefaultProp(Property:String)

Propertyは、使用するプロパティの名前です。

Descr

説明

現在のノードの説明を戻します。

構文

Descr():String

例

現在のノードの説明がColasの場合、戻り値はColasです。

Divide

説明

指定された2つの整数値を除算し、結果を戻します。

構文

Divide(Int1,Int2:Integer):Integer

例

Divide(200,10)

戻り値は20です。

DivideFloat

説明

2つの浮動小数点数(小数)を除算し、結果を戻します。

構文

Divide(Float1,Float2:Float):Float

例

DivideFloat(2.535,1.5)

戻り値は1.69です。

DualAncestorProp

説明

2つのプロパティが指定された値と等しい最初の祖先のプロパティ値を戻します。

この関数のスコープはローカルとなり、グローバル・コンテキストで使用された場合は適切に機能しません。

構文

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

Operator1は、最初のプロパティと値を比較する際に使用する演算子です。有効な値: =、<、>、>=および<=。

Property1は、チェックする最初のプロパティの名前です。

Value1は、比較する最初の値です。

Operator2は、2番目のプロパティと値を比較する際に使用する演算子です。有効な値: =、<、>、>=および<=。

Property2は、チェックする2番目のプロパティの名前です。

Value2は、比較する2番目の値です。

FromTopは、階層の最上位ノードから検索するかどうかを指定します。Falseの場合、検索は現在のノードから実行されます。

ReturnPropは、戻す祖先のプロパティの名前です。

Equals

説明

指定された2つの値が等しい場合にTrueを戻します。この関数では大文字と小文字が区別されます。

構文

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

ParamTypeは、値の比較に使用するデータ型です。有効な値: string、integer、float、date。デフォルト値はintegerです。

Param1は、比較する最初の値です。

Param2は、比較する2番目の値です。

例

Equals(integer,01,1)

戻り値はTrueです。

FlipList

説明

指定されたリストの逆を表す文字列を戻します。

構文

FlipList(List,Delimiter:String):String

Listは、反転する文字列のリストを指定します。

Delimiterは、文字列リストのアイテムを区切るために使用される文字です。サポートされる特殊文字:

• [comma]

• [space]

• [tab]

例

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

説明

指定されたフォーマット文字列のパラメータ・タイプ識別子と、指定されたタイプのパラメータ値を使用して値をフォーマットします。この関数は値が1つのパラメータに限定されます。

構文

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

説明

2つの値を比較して、最初の値が2番目の値より大きい場合にTrueを戻します。

構文

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

Value1は、比較する最初の値です。

Value2は、比較する2番目の値です。

ParamTypeは、値の比較に使用するデータ型です。有効な値: string、integer、float、date。デフォルト値はintegerです。

例

GreaterThan(1,2)

戻り値はFalseです。

GreaterThanOrEqual

説明

2つの値を比較して、最初の値が2番目の値以上の場合にTrueを戻します。

構文

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

Value1は、比較する最初の値です。

Value2は、比較する2番目の値です。

ParamTypeは、値の比較に使用するデータ型です。有効な値: string、integer、float、date。デフォルト値はintegerです。

例

GreaterThanOrEqual(2,2)

戻り値はTrueです。

HasCharacters

説明

指定されたInputに、Characterクラスの文字、特殊文字、または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にはチェック対象の数値範囲または日付範囲を指定します。

構文

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は、文字列リストのアイテムを区切るために使用される文字です。サポートされる特殊文字:

• [comma]

• [space]

• [tab]

例

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())

AccountTypeプロパティに定義(上書き)されている値がある場合は、Trueを戻します。

IsNodeAbove

説明

最初のノードが現在の階層の2番目のノードの祖先である場合にTrueを戻します。Node1またはNode2が見つからない場合は、Falseを戻します。

この関数のスコープはローカルとなり、グローバル・コンテキストで使用された場合は適切に機能しません。

構文

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

Node1は、使用する最初のノードの名前です。

Node2は、使用する2番目のノードの名前です。

例

IsNodeAbove(Parent,Child)

ノードParentがChildノードの祖先の場合は、Trueを戻します。

IsNodeBelow

説明

最初のノードが現在の階層の2番目のノードの子孫である場合にTrueを戻します。Node1またはNode2が見つからない場合は、Falseを戻します。

構文

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

Node1は、使用する最初のノードの名前です。

Node2は、使用する2番目のノードの名前です。

例

IsNodeBelow(Child,Parent)

ノード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は、文字列リストのアイテムを区切るために使用される文字です。サポートされる特殊文字:

• [comma]

• [space]

• [tab]

Length

説明

指定された文字列値の文字数を戻します。

構文

Length(String:String):Integer

例

Length(Desc())

現在のノードの説明がColasの場合、戻り値は5です。

LessThan

説明

2つの値を比較して、最初の値が2番目の値より小さい場合にTrueを戻します。

構文

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

Value1は、比較する最初の値です。

Value2は、比較する2番目の値です。

ParamTypeは、値の比較に使用するデータ型です。有効な値: string、integer、float、date。デフォルト値はintegerです。

例

LessThan(1,2)

戻り値はTrueです。

LessThanOrEqual

説明

2つの値を比較して、最初の値が2番目の値以下の場合にTrueを戻します。

構文

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

Value1は、比較する最初の値です。

Value2は、比較する2番目の値です。

ParamTypeは、値の比較に使用するデータ型です。有効な値: string、integer、float、date。デフォルト値はintegerです。

例

LessThanOrEqual(3,3)

戻り値はTrueです。

ListAncestors

説明

最上位ノードから始まる、現在のノードの祖先の名前のカンマ区切りリストを戻します。現在のノードがローカル・ノードでない場合は、空白の文字列を戻します。

この関数のスコープはローカルとなり、グローバル・コンテキストで使用された場合は適切に機能しません。

構文

ListAncestors(SortOrder:String):String

「ソート順」では、ノードの戻りリストのソート順を指定します。サポートされるソート順序値:

• [hier]––ローカル・コンテキストのデフォルト値。現在の階層について標準の階層ソート順序でノードのリストが戻されます。

• [alpha]––ノード名でソートして、ノードのリストが戻されます。

• [nodeid]––従来との互換性のために限定的に使用されます。戻りリストの各ノードのIDを基準に数字でソートして、ノードのリストが戻されます。

例

ListAncestors([alpha])

A、B、C、DがZの子、ZがYの子、現在のノードがDである場合、戻り値はZ、Yです。

ListChildren

説明

現在のノードの子のカンマ区切りリストを戻します。

構文

ListChildren(SortOrder:String):String

「ソート順」では、ノードの戻りリストのソート順を指定します。サポートされるソート順序値:

• [hier]––ローカル・コンテキストのデフォルト値。現在の階層について標準の階層ソート順序でノードのリストが戻されます。

• [alpha]––ノード名でソートして、ノードのリストが戻されます。

• [nodeid]––従来との互換性のために限定的に使用されます。戻りリストの各ノードのIDを基準に数字でソートして、ノードのリストが戻されます。

例

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は、文字列リストのアイテムを区切るために使用される文字です。サポートされる特殊文字:

• [comma]

• [space]

• [tab]

例

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

戻り値はTrueです。

ListDescendants

説明

現在のノードの子孫のカンマ区切りリストを戻します。

構文

ListDescendants(SortOrder:String):String 

「ソート順」では、ノードの戻りリストのソート順を指定します。サポートされるソート順序値:

• [hier]––ローカル・コンテキストのデフォルト値。現在の階層について標準の階層ソート順序でノードのリストが戻されます。

• [alpha]––ノード名でソートして、ノードのリストが戻されます。

• [nodeid]––従来との互換性のために限定的に使用されます。戻りリストの各ノードのIDを基準に数字でソートして、ノードのリストが戻されます。

例

ListDescendants([hier])

A、B、C、DがZの子、ZがYの子、現在のノードがYである場合、戻り値はZ、A、B、C、Dです。

ListDistinct

説明

指定されたリストから重複を除去して、アイテムの個別リストを戻します。

構文

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

InputListは、使用するリストを指定します。

Delimiterは、文字列リストのアイテムを区切るために使用される文字です。サポートされる特殊文字:

• [comma]

• [space]

• [tab]

例

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

戻り値はA、B、C、Dです。

ListNodePropValues

説明

指定されたノード・リストに対して指定されたプロパティのプロパティ値のリストを戻します。見つからないノードについては、リスト内で空白の文字列を戻します。

パラメータでローカル・プロパティが渡された場合に、この関数のスコープをローカルにできます。

構文

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

NodeListは、ノード名のカンマ区切りリストです。

Delimiterは、文字列リストのアイテムを区切るために使用される文字です。サポートされる特殊文字:

• [comma]

• [space]

• [tab]

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は、文字列リストのアイテムを区切るために使用される文字です。サポートされる特殊文字:

• [comma]

• [space]

• [tab]

Expressionは、評価するブール式です。

例

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

ノード100、200、300がリーフ・ノードの場合には、True、True、Trueを戻します。

ListRelatedNodesWith

説明

現在のノードとの関係を持ち、指定された式がTrueと評価されるノードのリストを戻します。

関係パラメータが祖先または兄弟の場合、この関数のスコープはローカルになります。

構文

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

「関係」は次のとおりです:

• 祖先--指定した式でローカル・プロパティを参照できます

• 兄弟--指定した式でローカル・プロパティを参照できます

• 子--指定した式でローカル・プロパティとグローバル・プロパティを参照できます

• 子孫--指定した式でローカル・プロパティとグローバル・プロパティを参照できます

Expressionは、評価するブール式です。

「ソート順」では、ノードの戻りリストのソート順を指定します。サポートされるソート順序値:

• [hier]––ローカル・コンテキストのデフォルト値。現在の階層について標準の階層ソート順序でノードのリストが戻されます。

• [alpha]––ノード名でソートして、ノードのリストが戻されます。

• [nodeid]––従来との互換性のために限定的に使用されます。戻りリストの各ノードのIDを基準に数字でソートして、ノードのリストが戻されます。

Maxは、戻すノードの最大数を示す整数値です。ゼロを指定するか値を指定しない場合、制限がなく、すべてのノードが戻されます。

例

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

ノードが現在のノードの子である場合、100、200、300を戻します。

ListSiblings

説明

現在のノードの兄弟(ピア)のカンマ区切りリストを戻します。

この関数のスコープはローカルとなり、グローバル・コンテキストで使用された場合は適切に機能しません。

構文

ListSiblings(SortOrder:String):String

「ソート順」では、ノードの戻りリストのソート順を指定します。サポートされているソート順の値:

• [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は、文字列リストのアイテムを区切るために使用される文字です。サポートされる特殊文字:

• [comma]

• [space]

• [tab]

ItemTypeは、リスト・メンバーに予期するアイテム・データ型を示します。有効な値: integer、floatおよびdatetime。デフォルト値はfloatです。

例

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

戻り値は3です。

MinList

説明

空白アイテムは無視して、指定されたリストから最小アイテムを戻します。指定されたタイプではないアイテムがリストに含まれている場合は、空白の文字列を戻します。

構文

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

InputListは、使用するリストを指定します。

Delimiterは、文字列リストのアイテムを区切るために使用される文字です。サポートされる特殊文字:

• [comma]

• [space]

• [tab]

ItemTypeは、リスト・メンバーに予期するアイテム・データ型を示します。有効な値: integer、floatおよびdatetime。デフォルト値はfloatです。

例

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

戻り値は1です。

Modulus

説明

指定された2つの整数の除算の法(余り)を戻します。

構文

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

Dividendは、除算中の分数の分子です。

Divisorは、除算中の分数の分母です。

例

Modulus(5,2)

戻り値は1です。

Multiply

説明

指定された2つの整数を乗算し、結果を戻します。

構文

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

例

Multiply(2,5)

戻り値は10です。

MultiplyFloat

説明

指定された2つの浮動小数点数(小数)を乗算し、結果を戻します。

構文

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)

Assets階層にノード2000が存在する場合、戻り値は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つのリーフの子がある場合、戻り値は2です。

NumDescendantsWith

説明

現在のノードで、指定された式がTrueと評価される子孫の数を戻します。

構文

NumDescendantsWith(Expression: Boolean): Integer 

例

NumDescendantsWith(NodeIsLeaf())

ノードに2つの子があり、それぞれの子に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は、文字列リストのアイテムを区切るために使用される文字です。サポートされる特殊文字:

• [comma]

• [space]

• [tab]

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またはBoth。

例

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は、文字列リストのアイテムを区切るために使用される文字です。サポートされる特殊文字:

• [comma]

• [space]

• [tab]

例

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

プロパティMyRangeListの値が1-10, 101-10000の場合は、指定された範囲に1が含まれるため、戻り値はTrueです。一方、RangeListContains(PropValue(MyRangeList),11,[Comma])はFalseを戻します。11は指定された範囲に含まれないためです。

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は、文字列リストのアイテムを区切るために使用される文字です。サポートされる特殊文字:

• [comma]

• [space]

• [tab]

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

説明

最初の値から2番目の整数値を減算し、結果を戻します。

構文

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

Minuendは整数値です。

Subtrahendは整数値です。

例

Subtract(10,2)

戻り値は8です。

SubtractFloat

説明

最初の値から2番目の浮動小数点値を減算し、結果を戻します。

構文

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は、文字列リストのアイテムを区切るために使用される文字です。サポートされる特殊文字:

• [comma]

• [space]

• [tab]

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

説明

指定されたブール式の1つのみがTrueと評価される場合にTrueを戻します。

構文

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

例

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

ノードがリーフであるか、階層の第3レベルである、そのいずれかの場合、戻り値はTrueです。