Result View Pane

[This is preliminary documentation and subject to change.]

Positioned on the right side of the snap-in's windowing frame, the result view pane presents the data within the selected node shown in the scope pane. If the scope pane item is a container, and the result pane is a view that supports enumeration, the result pane displays an enumeration of those contained items. This enumeration is accomplished by a call to IComponent::Notify. All the methods belonging to this interface are summarized in Implementing the IComponent interface.

It is also common to display a custom view in the result pane. In some cases, the selected scope pane node displays a result pane view that is not a standard enumerated view of its children. These nodes are known as viewable containers. If the selected scope pane item is a viewable object, the result pane will be a rendered view of that object. An example of a viewable container is a node that has an OCX or a Web page as its result pane view. Furthermore, the same scope node can take on many views by extending the view context menu. This allows the snap-in to display results in different forms.

Many of the features associated with the result view pane are provided by the console's node manager through interfaces that it implements. For example, IResultData allows a user to manipulate items and the view style associated with the standard result view pane. IResultData methods include InsertItem and DeleteItem, which are used by snap-ins to insert or delete single items in the result view pane, DeleteAllRsltItems allows deletion of all items in the pane. Snap-ins can find items or subitems by using FindItemByLParam. Single items can be set or retrieved using SetItem and GetItem and the next item can be retrieved by using GetNextItem. The view mode can be set or retrieved by using SetViewMode and GetViewMode. The state of a particular item can be modified with ModifyItemState and the result pane's view style can be set with ModifyViewStyle. You can sort all items in the result view pane with Sort and, after changing an item being displayed, the user can update the item using UpdateItem. The text for the result view's description bar can be set by using SetDescBarText.

IHeaderCtrl methods manipulate the number of columns and their text label for the result view pane. With InsertColumn, you can add a column to a default result view; with DeleteColumn you can remove one. You can set the width of a column with SetColumnWidth and retrieve the current width with GetColumnWidth. The SetColumnText method is available to set text in a specified column, and GetColumnText to retrieve current text.

With the IImageList interface, the user can insert images to be used as icons for items in the result view pane. You can use ImageListSetIcon to set an icon in an image list or ImageListSetStrip to set a strip of icons in an image list.

The RESULTDATAITEM structure is used frequently to accomplish much of the work associated with the result view pane.