Est présentée ci-après la liste alphabétique des fonctions disponibles, utilisées avec des définitions de propriété de formule dérivée.
Abbrev
Description
Renvoie le nom (Abbrev) du noeud en cours.
Syntaxe
Abbrev(): String
Exemple
Abbrev()
La valeur renvoyée est le nom du noeud.
Add
Description
Ajoute les deux valeurs entières indiquées et renvoie le résultat.
Syntaxe
Add(Int1,Int2:Integer):Integer
Exemple
Add(1,4)
La valeur renvoyée est 5.
AddedBy
Description
Renvoie la valeur de la propriété de suivi des modifications Ajouté par.
Syntaxe
AddedBy():String
Exemple
AddedBy()
Renvoie le nom de l'utilisateur qui a ajouté le noeud en cours à la version.
AddedOn
Description
Renvoie la valeur de la propriété de suivi des modifications Ajouté le sous forme de date/heure.
Syntaxe
AddedOn():Date/Time
Exemple
AddedOn()
Renvoie la date et l'heure auxquelles le noeud en cours a été ajouté à la version.
AddFloat
Description
Renvoie le résultat de l'addition de deux valeurs à virgule flottante.
Syntaxe
AddFloat(Float1,Float2:Float):Float
Exemple
AddFloat(2.14,3.75)
La valeur renvoyée est 5.89.
AncestorProp
Description
Renvoie la valeur de propriété du premier ancêtre lorsqu'une propriété est égale à une valeur donnée.
Cette fonction a une portée locale et ne fonctionnera pas correctement si vous l'utilisez dans un contexte global.
Remarque :
Si le noeud en cours correspond aux critères, il est renvoyé.
Syntaxe
AncestorProp(Operator:String,Property:String,Value:String,FromTop:Boolean,ReturnProp:String)
Operator est l'opérateur à utiliser lors de la comparaison de la propriété à la valeur. Les valeurs valides sont : =, <, >, >= et <=.
Property est le nom de la propriété à utiliser.
Value est la valeur à comparer.
FromTop indique si la recherche doit être effectuée à partir du noeud supérieur de la hiérarchie. Si la valeur est False, la recherche est effectuée à partir du noeud actuel.
ReturnProp est le nom de la propriété à renvoyer.
And
Description
Renvoie la valeur True si toutes les expressions booléennes indiquées renvoient True.
Syntaxe
And(Expression1,Expression2,...ExpressionN:Boolean):Boolean
Exemple
And(1,T,True)
La valeur renvoyée est True.
ArrayCount
Description
Renvoie le nombre d'éléments dans la liste indiquée (tableau).
Syntaxe
ArrayCount(List:String,Delimiter:String):Integer
List indique la liste des chaînes sur lesquelles porte la recherche.
Delimiter est le caractère à utiliser pour séparer les éléments dans la liste de chaînes. Caractères spéciaux pris en charge :
[comma]
[space]
[tab]
Remarque :
Vous devez utiliser le nom du séparateur (et non le caractère) et le placer entre crochets.
Exemple
ArrayCount(Diet Cola;Root Beer;Cola,[comma])
La valeur renvoyée est 3.
ArrayIndex
Description
Renvoie la position de la première occurrence de l'élément indiqué dans la liste (tableau). Renvoie zéro (0) si l'élément est introuvable.
Syntaxe
ArrayIndex(Item:String,List:String,Delimiter:String):Integer
Item indique la valeur de chaîne à tester.
List indique la liste des chaînes sur lesquelles porte la recherche.
Delimiter est le caractère à utiliser pour séparer les éléments dans la liste de chaînes. Caractères spéciaux pris en charge :
[comma]
[space]
[tab]
Remarque :
Vous devez utiliser le nom du séparateur (et non le caractère) et le placer entre crochets.
Exemple
ArrayIndex(Cola,Diet Cola;Root Beer;Cola,[comma])
La valeur renvoyée est 3.
ArrayItem
Description
Renvoie l'élément de la liste (tableau) à la position d'index indiquée.
Syntaxe
ArrayItem(List:String,Delimiter:String,Index:Integer):String
List indique la liste des chaînes sur lesquelles porte la recherche.
Delimiter est le caractère à utiliser pour séparer les éléments dans la liste de chaînes. Caractères spéciaux pris en charge :
[comma]
[space]
[tab]
Remarque :
Vous devez utiliser le nom du séparateur (et non le caractère) et le placer entre crochets.
Index est la position de la chaîne dans la liste. Une valeur négative indique le dernier élément de la liste.
Exemple
ArrayItem(Diet Cola;Root Beer;Cola,;,3)
La valeur renvoyée est Cola.
AscNodeProp
Description
Renvoie la valeur de propriété du noeud associé référencé par la propriété indiquée.
Syntaxe
AscNodeProp(LookUpProperty,ReturnProperty)
LookupProperty est le nom de la propriété pointant vers le noeud. Le type de données de la propriété doit être Node ou AscNode.
ReturnProperty est le nom de la propriété du noeud associé à renvoyer. La propriété doit être globale.
AvgList
Description
Renvoie la moyenne des éléments dans une liste, en ignorant les éléments vides. Renvoie une chaîne vide si la liste contient un élément n'appartenant pas au type indiqué.
Syntaxe
AvgList(InputList:String,Delimiter:String,ItemType:String):String
InputList indique la liste à utiliser.
Delimiter est le caractère à utiliser pour séparer les éléments dans la liste de chaînes. Caractères spéciaux pris en charge :
[comma]
[space]
[tab]
Remarque :
Vous devez utiliser le nom du séparateur (et non le caractère) et le placer entre crochets.
ItemType indique le type de données d'élément attendu pour les membres de la liste. Valeurs valides : integer, float et datetime. La valeur par défaut est float.
Exemple
AvgList(1;2;3,[comma],Integer)
La valeur renvoyée est 2.
BoolToStr
Description
Renvoie une valeur booléenne convertie en True ou False. Renvoie la valeur False si la valeur d'entrée n'est pas une valeur booléenne.
Syntaxe
BoolToStr(Expression:Boolean):String
Exemple
BoolToStr(1)
La valeur renvoyée est True.
Changed
Description
Renvoie la valeur de la propriété de suivi des modifications Noeud modifié sous forme de valeur booléenne.
Syntaxe
Changed()
ChangedBy
Description
Renvoie le nom de l'utilisateur qui a mis à jour en dernier le noeud en cours dans la version.
Syntaxe
ChangedBy():String
Exemple
ChangedBy()
ChangedOn
Description
Renvoie la valeur de la propriété de suivi des modifications Modifié le.
Syntaxe
ChangedOn():Date/Time
Exemple
ChangedOn()
Renvoie la date et l'heure auxquelles le noeud en cours a été mis à jour en dernier dans la version.
Concat
Description
Concatène les chaînes indiquées en une seule et renvoie le résultat.
Syntaxe
Concat(Item1,Item2,... ItemN:String):String
Exemple
Concat(Abbrev,-,Descr())
Si le nom du noeud en cours est 100 et que sa description est Colas, la valeur renvoyée est 100–Colas.
ConcatWithDelimiter
Description
Concatène les chaînes indiquées en une liste délimitée et renvoie le résultat.
Syntaxe
ConcatWithDelimiter(Delimiter:String,SkipBlanks:Boolean,Items:String)
Delimiter est le caractère à utiliser pour séparer les éléments dans la liste de chaînes. Caractères spéciaux pris en charge :
[comma]
[space]
[tab]
Remarque :
Vous devez utiliser le nom du séparateur (et non le caractère) et le placer entre crochets.
SkipBlanks indique si les valeurs vides de la liste de chaînes doivent être ignorées. Valeurs valides : 1, 0, T, F, t, f.
Items indique la liste de chaînes à concaténer.
Exemple
ConcatWithDelimiter([comma],1,Item1,Item2,Item3,Item4)
La valeur renvoyée est Item1; Item2; Item3; Item4.
Decode
Description
Renvoie la chaîne d'entrée avec toutes les instances de [openparen], [closeparen], [comma], [tab], [space], [crlf], [cr] et [lf] remplacées par le caractère approprié.
Remarque :
Cette fonction permet de mettre à niveau les noms de définition de propriété qui utilisent des caractères spéciaux. Ces caractères spéciaux peuvent entraîner des problèmes d'analyse avec les formules de propriété dérivée. Cette fonction est principalement utilisée pour convertir les propriétés existantes qui utilisent des classes de dérivée obsolètes dans la classe de dérivée Formule.
Syntaxe
Decode(CodedString:String):String
CodedString est la valeur de chaîne sur laquelle exécuter la fonction.
DefaultProp
Description
Renvoie la valeur par défaut de la propriété.
Syntaxe
DefaultProp(Property:String)
Property est le nom de la propriété à utiliser.
Descr
Description
Renvoie la description du noeud en cours.
Syntaxe
Descr():String
Exemple
Si la description du noeud en cours est Colas, la valeur renvoyée est Colas.
Divide
Description
Divise les deux valeurs entières indiquées et renvoie le résultat.
Syntaxe
Divide(Int1,Int2:Integer):Integer
Exemple
Divide(200,10)
La valeur renvoyée est 20.
DivideFloat
Description
Divise deux nombres à virgule flottante (réels) et renvoie le résultat.
Syntaxe
Divide(Float1,Float2:Float):Float
Exemple
DivideFloat(2.535,1.5)
La valeur renvoyée est 1.69.
DualAncestorProp
Description
Renvoie la valeur de propriété du premier ancêtre lorsque deux propriétés sont égales aux valeurs données.
Cette fonction a une portée locale et ne fonctionnera pas correctement si vous l'utilisez dans un contexte global.
Syntaxe
DualAncestorProp(Operator1:String,Property1:String,Value1:String,Operator2:String,Property2:String,Value2:String,FromTop:Boolean,ReturnProp:String):String
Operator1 est l'opérateur à utiliser lors de la comparaison de la première propriété à la valeur. Les valeurs valides sont : =, <, >, >= et <=.
Property1 est le nom de la première propriété à vérifier.
Value1 est la première valeur à comparer.
Operator2 est l'opérateur à utiliser lors de la comparaison de la seconde propriété à la valeur. Les valeurs valides sont : =, <, >, >= et <=.
Property2 est le nom de la seconde propriété à vérifier.
Value2 est la seconde valeur à comparer.
FromTop indique si la recherche doit être effectuée à partir du noeud supérieur de la hiérarchie. Si la valeur est False, la recherche est effectuée à partir du noeud actuel.
ReturnProp est le nom de la propriété de l'ancêtre à renvoyer.
Equals
Description
Renvoie la valeur True si les deux valeurs indiquées sont égales. Cette fonction respecte la casse.
Syntaxe
Equals(ParamType:String,Param1:String,Param2:String):Boolean
ParamType est le type de données à utiliser pour la comparaison de valeurs. Valeurs valides : string, integer, float et date. La valeur par défaut est integer.
Param1 est la première valeur à comparer.
Param2 est la seconde valeur à comparer.
Exemple
Equals(integer,01,1)
La valeur renvoyée est True.
FlipList
Description
Renvoie une chaîne représentant l'inverse de la liste indiquée.
Syntaxe
FlipList(List,Delimiter:String):String
List indique la liste de chaînes à inverser.
Delimiter est le caractère à utiliser pour séparer les éléments dans la liste de chaînes. Caractères spéciaux pris en charge :
[comma]
[space]
[tab]
Remarque :
Vous devez utiliser le nom du séparateur (et non le caractère) et le placer entre crochets.
Exemple
FlipList(DietCola;Orange Soda;Root Beer;Lemonade,[comma])
La valeur renvoyée est Lemonade,Root Beer,Orange Soda,Diet Cola.
FloatToStr
Description
Renvoie une valeur à virgule flottante convertie en chaîne. Renvoie zéro (0) si la valeur d'entrée n'est pas une valeur à virgule flottante.
Syntaxe
FloatToStr(Float1:Float):String
Exemple
FloatToStr(1.001)
La valeur renvoyée est 1.001.
Format
Description
Formate la valeur à l'aide de l'identifiant de type de paramètre de chaîne de format et de la valeur de paramètre du type spécifié. Cette fonction est limitée à un paramètre de valeur.
Syntaxe
Format(Format:String,ParamType:String, ValueToFormat:String):String
Format est le format à appliquer.
ParamType est le type de données à utiliser pour la comparaison de valeurs. Valeurs valides : string, integer, float et date. La valeur par défaut est integer.
ValueToFormat est la valeur sur laquelle exécuter la fonction.
Exemple
Format('%8.2f',Float,123.456)
La valeur renvoyée est 123.46.
FormattedDate
Description
Renvoie la valeur d'une propriété de date formatée à l'aide de la chaîne de format indiquée.
Syntaxe
FormattedDate(PropertyName:String,FormatString:String): String
PropertyName est le nom de la propriété à utiliser.
FormatString indique le format de date à appliquer.
GreaterThan
Description
Compare deux valeurs et renvoie la valeur True si la première valeur est supérieure à la seconde.
Syntaxe
GreaterThan(Value1:Integer,Value2:Integer,ParamType:String):Boolean
Value1 est la première valeur à comparer.
Value2 est la seconde valeur à comparer.
ParamType est le type de données à utiliser pour la comparaison de valeurs. Valeurs valides : string, integer, float et date. La valeur par défaut est integer.
Exemple
GreaterThan(1,2)
La valeur renvoyée est False.
GreaterThanOrEqual
Description
Compare deux valeurs et renvoie la valeur True si la première valeur est supérieure ou égale à la seconde.
Syntaxe
GreaterThanOrEqual(Value1:Integer,Value2:Integer,ParamType:String):Boolean
Value1 est la première valeur à comparer.
Value2 est la seconde valeur à comparer.
ParamType est le type de données à utiliser pour la comparaison de valeurs. Valeurs valides : string, integer, float et date. La valeur par défaut est integer.
Exemple
GreaterThanOrEqual(2,2)
La valeur renvoyée est True.
HasCharacters
Description
Renvoie la valeur True si l'entrée indiquée contient des caractères issus des classes de caractères, des caractères spéciaux ou des caractères répertoriés dans CharList.
Syntaxe
HasCharacters(Input:String,CharList:String):Boolean
Input est la valeur de chaîne à tester.
CharList est une liste de caractères à tester, y compris les valeurs spéciales facultatives. Les valeurs spéciales facultatives sont entre crochets et séparées par des virgules. Valeurs valides : [alpha], [numeric], [whitespace], [punctuation], [uppercase], [lowercase], [comma], [space], [tab], [crlf], [cr], [lf], [openparen] et [closeparen].
HasChildWith
Description
Renvoie la valeur True si l'expression indiquée est True pour n'importe quel enfant du noeud en cours.
Syntaxe
HasChildWith(Expression:Boolean):Boolean
Exemple
HasChildWith(GreaterThan(ID(),200))
Si le noeud en cours a des enfants avec un ID supérieur à 200, la valeur renvoyée est True.
HasParentNode
Description
Renvoie la valeur True si le noeud local en cours comporte un noeud parent.
Cette fonction a une portée locale et ne fonctionnera pas correctement si vous l'utilisez dans un contexte global.
Syntaxe
HasParentNode():Boolean
Exemple
HasParentNode()
Si le noeud est un enfant du noeud supérieur d'une hiérarchie ou d'un noeud descendant, la valeur renvoyée est True.
HasSiblingWith
Description
Renvoie la valeur True si l'expression indiquée est True pour n'importe quel semblable du noeud en cours.
Cette fonction a une portée locale et ne fonctionnera pas correctement si vous l'utilisez dans un contexte global.
Syntaxe
HasSiblingWith(Expression:Boolean):Boolean
Exemple
HasSiblingWith(PropValue(Leaf))
Si l'un des enfants est un enfant feuille, la valeur renvoyée est True.
HierNodePropValue
Description
Renvoie la valeur de la propriété indiquée du noeud donné dans la hiérarchie spécifiée.
Syntaxe
HierNodePropValue(HierAbbrev:String,NodeAbbrev:String,PropAbbrev:String):String
HierAbbrev est le nom de la hiérarchie à utiliser.
NodeAbbrev est le nom du noeud à utiliser.
PropAbbrev est le nom de la propriété à utiliser.
Exemple
HierNodePropValue(Assets,1000,Description)
Si la description du noeud 1000 dans la hiérarchie Assets est "Banking", la valeur renvoyée est Banking.
ID
Description
Renvoie l'ID du noeud en cours.
Syntaxe
ID():Integer
Exemple
ID()
Si l'ID du noeud en cours est 2000, la valeur renvoyée est 2000.
If
Description
Renvoie la valeur du paramètre TrueResult si l'expression spécifiée renvoie la valeur True. Dans le cas contraire, elle renvoie la valeur du paramètre FalseResult.
Syntaxe
If(Expression:Boolean, TrueResult:String,FalseResult:String):String
Expression est une expression booléenne à évaluer.
TrueResult est la valeur de chaîne à renvoyer si la condition est True.
FalseResult est la valeur de chaîne à renvoyer si la condition est False.
Exemple
If(Equals(String,Descr(),),Abbrev(),Concat(Abbrev,-,Descr()))
Si le nom du noeud est Colas et que sa description est vide, la valeur renvoyée est Colas.
Si le nom du noeud est 100 et que sa description est Colas, la valeur renvoyée est 100–Colas.
InheritedPropOrigin
Description
Renvoie le nom du noeud d'origine d'une valeur de propriété héritée. Si la propriété spécifiée est globale, la hiérarchie d'origine est également renvoyée. Renvoie False si la propriété indiquée n'est pas une propriété d'héritage, ou si le noeud ou la propriété est introuvable.
Cette fonction peut avoir une portée locale si une propriété locale est transmise dans les paramètres.
Syntaxe
InheritedPropOrigin(PropAbbrev:String,Node:String):String
Exemple
InheritedPropOrigin(Custom.AccountType,Abbrev())
PropAbbrev est le nom de la propriété à utiliser.
Node est le nom du noeud à utiliser.
InRange
Description
Renvoie la valeur True si la valeur indiquée est comprise dans la plage de valeurs indiquée. Si le paramètre d'entrée est une chaîne, les paramètres Min et Max indiquent une plage de longueur de chaîne à vérifier. Pour les autres types, Min et Max définissent une plage de valeurs numériques ou de dates à vérifier.
Remarque :
Si MinExclusive/MaxExclusive a la valeur True, les valeurs égales à Min/Max sont incluses dans la plage. Sinon, elles sont exclues.
Syntaxe
InRange(DataType:String,Input:String,Min:String,Max:String,MinExclusive:String,MaxExclusive:String):Boolean
DataType est le type de données à utiliser. Valeurs valides : string, integer, float et datetime.
Input est la valeur de chaîne à tester.
Min est la valeur minimale pour la vérification de la longueur ou de la plage.
Max est la valeur maximale pour la vérification de la longueur ou de la plage.
MinExclusive indique si la valeur minimale doit être exclue de la plage à vérifier.
MaxExclusive indique si la valeur maximale doit être exclue de la plage à vérifier.
Exemple
InRange(Integer,5,1,10,False,False)
La valeur renvoyée est True.
InternalPrefix
Description
Renvoie le préfixe non numérique du nom du noeud en cours.
Syntaxe
InternalPrefix()
Intersection
Description
Renvoie l'ensemble des éléments communs aux deux listes de valeurs spécifiées. L'ordre des résultats dépend de l'ordre d'apparition des éléments dans la première liste indiquée.
Syntaxe
Intersection(List1:String,List2:String,Delimiter:String):String
List1 indique une liste de chaînes sur lesquelles porte la recherche.
List2 indique une liste de chaînes sur lesquelles porte la recherche.
Delimiter est le caractère à utiliser pour séparer les éléments dans la liste de chaînes. Caractères spéciaux pris en charge :
[comma]
[space]
[tab]
Remarque :
Vous devez utiliser le nom du séparateur (et non le caractère) et le placer entre crochets.
Exemple
Intersection(A;B;C;D;E,C;E;F;A,[comma])
La valeur renvoyée est A,C,E.
IntToStr
Description
Renvoie la valeur entière indiquée convertie en un type de données de chaîne. Renvoie zéro (0) si la valeur d'entrée n'est pas un entier.
Syntaxe
IntToStr(Int1:Integer):String
Exemple
IntToStr(12345)
La valeur renvoyée est 12345.
InvertedLevel
Description
Renvoie la profondeur maximale des descendants situés en dessous du noeud en cours.
Syntaxe
InvertedLevel()
IsAlpha
Description
Renvoie la valeur True si la chaîne indiquée contient uniquement des lettres (casse non prise en compte).
Syntaxe
IsAlpha(String:String):Boolean
Exemple
IsAlpha(A23D)
La valeur renvoyée est False.
IsAlphaNumeric
Description
Renvoie la valeur True si la chaîne indiquée contient uniquement des lettres ou des chiffres (casse non prise en compte).
Syntaxe
IsAlphaNumeric(String:String,AllowBlanks:Boolean):Boolean
String est la valeur de chaîne à tester.
AllowBlanks indique si une chaîne vide doit être traitée comme une chaîne numérique. La valeur par défaut est False.
Exemple
IsAlphaNumeric(ABC123,True)
Renvoie la valeur True.
IsBlank
Description
Renvoie la valeur True si la valeur d'entrée indiquée est une chaîne vide (longueur zéro).
Syntaxe
IsBlank(Input:String):Boolean
Exemple
IsBlank(Descr())
Renvoie la valeur True si la description du noeud est vide.
IsBottomNode
Description
Renvoie la valeur True si le noeud indiqué n'a pas de noeuds enfant. Renvoie la valeur False si le noeud est introuvable.
Syntaxe
IsBottomNode(Node:String):Boolean
Node est le nom du noeud à utiliser.
Exemple
IsBottomNode(Abbrev)
Renvoie la valeur True si le noeud n'a pas d'enfants.
IsDataType
Description
Renvoie la valeur True si la valeur d'entrée correspond au type de données indiqué.
Syntaxe
IsDataType(DataType:String,Input:String):Boolean
DataType est le type de données à utiliser. Valeurs valides : boolean, string, integer, float et datetime.
Input est la valeur de chaîne à tester.
Exemple
IsDataType(123,Integer)
Renvoie la valeur True.
IsDefinedPropVal
Description
Renvoie la valeur True si la propriété indiquée pour le noeud spécifié possède une valeur définie (remplacée). Renvoie la valeur False si le noeud ou la propriété est introuvable.
Cette fonction peut avoir une portée locale si une propriété locale est transmise dans les paramètres.
Syntaxe
IsDefinedPropVal(PropAbbrev:String,Node:String):Boolean
PropAbbrev est le nom de la propriété à utiliser.
Node est le nom du noeud à utiliser.
Exemple
IsDefinedPropVal(Custom.AccountType,Abbrev())
Renvoie la valeur True si la propriété Type de compte possède une valeur définie (remplacée).
IsNodeAbove
Description
Renvoie la valeur True si le premier noeud est un ancêtre du second dans la hiérarchie en cours. Renvoie la valeur False si le noeud 1 ou 2 est introuvable.
Cette fonction a une portée locale et ne fonctionnera pas correctement si vous l'utilisez dans un contexte global.
Syntaxe
IsNodeAbove(Node1:String,Node2:String):Boolean
Node1 est le nom du premier noeud à utiliser.
Node2 est le nom du second noeud à utiliser.
Exemple
IsNodeAbove(Parent,Child)
Renvoie la valeur True si le noeud parent est un ancêtre du noeud enfant.
IsNodeBelow
Description
Renvoie la valeur True si le premier noeud est un descendant du second dans la hiérarchie en cours. Renvoie la valeur False si le noeud 1 ou 2 est introuvable.
Syntaxe
IsNodeBelow(Node1:String,Node2:String):Boolean
Node1 est le nom du premier noeud à utiliser.
Node2 est le nom du second noeud à utiliser.
Exemple
IsNodeBelow(Child,Parent)
Renvoie la valeur True si le noeud enfant est un descendant du noeud parent.
IsNumeric
Description
Renvoie la valeur True si la valeur indiquée contient uniquement des chiffres (0 à 9).
Syntaxe
IsNumeric(String: String,AllowBlanksAsNumeric:Boolean):Boolean
String est la valeur de chaîne à tester.
AllowBlanksAsNumeric indique si une valeur vide peut être considérée comme une chaîne. La valeur par défaut est False.
Exemple
IsNumeric(12345)
La valeur renvoyée est True.
IsRangeListSubset
Description
Renvoie la valeur True si la valeur indiquée est un sous-ensemble de la liste de plages indiquée.
Syntaxe
IsRangeListSubset(RangeList:Range List,SubsetRangeList:Range List,Delimiter:String):Boolean
RangeList est une liste des plages d'entiers dans lesquelles effectuer la recherche, délimitées par le séparateur indiqué.
SubsetRangeList est une liste de sous-ensembles des plages d'entiers dans lesquelles effectuer la recherche, délimitées par le séparateur indiqué.
Delimiter est le caractère à utiliser pour séparer les éléments dans la liste de chaînes. Caractères spéciaux pris en charge :
[comma]
[space]
[tab]
Remarque :
Vous devez utiliser le nom du séparateur (et non le caractère) et le placer entre crochets.
Length
Description
Renvoie le nombre de caractères de la valeur de chaîne donnée.
Syntaxe
Length(String:String):Integer
Exemple
Length(Desc())
Si la description du noeud en cours est Colas, la valeur renvoyée est 5.
LessThan
Description
Compare deux valeurs et renvoie la valeur True si la première valeur est inférieure à la seconde.
Syntaxe
LessThan(Value1:Integer,Value2:Integer,ParamType:String):Boolean
Value1 est la première valeur à comparer.
Value2 est la seconde valeur à comparer.
ParamType est le type de données à utiliser pour la comparaison de valeurs. Valeurs valides : string, integer, float et date. La valeur par défaut est integer.
Exemple
LessThan(1,2)
La valeur renvoyée est True.
LessThanOrEqual
Description
Compare deux valeurs et renvoie la valeur True si la première valeur est inférieure ou égale à la seconde.
Syntaxe
LessThanOrEqual(Value1:Integer,Value2:Integer,ParamType:String):Boolean
Value1 est la première valeur à comparer.
Value2 est la seconde valeur à comparer.
ParamType est le type de données à utiliser pour la comparaison de valeurs. Valeurs valides : string, integer, float et date. La valeur par défaut est integer.
Exemple
LessThanOrEqual(3,3)
La valeur renvoyée est True.
ListAncestors
Description
Renvoie une liste des noms des ancêtres du noeud en cours, séparés par des virgules, en commençant par le noeud supérieur. Renvoie une chaîne vide si le noeud en cours n'est pas un noeud local.
Cette fonction a une portée locale et ne fonctionnera pas correctement si vous l'utilisez dans un contexte global.
Syntaxe
ListAncestors(SortOrder:String):String
SortOrder indique l'ordre de tri pour la liste de noeuds renvoyée. Les valeurs d'ordre de tri prises en charge sont les suivantes :
[hier] : valeur par défaut pour le contexte local. La liste des noeuds est renvoyée dans l'ordre de tri de hiérarchie standard pour la hiérarchie en cours.
[alpha] : la liste des noeuds est renvoyée triée par nom.
[nodeid] : utilisation limitée à des fins de compatibilité héritée. La liste des noeuds est renvoyée triée par ordre numérique sur la base de l'ID de chaque noeud.
Remarque :
Vous devez utiliser des crochets autour du paramètre SortOrder.
Exemple
ListAncestors([alpha])
Si A, B, C et D sont des enfants de Z, que Z est un enfant de Y et que le noeud en cours est D, la valeur renvoyée est Z,Y.
ListChildren
Description
Renvoie la liste des enfants du noeud en cours séparés par des virgules.
Syntaxe
ListChildren(SortOrder:String):String
SortOrder indique l'ordre de tri pour la liste de noeuds renvoyée. Les valeurs d'ordre de tri prises en charge sont les suivantes :
[hier] : valeur par défaut pour le contexte local. La liste des noeuds est renvoyée dans l'ordre de tri de hiérarchie standard pour la hiérarchie en cours.
[alpha] : la liste des noeuds est renvoyée triée par nom.
[nodeid] : utilisation limitée à des fins de compatibilité héritée. La liste des noeuds est renvoyée triée par ordre numérique sur la base de l'ID de chaque noeud.
Remarque :
Vous devez utiliser des crochets autour du paramètre SortOrder.
Exemple
ListChildren([alpha])
Si A, B, C et D sont des enfants de Z et que le noeud en cours est Z, la valeur renvoyée est A, B, C, D.
ListContains
Description
Renvoie la valeur True si la valeur spécifiée est comprise dans la liste indiquée.
Syntaxe
ListContains(List:String,Item:String,Delimiter: String):Boolean
List indique la liste des chaînes sur lesquelles porte la recherche.
Item indique la valeur de chaîne sur laquelle exécuter la fonction.
Delimiter est le caractère à utiliser pour séparer les éléments dans la liste de chaînes. Caractères spéciaux pris en charge :
[comma]
[space]
[tab]
Remarque :
Vous devez utiliser le nom du séparateur (et non le caractère) et le placer entre crochets.
Exemple
ListContains(PropValue(NodeList),Colas,[comma])
La valeur renvoyée est True.
ListDescendants
Description
Renvoie la liste des descendants du noeud en cours séparés par des virgules.
Syntaxe
ListDescendants(SortOrder:String):String
SortOrder indique l'ordre de tri pour la liste de noeuds renvoyée. Les valeurs d'ordre de tri prises en charge sont les suivantes :
[hier] : valeur par défaut pour le contexte local. La liste des noeuds est renvoyée dans l'ordre de tri de hiérarchie standard pour la hiérarchie en cours.
[alpha] : la liste des noeuds est renvoyée triée par nom.
[nodeid] : utilisation limitée à des fins de compatibilité héritée. La liste des noeuds est renvoyée triée par ordre numérique sur la base de l'ID de chaque noeud.
Remarque :
Vous devez utiliser des crochets autour du paramètre SortOrder.
Exemple
ListDescendants([hier])
Si A, B, C et D sont des enfants de Z, que Z est un enfant de Y et que le noeud en cours est Y, la valeur renvoyée est Z, A, B, C, D.
ListDistinct
Description
Renvoie une liste distincte d'éléments à partir d'une liste indiquée, dont les doublons ont été enlevés.
Syntaxe
ListDistinct(InputList:String,Delimiter:String):String
InputList indique la liste à utiliser.
Delimiter est le caractère à utiliser pour séparer les éléments dans la liste de chaînes. Caractères spéciaux pris en charge :
[comma]
[space]
[tab]
Remarque :
Vous devez utiliser le nom du séparateur (et non le caractère) et le placer entre crochets.
Exemple
ListDistinct(A;B:C;A;D,[comma])
La valeur renvoyée est A,B,C,D.
ListNodePropValues
Description
Renvoie la liste des valeurs pour la propriété spécifiée pour une liste de noeuds donnée. Renvoie une chaîne vide dans la liste pour tout noeud introuvable.
Cette fonction peut avoir une portée locale si une propriété locale est transmise dans les paramètres.
Syntaxe
ListNodePropValues(NodeList:String,Delimiter:String,PropAbbrev:String):String
NodeList est une liste de noms de noeud séparés par des virgules.
Delimiter est le caractère à utiliser pour séparer les éléments dans la liste de chaînes. Caractères spéciaux pris en charge :
[comma]
[space]
[tab]
Remarque :
Vous devez utiliser le nom du séparateur (et non le caractère) et le placer entre crochets.
PropAbbrev est le nom de la propriété à utiliser.
Exemple
ListNodePropValues(100;200;300,[comma],Core.Leaf)
Renvoie la valeur True,True,True si les noeuds 100, 200 et 300 sont des noeuds feuille.
ListNodesWith
Description
Renvoie une liste de noeuds à partir de la liste des noeuds indiquée lorsque l'expression indiquée a la valeur True.
Syntaxe
ListNodesWith(NodeList:String,Delimiter:String,Expression:String):String
NodeList est une liste de noms de noeud séparés par des virgules.
Delimiter est le caractère à utiliser pour séparer les éléments dans la liste de chaînes. Caractères spéciaux pris en charge :
[comma]
[space]
[tab]
Remarque :
Vous devez utiliser le nom du séparateur (et non le caractère) et le placer entre crochets.
Expression est une expression booléenne à évaluer.
Exemple
ListNodesWith(100;200;300,[comma],NodeIsLeaf())
Renvoie la valeur True,True,True si les noeuds 100, 200 et 300 sont des noeuds feuille.
ListRelatedNodesWith
Description
Renvoie une liste de noeuds liés au noeud en cours lorsque l'expression indiquée a la valeur True.
Cette fonction a une portée locale si le paramètre de relation est Ancêtres ou Semblables.
Syntaxe
ListRelatedNodesWith(Relation:String,Expression:String,SortOrder:String,Max:Integer):String
La relation peut être l'une des suivantes :
Ancêtres : les propriétés locales peuvent être référencées dans l'expression indiquée.
Semblables : les propriétés locales peuvent être référencées dans l'expression indiquée.
Enfants : les propriétés locales et globales peuvent être référencées dans l'expression indiquée.
Descendants : les propriétés locales et globales peuvent être référencées dans l'expression indiquée.
Expression est une expression booléenne à évaluer.
SortOrder indique l'ordre de tri pour la liste de noeuds renvoyée. Les valeurs d'ordre de tri prises en charge sont les suivantes :
[hier] : valeur par défaut pour le contexte local. La liste des noeuds est renvoyée dans l'ordre de tri de hiérarchie standard pour la hiérarchie en cours.
[alpha] : la liste des noeuds est renvoyée triée par nom.
[nodeid] : utilisation limitée à des fins de compatibilité héritée. La liste des noeuds est renvoyée triée par ordre numérique sur la base de l'ID de chaque noeud.
Remarque :
Vous devez utiliser des crochets autour du paramètre SortOrder.
Max est une valeur d'entier représentant le nombre maximal de noeuds à renvoyer. La valeur zéro ou l'absence de valeur indique que le nombre de noeuds est illimité. Tous les noeuds sont renvoyés.
Exemple
ListRelatedNodesWith(children,True,[alpha],1000)
Renvoie 100,200,300 si les noeuds sont les enfants du noeud en cours.
ListSiblings
Description
Renvoie la liste des semblables (homologues) séparés par des virgules pour le noeud en cours.
Cette fonction a une portée locale et ne fonctionnera pas correctement si vous l'utilisez dans un contexte global.
Syntaxe
ListSiblings(SortOrder:String):String
SortOrder indique l'ordre de tri pour la liste de noeuds renvoyée. Les valeurs d'ordre de tri prises en charge sont les suivantes :
[hier] : valeur par défaut pour le contexte local. La liste des noeuds est renvoyée dans l'ordre de tri de hiérarchie standard pour la hiérarchie en cours.
[alpha] : la liste des noeuds est renvoyée triée par nom.
[nodeid] : utilisation limitée à des fins de compatibilité héritée. La liste des noeuds est renvoyée triée par ordre numérique sur la base de l'ID de chaque noeud.
Exemple
ListSiblings([alpha])
Si A, B, C et D sont les enfants de Z et que le noeud en cours est B, la valeur renvoyée est A, C, D.
LowerCase
Description
Renvoie la valeur de chaîne spécifiée convertie en minuscules.
Syntaxe
LowerCase(String:String):String
Exemple
LowerCase(HOBBES)
La valeur renvoyée est hobbes.
LTrim
Description
Renvoie la valeur indiquée en supprimant tous les espaces à partir du début de la chaîne.
Syntaxe
LTrim(String: String): String
Exemple
LTrim(" 101203")
La valeur renvoyée est 101203.
MaxList
Description
Renvoie l'élément maximal à partir de la liste donnée, en ignorant les éléments vides. Renvoie une chaîne vide si la liste contient un élément n'appartenant pas au type indiqué.
Syntaxe
MaxList(InputList: String,Delimiter: String,ItemType: String)
InputList indique la liste à utiliser.
Delimiter est le caractère à utiliser pour séparer les éléments dans la liste de chaînes. Caractères spéciaux pris en charge :
[comma]
[space]
[tab]
Remarque :
Vous devez utiliser le nom du séparateur (et non le caractère) et le placer entre crochets.
ItemType indique le type de données d'élément attendu pour les membres de la liste. Valeurs valides : integer, float et datetime. La valeur par défaut est float.
Exemple
MaxList(1;2;3,[comma],Integer)
La valeur renvoyée est 3.
MinList
Description
Renvoie l'élément minimal à partir de la liste donnée, en ignorant les éléments vides. Renvoie une chaîne vide si la liste contient un élément n'appartenant pas au type indiqué.
Syntaxe
MinList(InputList:String,Delimiter:String,ItemType:String)
InputList indique la liste à utiliser.
Delimiter est le caractère à utiliser pour séparer les éléments dans la liste de chaînes. Caractères spéciaux pris en charge :
[comma]
[space]
[tab]
Remarque :
Vous devez utiliser le nom du séparateur (et non le caractère) et le placer entre crochets.
ItemType indique le type de données d'élément attendu pour les membres de la liste. Valeurs valides : integer, float et datetime. La valeur par défaut est float.
Exemple
MinList(1;2;3,[comma],Integer)
La valeur renvoyée est 1.
Modulus
Description
Renvoie le modulus (reste) de la division de deux entiers.
Syntaxe
Modulus(Dividend: Integer, Divisor: Integer): Integer
Dividende est le numérateur de la fraction en cours de division.
Divisor est le dénominateur de la fraction en cours de division.
Exemple
Modulus(5,2)
La valeur renvoyée est 1.
Multiply
Description
Multiplie deux entiers et renvoie le résultat.
Syntaxe
Multiply(Int1: Integer, Int2: Integer): Integer
Exemple
Multiply(2,5)
La valeur renvoyée est 10.
MultiplyFloat
Description
Multiplie les deux nombres à virgule flottante (réels) indiqués et renvoie le résultat.
Syntaxe
Multiply(Float1: Float, Float2: Float): Float
Exemple
MultiplyFloat(4.76,2.3)
La valeur renvoyée est 10.948.
NextSibling
Description
Renvoie le semblable suivant pour le noeud en cours en fonction de l'ordre de tri utilisé pour la hiérarchie en cours.
Cette fonction a une portée locale et ne fonctionnera pas correctement si vous l'utilisez dans un contexte global.
Syntaxe
NextSibling(): String
Exemple
NextSibling()
Si A, B, C et D sont les enfants de Z et que le noeud en cours est B, la valeur renvoyée est C.
NodeAccessGroups
Description
Renvoie la liste des groupes d'accès au noeud pour l'utilisateur et le noeud en cours séparés par des virgules.
Cette fonction a une portée locale et ne fonctionnera pas correctement si vous l'utilisez dans un contexte global.
Syntaxe
NodeAccessGroups(): String
Exemple
NodeAccessGroups()
La valeur renvoyée est Accounts, Finance.
NodeExists
Description
Renvoie la valeur True si le noeud indiqué existe.
Syntaxe
NodeExists(NodeAbbrev: string): Boolean
NodeAbbrev est le nom du noeud à utiliser.
Exemple
NodeExists(2000)
Si le noeud 2000 existe, la valeur renvoyée est True.
NodeInHier
Description
Renvoie la valeur True si le noeud indiqué existe dans la hiérarchie spécifiée.
Syntaxe
NodeInHier(NodeAbbrev, HierAbbrev: string): Boolean
NodeAbbrev est le nom du noeud à utiliser.
HierAbbrev est le nom de la hiérarchie à utiliser.
Exemple
NodeInHier(2000,Assets)
Si le noeud 2000 figure dans la hiérarchie Assets, la valeur renvoyée est True.
NodeIsLeaf
Description
Renvoie la valeur True si le noeud en cours est un noeud feuille.
Syntaxe
NodeIsLeaf(): Boolean
Exemple
NodeIsLeaf()
Si le noeud en cours est une feuille, la valeur renvoyée est True.
NodeIsValidForPropertyHiers
Description
Renvoie la valeur True si le noeud indiqué satisfait la contrainte de hiérarchie de la propriété indiquée. Renvoie également la valeur True si la propriété ne stocke pas de valeurs de noeud ou si aucune contrainte n'est définie pour la propriété.
Cette fonction peut avoir une portée locale si une propriété locale est transmise dans les paramètres.
Syntaxe
NodeIsValidForPropertyHiers(NodeAbbrev: String, PropAbbrev: String): Boolean
NodeAbbrev est le nom du noeud à utiliser.
PropAbbrev est le nom de la propriété à utiliser.
NodePropValue
Description
Renvoie la valeur de la propriété indiquée du noeud spécifié dans la hiérarchie en cours pour un noeud local ou dans la version en cours pour un noeud global.
Cette fonction peut avoir une portée locale si une propriété locale est transmise dans les paramètres.
Syntaxe
NodePropValue(NodeAbbrev: String, PropAbbrev: String): String
NodeAbbrev est le nom du noeud à utiliser.
PropAbbrev est le nom de la propriété à utiliser.
Exemple
NodePropValue(2000,Abbrev())
La valeur renvoyée est 2000.
Not
Description
Renvoie l'expression booléenne opposée de l'expression booléenne indiquée.
Syntaxe
Not(Expression: Boolean): Boolean
Exemple
Not(NodeIsLeaf())
Si le noeud est une branche, la valeur renvoyée est True.
Now
Description
Renvoie la date et/ou l'heure système actuelle.
Syntaxe
Now([DateTimeType: String]): DateTime
DataTimeType est un paramètre facultatif indiquant la partie de la date à renvoyer. Valeurs valides : Date, Time et Datetime. La valeur par défaut est Date.
Exemple
Now()
Renvoie la date et l'heure en cours ; par exemple, 3/25/2010 9:20:44 AM.
Now(Time)
Renvoie uniquement l'heure en cours ; par exemple, 9:20:44 AM.
Now(Date)
Renvoie uniquement la date en cours ; par exemple, 3/25/2010.
NumChildWith
Description
Renvoie le nombre d'enfants du noeud en cours pour lesquels l'expression indiquée est True.
Syntaxe
NumChildWith(Expression: Boolean): Integer
Exemple
NumChildWith(NodeIsLeaf())
Si le noeud a deux enfants feuille, la valeur renvoyée est 2.
NumDescendantsWith
Description
Renvoie le nombre de descendants du noeud en cours pour lesquels l'expression indiquée est True.
Syntaxe
NumDescendantsWith(Expression: Boolean): Integer
Exemple
NumDescendantsWith(NodeIsLeaf())
Si le noeud a deux enfants et que chaque enfant a 10 enfants feuille, la valeur renvoyée est 20.
Or
Description
Renvoie la valeur True si l'une des expressions booléennes indiquées est True.
Syntaxe
Or(Expression1, Expression2,... ExpressionN: Boolean): Boolean
Exemple
Or(NodeIsLeaf(),Equals(Integer,PropValue(Level),3))
Si le noeud en cours est une feuille ou se situe au niveau 3 de la hiérarchie, la valeur renvoyée est True.
OrigPropValue
Description
Renvoie la valeur de la propriété indiquée pour le noeud d'origine lors de l'utilisation des fonctions HasSiblingWith ou NumDescendantsWith.
Cette fonction peut avoir une portée locale si une propriété locale est transmise dans les paramètres.
Syntaxe
OrigPropValue(PropAbbrev: String): String
PropAbbrev est le nom de la propriété à utiliser.
Exemple
HasSiblingWith(GreaterThan(OrigPropValue(ID),ID())
Si l'ID du noeud en cours est 200 et qu'il a des semblables avec un ID de noeud supérieur à 200, la valeur renvoyée est True.
PadChar
Description
Renvoie une chaîne rallongée à l'aide d'un caractère de remplissage donné. Le remplissage peut se situer à gauche ou à droite de la chaîne d'origine. La chaîne résultante est d'une longueur au moins équivalente au nombre de chiffres précisé. Si la chaîne d'origine est plus longue que le nombre de chiffres indiqué, la liste d'origine est renvoyée.
Syntaxe
PadChar(String: String, PadChar: String; PadLeft: Boolean; NewLength: Integer): String
String est la valeur de chaîne sur laquelle exécuter la fonction.
PadChar est le caractère à utiliser pour le remplissage de la chaîne.
PadLeft indique s'il convient de remplir la chaîne sur la gauche. Valeurs valides : 1, 0, T, F, t ou f.
NewLength est un entier indiquant la longueur du résultat.
Exemple
PadChar(102,0,1,6)
La valeur renvoyée est 000102.
PadList
Description
Renvoie une liste étoffée à l'aide d'un caractère de remplissage donné. Le remplissage peut se situer à gauche ou à droite de la liste d'origine. La liste résultante est d'une longueur au moins équivalente au nombre de chiffres précisé. Si la liste d'origine est plus longue que le nombre de chiffres indiqué, la liste d'origine est renvoyée.
Syntaxe
PadList(String, DelimChar, PadChr:String, PadLeft: Boolean, NewLength:Integer): String
StringList est la liste des chaînes auxquelles appliquer le remplissage, délimitées par le séparateur indiqué.
Delimiter est le caractère à utiliser pour séparer les éléments dans la liste de chaînes. Caractères spéciaux pris en charge :
[comma]
[space]
[tab]
Remarque :
Vous devez utiliser le nom du séparateur (et non le caractère) et le placer entre crochets.
PadChar est le caractère à utiliser pour le remplissage de la chaîne.
PadLeft indique s'il convient de remplir la chaîne sur la gauche. Valeurs valides : 1, 0, T, F, t ou f.
NewLength est un entier indiquant la longueur du résultat.
Exemple
PadList(1;2;3;4,;,T,3)
La valeur renvoyée est 001;002;003;004.
ParentPropValue
Description
Renvoie la valeur de la propriété indiquée du noeud parent du noeud en cours. Renvoie une chaîne vide si le noeud n'a pas de parent ou si le noeud en cours n'est pas un noeud local.
Cette fonction a une portée locale et ne fonctionnera pas correctement si vous l'utilisez dans un contexte global.
Syntaxe
ParentPropValue(PropAbbrev: String): String
PropAbbrev est le nom de la propriété à utiliser.
Exemple
ParentPropValue(Abbrev)
Si le nom du noeud parent est Colas, la valeur renvoyée est Colas.
Pos
Description
Renvoie la position (index) du premier caractère de la sous-chaîne indiquée dans la chaîne donnée via une recherche respectant la casse. Renvoie zéro si la sous-chaîne est introuvable dans la valeur de chaîne.
Syntaxe
Pos(SubString: String, String: String): Integer
Substring est la valeur de chaîne à rechercher.
String est la valeur de chaîne sur laquelle exécuter la fonction.
Exemple
Pos(D,ABCDEFG)
La valeur renvoyée est 4.
PreviousSibling
Description
Renvoie le semblable précédent pour le noeud en cours en fonction de l'ordre de tri utilisé pour la hiérarchie en cours.
Cette fonction a une portée locale et ne fonctionnera pas correctement si vous l'utilisez dans un contexte global.
Syntaxe
PreviousSibling(): String
Exemple
PreviousSibling()
Si A, B, C et D sont les enfants de Z et que le noeud en cours est B, la valeur renvoyée est A.
PropControllingHier
Description
Renvoie le nom de la hiérarchie de contrôle de la propriété spécifiée dans la version en cours.
Syntaxe
PropControllingHier(PropAbbrev: String): String
PropAbbrev est le nom de la propriété à utiliser.
Exemple
PropControllingHier(TimeBalance)
La valeur renvoyée est Accounts.
PropDefaultValue
Description
Renvoie la valeur par défaut de la définition de propriété spécifiée.
Syntaxe
PropDefaultValue(PropAbbrev: String): String
PropAbbrev est le nom de la propriété à utiliser.
Exemple
PropDefaultValue(Currency)
La valeur renvoyée est USD.
PropertyCategories
Description
Renvoie la liste des catégories de propriété pour l'utilisateur en cours séparés par des virgules.
Syntaxe
PropertyCategories(AccessType: String) :String
AccessType est le niveau d'accès pour une catégorie de propriété. Les valeurs valides sont : ReadOnly, ReadWrite ou Both.
Exemple
PropertyCategories(Both)
La valeur renvoyée est System, All, Essbase, Enterprise, HFM, Planning.
PropMaxValue
Description
Renvoie la valeur maximale de la définition de propriété spécifiée.
Syntaxe
PropMaxValue(PropAbbrev: String): Integer
PropAbbrev est le nom de la propriété à utiliser.
Exemple
PropMaxValue(Volume)
La valeur renvoyée est 10.
PropMinValue
Description
Renvoie la valeur minimale de la définition de propriété spécifiée.
Syntaxe
PropMinValue(PropAbbrev: String): Integer
PropAbbrev est le nom de la propriété à utiliser.
Exemple
PropMinValue(Volume)
La valeur renvoyée est 1.
PropValue
Description
Renvoie la valeur de la propriété indiquée pour le noeud en cours.
Cette fonction peut avoir une portée locale si une propriété locale est transmise dans les paramètres.
Syntaxe
PropValue(PropAbbrev: String): String
PropAbbrev est le nom de la propriété à utiliser.
Exemple
PropValue(Volume)
La valeur renvoyée est 2.
RangeListContains
Description
Renvoie la valeur True si la valeur spécifiée est comprise dans la liste de plages indiquée.
Syntaxe
RangeListContains(RangeList: String, Value: Integer, Delimiter: String): Boolean
RangeList est une liste des plages d'entiers dans lesquelles effectuer la recherche, délimitées par le séparateur indiqué. Par exemple, 1-100, 201-300
Value est une valeur d'entier à rechercher dans la liste des plages.
Delimiter est le caractère à utiliser pour séparer les éléments dans la liste de chaînes. Caractères spéciaux pris en charge :
[comma]
[space]
[tab]
Remarque :
Vous devez utiliser le nom du séparateur (et non le caractère) et le placer entre crochets.
Exemple
RangeListContains(PropValue(MyRangeList),1,[Comma])
Si la propriété MyRangeList a pour valeur 1-10, 101-10000, la valeur renvoyée est True, car 1 est contenu dans la plage spécifiée. Toutefois, RangeListContains(PropValue(MyRangeList),11,[Comma]) renvoie la valeur False, car 11 n'est pas contenu dans la plage spécifiée.
Remarque :
Si vous remplacez MyRangeList par "1-5,6-10,101-1000", Data Relationship Management remplace cette valeur par "1-10,101-1000" pour vérifier RangeList et combiner les plages avec des limites contiguës.
ReplacementAbbrev
Description
Renvoie le nom du noeud de remplacement (fusion) pour le noeud en cours si le noeud est inactif et si un noeud de fusion est spécifié.
Syntaxe
ReplacementAbbrev(): String
Exemple
ReplacementAbbrev()
ReplacePropValue
Description
Renvoie la valeur de propriété indiquée pour le noeud de remplacement (fusion) du noeud en cours si le noeud est inactif et si un noeud de fusion est spécifié.
Cette fonction peut avoir une portée locale si une propriété locale est transmise dans les paramètres.
Syntaxe
ReplacePropValue(PropAbbrev: String): String
PropAbbrev est le nom de la propriété à utiliser.
Exemple
ReplacePropValue(Description)
ReplaceStr
Description
Renvoie la chaîne avec des instances de l'ancien modèle remplacé par le nouveau.
Syntaxe
ReplaceStr(String: String,OldPattern: String,NewPattern: String,ReplaceAll: Boolean): String
String est la valeur de chaîne sur laquelle exécuter la fonction.
NewPattern est la valeur de chaîne avec laquelle remplacer la chaîne trouvée.
OldPattern est la valeur de chaîne à rechercher.
ReplaceAll indique s'il convient de remplacer toutes les occurrences de la chaîne de recherche par la chaîne de remplacement. Valeurs valides : 1, 0, T, F, t ou f.
Exemple
ReplaceStr(A1;A2;A3,A,B,T)
La valeur renvoyée est B1;B2;B3.
RTrim
Description
Renvoie la valeur indiquée en supprimant tous les espaces à partir de la fin de la chaîne.
Syntaxe
RTrim(String: String): String
String est la valeur de chaîne sur laquelle exécuter la fonction.
Exemple
RTrim("100 "))
La valeur renvoyée est 100.
SortList
Description
Renvoie la liste spécifiée dans l'ordre de tri.
Syntaxe
SortList(InputList: String,Delimiter: String,IgnoreCase: Boolean,ItemType: String)
InputList indique la liste à utiliser.
Delimiter est le caractère à utiliser pour séparer les éléments dans la liste de chaînes. Caractères spéciaux pris en charge :
[comma]
[space]
[tab]
Remarque :
Vous devez utiliser le nom du séparateur (et non le caractère) et le placer entre crochets.
IgnoreCase indique si la casse doit être ignorée lors d'un tri. La valeur par défaut est False.
ItemType indique le type de données cible pour les éléments de la liste de résultats. Valeurs valides : string, integer, float, date, time et datetime. La valeur par défaut est string. Si aucun élément ne peut être converti dans le type indiqué, la fonction renvoie une chaîne vide.
StripPadChar
Description
Enlève le caractère de remplissage spécifié à partir du début d'une chaîne donnée et renvoie la valeur modifiée. Si la chaîne d'origine contient moins de caractères de remplissage que ce qui est spécifié pour StripCount, la valeur de la chaîne d'origine est renvoyée.
Syntaxe
StripPadChar(String: String, PadChar: String, StripCount: Integer): String
String est la valeur de chaîne sur laquelle exécuter la fonction.
PadChar est le caractère à utiliser pour le remplissage de la chaîne.
StripCount est un entier indiquant le nombre de caractères à enlever de la chaîne. La valeur zéro enlève tous les caractères remplis.
Exemple
StripPadChar(0003333,0,6)
La valeur renvoyée est 3333.
StrToBool
Description
Renvoie une valeur booléenne basée sur la chaîne indiquée. Si la chaîne commence par Y, T ou 1 (un), indépendamment de la casse ou des caractères qui suivent, la valeur True est renvoyée. Si la chaîne commence par N, F ou 0 (zéro), indépendamment de la casse ou des caractères qui suivent, la valeur False est renvoyée.
Syntaxe
StrToBool(String: String): Boolean
String est la valeur de chaîne sur laquelle exécuter la fonction.
Exemple
StrToBool(0)
La valeur renvoyée est False.
StrToFloat
Description
Renvoie la valeur à virgule flottante de la chaîne donnée. Renvoie zéro (0) pour un espace ou une chaîne vide.
Si la chaîne indiquée ne représente pas un nombre à virgule flottante, une erreur est renvoyée.
Syntaxe
StrToFloat(String: String): Float
String est la valeur de chaîne sur laquelle exécuter la fonction.
Exemple
StrToFloat(11.101)
La valeur renvoyée est 11.101.
StrToInt
Description
Renvoie la valeur entière de la chaîne donnée. Renvoie zéro (0) pour un espace ou une chaîne vide.
Si la chaîne indiquée ne représente pas un nombre entier, une erreur est renvoyée.
Syntaxe
StrToInt(String: String): Integer
String est la valeur de chaîne sur laquelle exécuter la fonction.
Exemple
StrToInt(101)
La valeur renvoyée est 101.
Stuff
Description
Renvoie la valeur spécifiée avec les caractères indiqués remplacés par la chaîne donnée.
Syntaxe
Stuff(PropAbbrev: String, CharsToReplace: String, ReplacementChars: String): String
PropAbbrev est le nom de la propriété à utiliser.
CharsToReplace est la valeur de chaîne à rechercher.
ReplacementChars est la valeur de chaîne avec laquelle remplacer la chaîne trouvée.
Exemple
Stuff(Abbrev(),GEO,RIO)
Si Abbrev est GEO101, la valeur renvoyée est RIO101.
SubString
Description
Renvoie une partie de la chaîne indiquée, commençant à l'index donné et contenant le nombre de caractères spécifié.
Syntaxe
SubString(String: String, Index: Integer, Count: Integer): String
SubString est la valeur de chaîne sur laquelle exécuter la fonction.
Index est un entier représentant la position d'index à partir de laquelle démarrer la recherche de la sous-chaîne. La valeur zéro indique la position du premier caractère dans la chaîne.
Count est une valeur numérique représentant le nombre de caractères à rechercher, en commençant par l'index de début.
Exemple
SubString(Colas,1,2)
La valeur renvoyée est Co.
Subtract
Description
Soustrait la seconde valeur entière de la première valeur et renvoie le résultat.
Syntaxe
Subtract(Minuend: Integer,Subtrahend: Integer): Integer
Minuend est une valeur d'entier.
Subtrahend est une valeur d'entier.
Exemple
Subtract(10,2)
La valeur renvoyée est 8.
SubtractFloat
Description
Soustrait la seconde valeur à virgule flottante de la première valeur et renvoie le résultat.
Syntaxe
SubtractFloat(Minuend,Subtrahend: Float): Float
Minuend est une valeur à virgule flottante.
Subtrahend est une valeur à virgule flottante.
Exemple
SubtractFloat(8.09,3.76)
La valeur renvoyée est 4.33.
SumList
Description
Renvoie la somme des éléments dans une liste, en ignorant les éléments vides. Renvoie une chaîne vide si la liste contient un élément n'appartenant pas au type indiqué.
Syntaxe
SumList(InputList: String,Delimiter: String,ItemType: String):Integer
InputList indique la liste à utiliser.
Delimiter est le caractère à utiliser pour séparer les éléments dans la liste de chaînes. Caractères spéciaux pris en charge :
[comma]
[space]
[tab]
Remarque :
Vous devez utiliser le nom du séparateur (et non le caractère) et le placer entre crochets.
ItemType indique le type de données d'élément attendu pour les membres de la liste. Valeurs valides : integer et float. La valeur par défaut est float.
Exemple
SumList(1;2;3,;,Integer)
La valeur renvoyée est 6.
Trim
Description
Renvoie la valeur indiquée en supprimant tous les espaces à partir du début et de la fin de la chaîne.
Syntaxe
Trim(String: String): String
String est la valeur de chaîne sur laquelle exécuter la fonction.
Exemple
Trim(" 101 ")
La valeur renvoyée est 101.
UpperCase
Description
Renvoie une valeur de chaîne convertie en majuscules.
Syntaxe
UpperCase(String: String): String
String est la valeur de chaîne sur laquelle exécuter la fonction.
Exemple
UpperCase(smaller)
La valeur renvoyée est SMALLER.
UserName
Description
Renvoie le nom d'utilisateur pour l'utilisateur en cours.
Syntaxe
UserName(): String
Exemple
UserName()
La valeur renvoyée est le nom d'utilisateur.
XOr
Description
Renvoie la valeur True si une seule des expressions booléennes indiquées est True.
Syntaxe
XOr(Expression1:Boolean, Expression2: Boolean): Boolean
Exemple
XOr(NodeIsLeaf(),Equals(Integer,PropValue(Level),3))
Si le noeud est une feuille ou se situe au niveau 3 de la hiérarchie, la valeur renvoyée est True.