INatAutoResultView

This document covers the following topics:

Purpose

An open result view.

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 (INatAutoResultViews) Get only

Studio

Used to navigate to the root interface.

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

Active

Indicates if this result view is currently the active one or not. Setting Active to TRUE makes the result view the active one. Setting Active to FALSE has no effect.

Natural Data Format Variant Type Remark
L VT_BOOL  

Methods

The following methods are available:

InsertRows

Inserts a number of rows at the end of the result view. Each row is displayed in the result view as a node with attributes. Before referring to a node type in this method, the plug-in must have registered the node type through the interface INatAutoNodeTypes.

To avoid flickering, the result view is not redrawn after each call to InsertRows. After a series of calls to InsertRows the method Update should be called to redraw the result view.

Parameters

Name Natural Data Format Variant Type Remark
Return value I4 VT_I4)  
Rows A VT_BSTR  
Return value

The number of rows contained in the result view after the insertion.

Rows

Contains an XML document that describes the rows to be inserted. The XML document is structured according to the following DTD. 

<!ELEMENT rows (row*)>
<!ELEMENT row (pitem, attributevalues?)>
<!ELEMENT pitem	(pguid?, ptype, pkey, pinfo?, pname?, (ntype, nkey)?)>
<!ELEMENT pguid (#PCDATA)>
<!ELEMENT ptype	(#PCDATA)>
<!ELEMENT pkey  (#PCDATA)>
<!ELEMENT pinfo	(#PCDATA)>
<!ELEMENT pname	(#PCDATA)>
<!ELEMENT ntype	(#PCDATA)>
<!ELEMENT nkey 	(#PCDATA)>
<!ELEMENT attributevalues (attval*)>
<!ELEMENT attval     (akey, avalue)>
<!ELEMENT akey 	(#PCDATA)>
<!ELEMENT avalue     (#PCDATA)>
Element Meaning
pctype The type of the node to be inserted.
pkey The key that identifies the node within its type.
pguid Needs not to be filled if the node type has been defined by the plug-in itself. It is used to refer to node types of other plug-ins, if these are known.
pinfo Additional information about the node that the plug-in wants to receive back whenever Natural Studio later refers to the node. Natural Studio never considers the content of this element, put just passes it back and forth.
pname The text to be displayed with the node.
ntype If the node has been defined by a plug-in, but corresponds to a node of a predefined Natural Studio type, this element contains the type of the corresponding predefined node.
nkey If the node has been defined by a plug-in, but corresponds to a node of a predefined Natural node type, this element contains the key of the corresponding predefined node.
attributevalues The attribute values to be displayed with the node. These are specified as an XML document according to the DTD used with the method INaturalStudioPlugInTree::GetAttributeValues.

Update

To avoid flickering, the result view is not redrawn after each call to InsertRows. After a series of calls to InsertRows the method Update should be called to redraw the result view.

SetVisible

Makes the specified row visible and scrolls the result view if necessary.

Parameters

Name Natural Data Format Variant Type Remark
Row I4 VT_I4  
Row

Contains the number of the row to be scrolled into view. To position to the last inserted row, use the row number that was returned from the method InsertRows.

Clear

Removes all rows from the result view.

Close

Closes the result view.