INatAutoResultViews

This document covers the following topics:

Purpose

Collection of the currently open result views.

Properties

The following properties are available:

Parent

Used to navigate to the parent interface of this interface.

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

Studio

Used to navigate to the root interface.

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

Count

The number of currently open result views.

Natural Data Format Variant Type Remark
I4 VT_I4 Get only

Methods

The following methods are available:

Item

Returns a specific plug-in defined result view from the collection.

Parameters

Name Natural Data Format Variant Type Remark
Return value HANDLE OF OBJECT VT_DISPATCH (INatAutoResultView)  
Index I4 VT_I4  
Return value

The result view identified by the value specified in Index. If the result view was not defined by a plug-in, the method returns NULL-HANDLE.

Index

The index of the result view in the collection (a value between 1 and Count).

Show

Shows or hides the entire result view control bar. This corresponds to checking or unchecking the View/Results command in the Natural Studio menu.

Parameters

Name Natural Data Format Variant Type Remark
Show L VT_BOOL Optional
Show

Decides if the result view control bar is shown or not. The default is TRUE.

Open

Opens a new result view.

Parameters

Name Natural Data Format Variant Type Remark
Return value HANDLE OF OBJECT VT_DISPATCH (INatAutoResultView)  
Caption A VT_BSTR  
Image

A
HANDLE OF OBJECT

VT_BSTR
VT_DISPATCH

Optional
Headers A VT_BSTR Optional
Return value

The newly opened result view.

Caption

The caption to be displayed on the result view tab.

Image

An image to be displayed on the result view tab. The image must be a 16 color, 16x16 bitmap, using RGB(192,192,192) as the background color.

The image can be specified in two ways:

  • As an absolute path name of a .bmp file.

  • As an IPictureDisp interface. An IPictureDisp interface can be created in Natural using the method INatAutoImages::LoadImage. An IPictureDisp interface cannot be passed across process boundaries. This is due to a Microsoft restriction (MSDN Q150034). Therefore this alternative can only be used with plug-ins running as in-process servers. Natural written plug-ins always run as local servers and can therefore not use this alternative.

Headers

Defines the attributes of the nodes to be displayed in the result view and their respective captions. It contains the attribute definitions as an XML document according to the DTD used with the method INaturalStudioPlugInTree::GetAttributes.