ApiSessionSimpleFindObjects Method (UInt64, String, TextFilterRelation, SearchTextIn, Boolean)

public List<ObjectProxy> SimpleFindObjects(
	ulong aSearchRoot,
	string aTextToSearch,
	TextFilterRelation aRelation,
	SearchTextIn aWhereToSearch,
	bool aCaseSensitive
)

Parameters

aSearchRoot

Type: SystemUInt64
The ID of the container object to start the search on. Only children of this object and their children are searched. If you want to start at the very top and search the entire project, then use GetProjectRoot.

aTextToSearch

Type: SystemString
The text to search for (or the regex pattern used to search).

aRelation

Type: Articy.ApiTextFilterRelation
This is the compare operator for the search text. The TextFilterRelation enumeration contains many operators like Contains, BeginsWith, HasValue and more.

aWhereToSearch

Type: Articy.ApiSearchTextIn
A flag enum where you can specify with properties should be included in the search.

aCaseSensitive

Type: SystemBoolean
true if the search should be case sensitive, false otherwise.

Return Value

Reference