activities
latest
false
UiPath logo, featuring letters U and I in white
UI Automation Activities
Last updated Oct 28, 2024

GetChildren

Retrieves the children of a specified target.

This API must be added after Open or Attach.

Definition

Namespace: UiPath.UIAutomationNext.API.Models

Assembly: UiPath.UIAutomationNext.API.Models (in UiPath.UIAutomationNext.API.Models dll)

Overloads

OverloadDescription
GetChildren(String, GetChildrenOptions)Retrieves the children of a specified target, identified by a string from Object Repository, along with other configurations.
GetChildren(RuntimeTarget, GetChildrenOptions)Retrieves the children of a specified target, identified by a runtime instance of an Object Repository element, along with other configurations.
GetChildren(TargetAnchorableModel, GetChildrenOptions)Retrieves the children of a specified target, identified by the TargetAnchorableModel object, along with other configurations.
GetChildren(IElementDescriptor, GetChildrenOptions)Retrieves the children of a specified target, identified by a descriptor of an element from Object Repository, along with other configurations.
GetChildren(IElementDescriptor, String, Boolean, Boolean, Double)Retrieves the children of a specified target, identified by a descriptor of an element from Object Repository, while specifying the name of the selector filter, the timeout, if you want to perform a recursive search or to check the root visibility.
GetChildren(String, String, Boolean, Boolean, Double)Retrieves the children of a specified target, identified by a string from Object Repository, while specifying the name of the selector filter, the timeout, if you want to perform a recursive search or to check the root visibility.

GetChildren(String, GetChildrenOptions)

Retrieves the children of a specified target, identified by a string from Object Repository, along with other configurations.

GetChildren(
    string target,
    GetChildrenOptions getChildrenOptions)GetChildren(
    string target,
    GetChildrenOptions getChildrenOptions)
target String
The target element from which you want to retrieve children elements, identified by a string from Object Repository.
getChildrenOptions GetChildrenOptions
Additional options to customize the retrieval of children elements. You can choose to customize:
  • SelectorFilter - The name of the selector filter.
  • Timeout - Timeout (in seconds).
  • Recursive - If true, performs a recursive search for all the children.
  • CheckRootVisibility - If true, checks the root visibility for all the children.

GetChildren(RuntimeTarget, GetChildrenOptions)

Retrieves the children of a specified target, identified by a runtime instance of an Object Repository element, along with other configurations.

GetChildren(
    RuntimeTarget target,
    GetChildrenOptions getChildrenOptions)GetChildren(
    RuntimeTarget target,
    GetChildrenOptions getChildrenOptions)
target RuntimeTarget
The target element from which you want to retrieve children elements, identified by a runtime instance of an Object Repository element.
getChildrenOptions GetChildrenOptions
Additional options to customize the retrieval of children elements. You can choose to customize:
  • SelectorFilter - The name of the selector filter.
  • Timeout - Timeout (in seconds).
  • Recursive - If true, performs a recursive search for all the children.
  • CheckRootVisibility - If true, checks the root visibility for all the children.

GetChildren(TargetAnchorableModel, GetChildrenOptions)

Retrieves the children of a specified target, identified by the TargetAnchorableModel object, along with other configurations.
GetChildren(
    TargetAnchorableModel target,
    GetChildrenOptions getChildrenOptions)GetChildren(
    TargetAnchorableModel target,
    GetChildrenOptions getChildrenOptions)
target TargetAnchorableModel
The target element from which you want to retrieve children elements, identified by the TargetAnchorableModel object.
getChildrenOptions GetChildrenOptions
Additional options to customize the retrieval of children elements. You can choose to customize:
  • SelectorFilter - The name of the selector filter.
  • Timeout - Timeout (in seconds).
  • Recursive - If true, performs a recursive search for all the children.
  • CheckRootVisibility - If true, checks the root visibility for all the children.

GetChildren(IElementDescriptor, GetChildrenOptions)

Retrieves the children of a specified target, identified by a descriptor of an element from Object Repository, along with other configurations.

GetChildren(
    IElementDescriptor elementDescriptor,
    GetChildrenOptions getChildrenOptions)GetChildren(
    IElementDescriptor elementDescriptor,
    GetChildrenOptions getChildrenOptions)
elementDescriptor IElementDescriptor
The element from which you want to retrieve children elements, identified by a descriptor of a UI element from Object Repository.
getChildrenOptions GetChildrenOptions
Additional options to customize the retrieval of children elements. You can choose to customize:
  • SelectorFilter - The name of the selector filter.
  • Timeout - Timeout (in seconds).
  • Recursive - If true, performs a recursive search for all the children.
  • CheckRootVisibility - If true, checks the root visibility for all the children.

GetChildren(IElementDescriptor, String, Boolean, Boolean, Double)

Retrieves the children of a specified target, identified by a descriptor of an element from Object Repository, while specifying the name of the selector filter, the timeout, if you want to perform a recursive search or to check the root visibility.

GetChildren(
    IElementDescriptor elementDescriptor,
    string selectorFilter,
    [bool checkRootVisibility],
    [bool recursive],
    [double timeout])GetChildren(
    IElementDescriptor elementDescriptor,
    string selectorFilter,
    [bool checkRootVisibility],
    [bool recursive],
    [double timeout])
elementDescriptor IElementDescriptor
The element from which you want to retrieve children elements, identified by a descriptor of a UI element from Object Repository.
selectorFilter String
The name of the selector filter.
checkRootVisibility Boolean
If true, checks the root visibility for all the children.
recursive Boolean
If true, performs a recursive search for all the children.
Timeout Double
Timeout (in seconds).

GetChildren(String, String, Boolean, Boolean, Double)

Retrieves the children of a specified target, identified by a string from Object Repository, while specifying the name of the selector filter, the timeout, if you want to perform a recursive search or to check the root visibility.

GetChildren(
    string target,
    string selectorFilter,
    [bool checkRootVisibility],
    [bool recursive],
    [double timeout])GetChildren(
    string target,
    string selectorFilter,
    [bool checkRootVisibility],
    [bool recursive],
    [double timeout])
target String
The target element from which you want to retrieve children elements, identified by a string from Object Repository.
selectorFilter String
The name of the selector filter.
checkRootVisibility Boolean
If true, checks the root visibility for all the children.
recursive Boolean
If true, performs a recursive search for all the children.
Timeout Double
Timeout (in seconds).

Return value

IEnumerable

The children elements of the specified target, one at a time.

Was this page helpful?

Get The Help You Need
Learning RPA - Automation Courses
UiPath Community Forum
Uipath Logo White
Trust and Security
© 2005-2024 UiPath. All rights reserved.