This document covers the following topics:
Collection of the currently open result views.
The following properties are available:
Used to navigate to the parent interface of this interface.
Natural Data Format | Variant Type | Remark |
---|---|---|
HANDLE OF OBJECT | VT_DISPATCH (INatAutoStudio) | Get only |
Used to navigate to the root interface.
Natural Data Format | Variant Type | Remark |
---|---|---|
HANDLE OF OBJECT | VT_DISPATCH (INatAutoStudio) | Get only |
The number of currently open result views.
Natural Data Format | Variant Type | Remark |
---|---|---|
I4 | VT_I4 | Get only |
The following methods are available:
Returns a specific plug-in defined result view from the collection.
Name | Natural Data Format | Variant Type | Remark |
---|---|---|---|
Return value | HANDLE OF OBJECT | VT_DISPATCH (INatAutoResultView) | |
Index | I4 | VT_I4 |
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.
The index of the result view in the collection (a value between 1 and Count).
Shows or hides the entire result view control bar. This corresponds to checking or unchecking the View/Results command in the Natural Studio menu.
Name | Natural Data Format | Variant Type | Remark |
---|---|---|---|
Show | L | VT_BOOL | Optional |
Decides if the result view control bar is shown or not. The default is TRUE.
Opens a new result view.
Name | Natural Data Format | Variant Type | Remark |
---|---|---|---|
Return value | HANDLE OF OBJECT | VT_DISPATCH (INatAutoResultView) | |
Caption | A | VT_BSTR | |
Image |
A |
VT_BSTR |
Optional |
Headers | A | VT_BSTR | Optional |
The newly opened result view.
The caption to be displayed on the result view tab.
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.
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
.