INatAutoGenericDocument

#### Search Results

Search

# INatAutoGenericDocument

This document covers the following topics:

- Purpose

- Properties

- Methods

- Notifications

## Purpose

A currently open generic document window.

## Properties

The following properties are available:

- Parent

- Studio

- DialogID

- PlugInID

- Caption

### Parent

Used to navigate to the parent interface of this interface.

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

### Studio

Used to navigate to the root interface.

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

### DialogID

The dialog ID of the Natural dialog that implements the window. This is the dialog ID that was passed to the `Add` method during creation of the generic document window.

Natural Data Format | Variant Type | Remark
--- | --- | ---
I4 | VT_I4 | Get only

### PlugInID

The ID of the plug-in that created the 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

### Caption

The caption of the document window.

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

## Methods

The following method is available:

- Close

### Close

Closes the generic 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.

## Notifications

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

- `PLUGIN-NOTIFY-ACTIVATE`

- `PLUGIN-NOTIFY-QUERYCLOSE`

- `PLUGIN-NOTIFY-CLOSE`

- `PLUGIN-NOTIFY-SELECTEDOBJECTS`

- `PLUGIN-NOTIFY-FOCUSOBJECT`

- `PLUGIN-NOTIFY-CONTEXTMENU`

- `PLUGIN-NOTIFY-REFRESH`

### On this page

- Purpose
- Properties
- Methods
- Notifications