Navigation

API > API/Developer > API/Developer/AutomationDriver > API/Developer/AutomationDriver/By

Overloads

Path(const FString &)

Description

Creates a new element locator that limits its discovered elements to ones matching the specified "path"

Path Example: "#Suite//Piano/Key//"

Path Syntax:

Suite = # represents that the following text is an explicit Id, in the case of a SWidget it needs to be tagged with the driver Id metadata Piano = plain text represents general tags, in the case of a SWidget it needs to have a Tag or TagMetadata with the appropriate plain text value = <> represents types, in the case of a SWidget it should be the explicit type used in the SNew construction

Hierarchy is represented by forward slashes

/ = a single forward slash represents that the next value must match a direct child of the element matched before it // = a double forward slash represents that the next value must match any descendant of the element matched before it

Reference the AutomationDriver.spec.cpp expectations for additional examples of the syntax in use

static TSharedRef< IElementLocator , ESPMode::ThreadSafe > Path  
(  
    const FString & Value  
)  
Copy full snippet

static TSharedRef< IElementLocator , ESPMode::ThreadSafe > Path (     const FString & Value )

a locator which uses the specified path to discover appropriate elements

Parameters

Path(const FName &)

Description

Creates a new element locator that limits its discovered elements to ones matching the specified "path"

Path Example: "#Suite//Piano/Key//"

Path Syntax:

Suite = # represents that the following text is an explicit Id, in the case of a SWidget it needs to be tagged with the driver Id metadata Piano = plain text represents general tags, in the case of a SWidget it needs to have a Tag or TagMetadata with the appropriate plain text value = <> represents types, in the case of a SWidget it should be the explicit type used in the SNew construction

Hierarchy is represented by forward slashes

/ = a single forward slash represents that the next value must match a direct child of the element matched before it // = a double forward slash represents that the next value must match any descendant of the element matched before it

Reference the AutomationDriver.spec.cpp expectations for additional examples of the syntax in use

static TSharedRef< IElementLocator , ESPMode::ThreadSafe > Path  
(  
    const FName & Value  
)  
Copy full snippet

static TSharedRef< IElementLocator , ESPMode::ThreadSafe > Path (     const FName & Value )

a locator which uses the specified path to discover appropriate elements

Parameters

Path(const TCHAR *)

Description

Creates a new element locator that limits its discovered elements to ones matching the specified "path"

Path Example: "#Suite//Piano/Key//"

Path Syntax:

Suite = # represents that the following text is an explicit Id, in the case of a SWidget it needs to be tagged with the driver Id metadata Piano = plain text represents general tags, in the case of a SWidget it needs to have a Tag or TagMetadata with the appropriate plain text value = <> represents types, in the case of a SWidget it should be the explicit type used in the SNew construction

Hierarchy is represented by forward slashes

/ = a single forward slash represents that the next value must match a direct child of the element matched before it // = a double forward slash represents that the next value must match any descendant of the element matched before it

Reference the AutomationDriver.spec.cpp expectations for additional examples of the syntax in use

static TSharedRef< IElementLocator , ESPMode::ThreadSafe > Path  
(  
    const TCHAR * Value  
)  
Copy full snippet

static TSharedRef< IElementLocator , ESPMode::ThreadSafe > Path (     const TCHAR * Value )

a locator which uses the specified path to discover appropriate elements

Parameters

Path(const char *)

Description

Creates a new element locator that limits its discovered elements to ones matching the specified "path"

Path Example: "#Suite//Piano/Key//"

Path Syntax:

Suite = # represents that the following text is an explicit Id, in the case of a SWidget it needs to be tagged with the driver Id metadata Piano = plain text represents general tags, in the case of a SWidget it needs to have a Tag or TagMetadata with the appropriate plain text value = <> represents types, in the case of a SWidget it should be the explicit type used in the SNew construction

Hierarchy is represented by forward slashes

/ = a single forward slash represents that the next value must match a direct child of the element matched before it // = a double forward slash represents that the next value must match any descendant of the element matched before it

Reference the AutomationDriver.spec.cpp expectations for additional examples of the syntax in use

static TSharedRef< IElementLocator , ESPMode::ThreadSafe > Path  
(  
    const char * Value  
)  
Copy full snippet

static TSharedRef< IElementLocator , ESPMode::ThreadSafe > Path (     const char * Value )

a locator which uses the specified path to discover appropriate elements

Parameters

Path(const FDriverElementRef &, const FString &)

Description

Creates a new element locator that limits its discovered elements to ones matching the specified "path", starting from the Root element given to the function

Path Example: "#Suite//Piano/Key//"

Path Syntax:

Suite = # represents that the following text is an explicit Id, in the case of a SWidget it needs to be tagged with the driver Id metadata Piano = plain text represents general tags, in the case of a SWidget it needs to have a Tag or TagMetadata with the appropriate plain text value = <> represents types, in the case of a SWidget it should be the explicit type used in the SNew construction

Hierarchy is represented by forward slashes

/ = a single forward slash represents that the next value must match a direct child of the element matched before it // = a double forward slash represents that the next value must match any descendant of the element matched before it

Reference the AutomationDriver.spec.cpp expectations for additional examples of the syntax in use

static TSharedRef< IElementLocator , ESPMode::ThreadSafe > Path  
(  
    const FDriverElementRef & Root,  
    const FString & Value  
)  
Copy full snippet

static TSharedRef< IElementLocator , ESPMode::ThreadSafe > Path (     const FDriverElementRef & Root,     const FString & Value )

a locator which uses the specified path to discover appropriate elements

Parameters

Path(const FDriverElementRef &, const FName &)

Description

Creates a new element locator that limits its discovered elements to ones matching the specified "path", starting from the Root element given to the function

Path Example: "#Suite//Piano/Key//"

Path Syntax:

Suite = # represents that the following text is an explicit Id, in the case of a SWidget it needs to be tagged with the driver Id metadata Piano = plain text represents general tags, in the case of a SWidget it needs to have a Tag or TagMetadata with the appropriate plain text value = <> represents types, in the case of a SWidget it should be the explicit type used in the SNew construction

Hierarchy is represented by forward slashes

/ = a single forward slash represents that the next value must match a direct child of the element matched before it // = a double forward slash represents that the next value must match any descendant of the element matched before it

Reference the AutomationDriver.spec.cpp expectations for additional examples of the syntax in use

static TSharedRef< IElementLocator , ESPMode::ThreadSafe > Path  
(  
    const FDriverElementRef & Root,  
    const FName & Value  
)  
Copy full snippet

static TSharedRef< IElementLocator , ESPMode::ThreadSafe > Path (     const FDriverElementRef & Root,     const FName & Value )

a locator which uses the specified path to discover appropriate elements

Parameters

Path(const FDriverElementRef &, const TCHAR *)

Description

Creates a new element locator that limits its discovered elements to ones matching the specified "path", starting from the Root element given to the function

Path Example: "#Suite//Piano/Key//"

Path Syntax:

Suite = # represents that the following text is an explicit Id, in the case of a SWidget it needs to be tagged with the driver Id metadata Piano = plain text represents general tags, in the case of a SWidget it needs to have a Tag or TagMetadata with the appropriate plain text value = <> represents types, in the case of a SWidget it should be the explicit type used in the SNew construction

Hierarchy is represented by forward slashes

/ = a single forward slash represents that the next value must match a direct child of the element matched before it // = a double forward slash represents that the next value must match any descendant of the element matched before it

Reference the AutomationDriver.spec.cpp expectations for additional examples of the syntax in use

static TSharedRef< IElementLocator , ESPMode::ThreadSafe > Path  
(  
    const FDriverElementRef & Root,  
    const TCHAR * Value  
)  
Copy full snippet

static TSharedRef< IElementLocator , ESPMode::ThreadSafe > Path (     const FDriverElementRef & Root,     const TCHAR * Value )

a locator which uses the specified path to discover appropriate elements

Parameters

Path(const FDriverElementRef &, const char *)

Description

Creates a new element locator that limits its discovered elements to ones matching the specified "path", starting from the Root element given to the function

Path Example: "#Suite//Piano/Key//"

Path Syntax:

Suite = # represents that the following text is an explicit Id, in the case of a SWidget it needs to be tagged with the driver Id metadata Piano = plain text represents general tags, in the case of a SWidget it needs to have a Tag or TagMetadata with the appropriate plain text value = <> represents types, in the case of a SWidget it should be the explicit type used in the SNew construction

Hierarchy is represented by forward slashes

/ = a single forward slash represents that the next value must match a direct child of the element matched before it // = a double forward slash represents that the next value must match any descendant of the element matched before it

Reference the AutomationDriver.spec.cpp expectations for additional examples of the syntax in use

static TSharedRef< IElementLocator , ESPMode::ThreadSafe > Path  
(  
    const FDriverElementRef & Root,  
    const char * Value  
)  
Copy full snippet

static TSharedRef< IElementLocator , ESPMode::ThreadSafe > Path (     const FDriverElementRef & Root,     const char * Value )

a locator which uses the specified path to discover appropriate elements

Parameters