INatAutoObjectTree

#### Search Results

Search

# INatAutoObjectTree

This document covers the following topics:

- Purpose

- Properties

- Methods

- Notifications

## Purpose

An open tree view document window.

## Properties

The following properties are available:

- Parent

- Studio

- Profile

- PlugInID

### Parent

Used to navigate to the parent interface of this interface.

Natural Data Format | Variant Type | Remark
--- | --- | ---
HANDLE OF OBJECT | VT_DISPATCH (INatAutoObjectTrees) | Get only

### Studio

Used to navigate to the root interface.

Natural Data Format | Variant Type | Remark
--- | --- | ---
HANDLE OF OBJECT | VT_DISPATCH (INatAutoStudio) | Get only

### Profile

A string containing an XML document that describes the behavior of this tree view document window. If the profile of a tree view is modified, the new settings apply from that time on. The already visible part of the tree is not redrawn according to the new profile settings. The XML document is structured according to the following DTD:

    <!ELEMENT TreeViewProfile (Recursion?)>
    <!ELEMENT Recursion (Detect?, Mark?, Expand?)>
    <!ELEMENT Detect (#PCDATA)>
    <!ELEMENT Mark   (#PCDATA)>
    <!ELEMENT Expand (#PCDATA)>

Element | Meaning
--- | ---
Detect |
Not specified or 0 | Recursion is detected by comparing type and key of two nodes.
1 | Recursion is detected by comparing only the key of two nodes.
2 | Recursion is detected by comparing type, key and info of two nodes.
Mark |
Not specified | Recursive nodes are not marked.
Specified | Recursive nodes are marked with the specified string.
Expand |
Not specified or 0 | Recursive nodes cannot be further expanded.
1 | Recursive nodes can be further expanded only manually. They stay unexpanded during Expand All.
2 | Recursive nodes are further expanded even during Expand All. In this case the expansion can only be stopped with the ESC key.

### PlugInID

The ID of the plug-in that created the tree view document window. A plug-in can use this property to iterate only across its own document windows.

Natural Data Format | Variant Type | Remark
--- | --- | ---
A | VT_BSTR | Get only

## Methods

The following methods are available:

- Close

- Cancel

- GetRootNode

- GetSelectedNode

### Close

Closes the tree view document window. This method is executed asynchronously. In particular, this means that if it is called from within the method `OnCommand` of a plug-in, the window will only really be closed after the method `OnCommand` has terminated.

### Cancel

Cancels an Expand All operation. This method has the same effect as pressing the ESC key.

### GetRootNode

Returns the root node of this MDI tree view.

#### Parameters

Name | Natural Data Format | Variant Type | Remark
--- | --- | --- | ---
Return value | HANDLE OF OBJECT | VT_DISPATCH (INatAutoObjectTreeNode) |

> Return value

>   The root node of this MDI tree view.

### GetSelectedNode

Returns the node currently selected in this MDI tree view.

#### Parameters

Name | Natural Data Format | Variant Type | Remark
--- | --- | --- | ---
Return value | HANDLE OF OBJECT | VT_DISPATCH (INatAutoObjectTreeNode) |

> Return value

>   The node currently selected in this MDI tree view.

## Notifications

A plug-in that has created a list view document window can expect to receive the following notifications through its method `OnNotify`:

- `PLUGIN-NOTIFY-ACTIVATE`

- `PLUGIN-NOTIFY-CLOSE`

- `PLUGIN-NOTIFY-EXPANDALL`

- `PLUGIN-NOTIFY-REFRESH`

- `PLUGIN-NOTIFY-HELP`

### On this page

- Purpose
- Properties
- Methods
- Notifications