Tutorial

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

Onetastic Macro Documentation > Functions > Object Functions > GetParentOfType

GetParentOfType

Returns true if the given object has a parent of given type and stores that parent in the parent parameter.

Syntax

Bool GetParentOfType(
	Object object, 
	ObjectType type, 
	out Object parent)

Parameters

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

Examples

// Find the first image on the current page $image = QueryObjects("Image", GetCurrentPage()) // Check if this is an image directly on the page or an image inside an outline // An image in an outline has a direct parent of type Paragraph if (GetParentOfType($image, "Paragraph", $parentParagraph)) // Parent is a Paragraph, do something here with $parentParagraph else // Parent is not a Paragraph, the image must be directly under the Page

Tutorial

GetParentOfType

Syntax

Parameters

Examples

See Also

Reference