MindManager Macros Masterclass Key

object model classes

The basic classes in the MindManager Object Model.

This is a very incomplete set but illustrates how the Object Model is built up hierarchically.

The Index task pane shows the attributes and object types.

©2015 Harport Consulting. All Rights Reserved.

1 Application.....................................................................................................................................3
1.1 AllDocuments()..................................................................................................................3
1.1.1 Document....................................................................................................................3
1.1.1.1 Name.........................................................................................................................3
1.1.1.2 CentralTopic.........................................................................................................3
1.1.1.3 AllFloatingTopics()................................................................................................3
1.1.1.4 Range.........................................................................................................................4
1.1.1.4.1 Boundaries()..................................................................................................4
Boundary..................................................................................................................4
CalloutTopics()......................................................................................................4
Relationships()......................................................................................................4
1.1.1.4.2 Relationships()...............................................................................................4
Relationship..............................................................................................................4
End1...........................................................................................................................4
End2...........................................................................................................................4
CalloutTopics()......................................................................................................4
1.1.1.4.3 Topics()..........................................................................................................4
Topic.........................................................................................................................4
ParentTopic..........................................................................................................5
SubTopics()...........................................................................................................5
CalloutTopics()......................................................................................................5
Boundary..............................................................................................................5
Text............................................................................................................................5
Notes.........................................................................................................................5
Task...........................................................................................................................5
Relationships()......................................................................................................5
1.1.1.5 MapMarkerGroups()..................................................................................................5
1.1.1.6 Selection....................................................................................................................6
1.1.1.6.1 PrimaryTopic.................................................................................................6
1.1.1.6.2 PrimaryRelationship......................................................................................6
1.2 ActiveDocument.................................................................................................................6
1.3 Options....................................................................................................................................6
1.4 Ribbon.....................................................................................................................................6
 1.4.1 Tabs()................................................................................................................................6
1.4.1.1 RibbonTab.................................................................................................................6
1.5 TaskPanes().............................................................................................................................6
1.5.1 TaskPane..........................................................................................................................6
1.6 Version....................................................................................................................................6
2 Topic types..........................................................................................................................................7
2.1 Central topic.................................................................................................................................7
2.2 Main topic....................................................................................................................................7
2.3 Floating topic................................................................................................................................7
2.4 Callout topic.................................................................................................................................7
2.5 Regular topics are none of the above...........................................................................................7
3 Collection()..........................................................................................................................................7
3.1 Count............................................................................................................................................7
3.2 Items.............................................................................................................................................7
1 Application
The top-level MindManager application object

1.1 AllDocuments()

A collection of all documents (maps) currently loaded into MindManager. This may include documents that
are not visible but are loaded in the background.

1.1.1 Document

A document object represents a map loaded into MindManager. Maps can be saved to disk or loaded from
disk, or can be created through the API.

1.1.1.1 Name

A document has a short name, which is just the filename, and a long name that includes the path where
it is stored.

If the map has not yet been saved, the short name and long name are the same.

1.1.1.2 CentralTopic...

All maps have one and only one central topic. The central topic object is always pointed out by a
property with a fixed name, so it is always easy to find.

The central topic has certain limits on it; it cannot be deleted, it has no parent topic, no boundary and no
callout topics.

1.1.1.3 AllFloatingTopics()...

The floating topics are the "callout" topics of the central topic. The floating topic collection is always
pointed out by a named property.

1.1.1.4 Range

The "range" property returns collections of other object types.

In theory, the document's floating topic collection could have been accessed as a range with a specific
object sub-type.

1.1.1.4.1 Boundaries()

All the boundary objects in the map

Boundary

A boundary object has properties relating to its style, and can have callout topics.
 CalloutTopics()...

The collection of callout topics attached to this boundary.

Relationships()

The set of connected Relationships that join to this boundary.

1.1.1.4.2 Relationships()
Relationship
End1

Relationships have two ends. The arrowheads and connected objects are properties of each end.

It can be a little complex to work out which way a relationship "points". Relationships associated
with topics may be attached at End 1 or End 2.

End2
CalloutTopics()...

The collection of callout topics attached to this relationship.

1.1.1.4.3 Topics()

The collection of all topics in the document. This includes floating topics, callout topics and the central
topic.

Topic

The topic object is the most-used object in the API. It represents a single topic in a map.

ParentTopic...

A pointer to the parent topic for this topic.

The central topic and floating topics do not have parent topics.

All other topics have one and only one parent topic.

The parent topic of a callout topic is the regular branch topic to which is it attached.

SubTopics()...

The subtopics collection contains all the child topics of this parent.

CalloutTopics()...

The callout topics collection contains all the callout topics attached to this topic.
 The central topic does not have a callout topics collection.

Boundary...

A pointer to the boundary object for this topic, if any.

A topic can have only one boundary.

Text

The topic text

Notes

The topic notes as plain text, RTF or XHTML

Task

Access to task information such as percent complete, priority, resources etc.

Relationships()

The set of connected Relationships that join to this topic.

1.1.1.5 MapMarkerGroups()

The map marker groups belong to a specific document and are not shared between documents.

The same icons and markers can have different meaning in different maps.

1.1.1.6 Selection

The current selection identifies what has been selected in the user interface. Selection normally highlighs
the object with a frame around it.

Selections are not saved with the document but belong to the current session of the application.

1.1.1.6.1 PrimaryTopic...

If one or more topics are selected, the PrimaryTopic object points out the last topic to be selected.

If only one topic is selected, it is automatically the primary topic.

1.1.1.6.2 PrimaryRelationship...

If one or more relationships are selected, the PrimaryRelationship object points out the last one to be
selected.
 1.2 ActiveDocument...

The currently active document (with user focus) is pointed out by a fixed name

1.3 Options

A subset of the options that can be configured through the user interface are available via the API.

These are stored in the system registry and not in the map documents.

1.4 Ribbon

The command ribbon, which contains multiple tabs

1.4.1 Tabs()
1.4.1.1 RibbonTab
1.5 TaskPanes()

The collection of task panes (task info, marker index etc.) that are part of the user interface

1.5.1 TaskPane

An individual task pane, defining things like the tab caption, state and the window that it contains

1.6 Version

The application version number, e.g. "15.1.173"

2 Topic types
Topic types are indicated by a Topic.Type property, and also with specific properties such as
Topic.IsCentralTopic.

2.1 Central topic

Each map has one and only one central topic

2.2 Main topic

Main topics are the children of the central topic

2.3 Floating topic

Floating topics do not have a parent topic but are placed anywhere in the map canvas.
 2.4 Callout topic

Topics that are not hierarchical children of a topic, but have a special graphical format and can be hidden or
viewed separately

2.5 Regular topics are none of the above

If a topic is not the central topic, a main topic, a floating topic or a callout topic, then by elimination it is a
regular topic in the tree, with a parent topic.

3 Collection()
A collection object typically has a count, and a 1-based index of items of the same type.

3.1 Count
3.2 Items