Tutorial

Getting Started with Macros

Macro Editor

User Interface

Menus and Toolbar

Editing Macro Statements

Expression Editor

Macro Debugging

How To

Using variables

Finding and modifying objects

Creating new page content

Asking for user input

Storing persistent data

Sorting objects

Sample Macros

Concepts

Expressions

Objects

Properties

Variables

Data Types

Arrays

Functions

Literals

Operators

Comments

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

Reference

Statements

ForEach

If

Else

While

Expression

Comment

Break

Continue

Return

Hierarchy Objects

NotebookRoot

Notebook

SectionGroup

Section

Page

Page Objects

Title

Outline

Table

Column

Row

Cell

Paragraph

Text

Image

EmbeddedFile

Tag

Other Objects

DialogBox

Functions

Array Functions

Data Store Functions

Date/Time Functions

Dialog Box Functions

Macro Execution Functions

Object Functions

String Functions