Tutorial

Last updated on: September 02, 2024
Also available as a single HTML file

Onetastic Macro Documentation > Functions > Object Functions > GetAncestorOfType

GetAncestorOfType

Returns true if the given object has an ancestor of given type and stores that ancestor in the ancestor parameter.

Syntax

Bool GetAncestorOfType(
	Object object, 
	ObjectType type, 
	out Object ancestor)

Parameters

Object object: Object to look for an ancestor of.
ObjectType type: Type of the ancestor to look for.
out Object ancestor: If an ancestor is found, it is stored in this parameter. Check the return value of the function to know whether an ancestor was found or not.

Examples

// Find the first image on the current page $image = QueryObjects("Image", GetCurrentPage()) // Check if this image lives inside a table or not if (GetAncestorOfType($image, "Table", $tableAncestor)) // This image is in a table, do something here with $tableAncestor else // This image is not in a table