Layer.GetChildObjects Methods
Gets the child objects of the current object.
Thread safety: This method is, in general, not thread-safe but can in most cases be called without a Guard. Show
Overload List
| Name | Description | |
|---|---|---|
| Public method | GetChildObjects() | Gets the child objects of the current object. |
| Public method | GetChildObjects(ChildObjectMode mode) | Gets the child objects of the current object using the specified mode. |
GetChildObjects()
Gets the child objects of the current object.Syntax
public EngineObjectCollection GetChildObjects ()Return Value
Type: A collection of EngineObject elements.
All child objects of the current object.
All child objects of the current object.
Remarks
This method returns the same result as calling the GetChildObjects overload with AllLevels.
GetChildObjects(ChildObjectMode mode)
Gets the child objects of the current object using the specified mode.Syntax
public EngineObjectCollection GetChildObjects (
ChildObjectMode mode
)Parameters
mode
Type: ChildObjectMode
Specifies whether only the top level child objects or all child objects are returned.
Specifies whether only the top level child objects or all child objects are returned.
Return Value
Type: A collection of EngineObject elements.
The child objects specified by mode.
The child objects specified by mode.
Remarks
Only objects of types Layer, Operator, Visualizer, DataSet, Effect and Propagation are returned by this method. If you need to locate some other object, for instance a Query, use this method to find the ReadOperator instead, and get the Query from there.
Example
// Get all top level child objects of the Layer
public static EngineObjectCollection GetTopLevelChildObjects(Layer layer)
{
// Get all child objects at the top level from the Layer and return it
return layer.GetChildObjects(ChildObjectMode.TopLevel);
}
Platforms
Windows, Linux, Android