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

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

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