Layer.FindChildObject Methods
Finds the child object with the specified name.
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 | FindChildObject(System.String name) | Finds the child object with the specified name. |
| Public method | FindChildObject(System.String name, ChildObjectMode mode) | Finds the child object with the specified name and search mode. |
FindChildObject(System.String name)
Finds the child object with the specified name.Syntax
public EngineObject FindChildObject (
System.String name
)Parameters
name
Type: System.String
The name of the object we want to find.
The name of the object we want to find.
Return Value
Type: EngineObject
The child object with the specified name or a null reference if a match is not found.
The child object with the specified name or a null reference if a match is not found.
Remarks
This method returns the same result as calling the FindChildObject overload with AllLevels.
Example
// Find child object (layer) with the given name
public static Layer FindChildLayer(Layer layer, string layerName)
{
// Find the child object with the given name
EngineObject childObject = layer.FindChildObject(layerName);
// Return the found child object as layer.
// If it is not a Layer the return value will be null
return childObject as Layer;
}
FindChildObject(System.String name, ChildObjectMode mode)
Finds the child object with the specified name and search mode.Syntax
public EngineObject FindChildObject (
System.String name,
ChildObjectMode mode
)Parameters
name
Type: System.String
The name of the object we want to find.
The name of the object we want to find.
mode
Type: ChildObjectMode
Specifies whether only the top level child objects are searched or all levels.
Specifies whether only the top level child objects are searched or all levels.
Return Value
Type: EngineObject
The child object with the specified name or a null reference if a match is not found.
The child object with the specified name or a null reference if a match is not found.
Remarks
Only objects of types Layer, Operator, Visualizer, DataSet, Effect and Propagation can be found with 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.
Platforms
Windows, Linux, Android