IsChild
Determines if the current member or a specified member is a child of the specified parent. This function can be used in these types of rules:
-
Calculation
-
Translation
-
Consolidation
-
Allocation
Note:
A member is a child if it is one level directly below a member in a tree hierarchy.
Syntax
HS.<Object>.IsChild("Parent","Element")
HS.Node.IsChild("Parent"."Entity"."S#Scenario.Y#Year.P#Period")
HS.<Object>.IsChild("Parent","")
HS.Custom(Dimension).IsChild("P3000-Phones")
Note:
Use a blank string (""
) to apply this function to the current member.
Table 11-32 Syntax for IsChild Function
Parameter | Description |
---|---|
<Object> |
One of these object keywords:
|
Parent |
Name of a Parent member. (Parent is mandatory.) |
Element |
Depending on the object selected, the name of a valid member of one of these dimensions:
|
Entity |
Name of a valid Entity dimension member. |
Scenario |
Name of a valid Scenario dimension member. |
Year |
A valid year |
Period |
A valid period |
Note:
For Node, determines if the member is an active child of the specified parent.
Return Value
A Boolean expression that is True if the element is a child of the specified parent; False if the element is not a child of the specified parent.
For Node, True if the element is an active child of the specified parent; False if the element is not an active child of the specified parent.
Example
In this example, if Connecticut is a child of EastRegion, then statements between the If...Then and End If lines are executed.
If HS.Entity.IsChild("EastRegion","Connecticut") = TRUE Then
...
End If
If HS.Custom("Prod").IsChild("P3000-Phones") = TRUE Then
...
End If