IVsObjectList2 Interface

Provides information about symbols in a list that is part of an overall organization in the tree view (IVsLiteTree) of the code browsing tools.

Namespace:  Microsoft.VisualStudio.Shell.Interop
Assembly:  Microsoft.VisualStudio.Shell.Interop.8.0 (in Microsoft.VisualStudio.Shell.Interop.8.0.dll)

[InterfaceTypeAttribute()]
[GuidAttribute("E37F46C4-C627-4D88-A091-2992EE33B51D")]
public interface IVsObjectList2

The IVsObjectList2 type exposes the following members.

  NameDescription
Public methodCanDeleteReturns a flag indicating if the given list item can be deleted.
Public methodCanGoToSourceReturns a flag indicating if navigation to the given list item's source is supported.
Public methodCanRenameReturns a flag indicating if the given list item can be renamed.
Public methodCountSourceItemsReturns the hierarchy and the number of ItemIDs corresponding to source files for the given list item.
Public methodDoDeleteAsks the given list item to do the delete operation.
Public methodDoDragDropAsks the given list item to handle a drag-and-drop operation.
Public methodDoRenameAsks the given list item to do the rename operation.
Public methodEnumClipboardFormatsAsks the given list item to enumerate its supported clipboard formats.
Public methodFillDescriptionAsks the list item to provide description text to be used in the object browser.
Public methodFillDescription2Asks the list item to provide description text to be used in the object browser.
Public methodGetBrowseObjectReturns a pointer to the property browse IDispatch for the given list item.
Public methodGetCapabilities2Returns an object list's capabilities.
Public methodGetCategoryField2Returns the value for the specified category for the given list item.
Public methodGetClipboardFormatAsks the given list item to renders a specific clipboard format that it supports.
Public methodGetContextMenuAllows the list to provide a different context menu and IOleCommandTarget for the given list item.
Public methodGetDisplayDataRetrieves data to draw the requested tree list item.
Public methodGetExpandableMethod information not provided. Return E_NOTIMPL.
Public methodGetExpandable3Returns a flag indicating whether the given list item is expandable.
Public methodGetExpandedListExpands a tree list node.
Public methodGetExtendedClipboardVariantAsks the given list item to renders a specific clipboard format as a variant.
Public methodGetFlagsReturns the attributes of the current tree list.
Public methodGetItemCountReturns the number of items in the current tree list.
Public methodGetList2Returns a child IVsObjectList2 for the specified category.
Public methodGetListChangesReturns changes that have occurred in a tree list. For future use only.
Public methodGetMultipleSourceItemsReturns the ItemID corresponding to source files for the given list item if more than one.
Public methodGetNavigationInfo2Fills the VSOBNAVIGATIONINFO2 structure for the given list item allowing the list to navigate back to it through LocateNavigationInfo2.
Public methodGetNavInfoReserved for future use.
Public methodGetNavInfoNodeReserved for future use.
Public methodGetPropertyReturns the specified property for the specified list item.
Public methodGetSourceContextReturns a source filename and line number for the given list item.
Public methodGetTextReturns a pointer to the text representations for the requested tree list item.
Public methodGetTipTextReturns a pointer to the tool tip text for the requested tree list item.
Public methodGetUserContextReturns the user context object for the given list item.
Public methodGoToSourceNavigates to the source for the given list item.
Public methodLocateExpandedList
Public methodLocateNavigationInfo2Returns the index of the list item corresponding to the VSOBNAVIGATIONINFO2 structure.
Public methodLocateNavInfoNodeReserved for future use.
Public methodOnCloseNotifies the current tree list that it is being closed.
Public methodQueryDragDropReturns a flag indicating whether the given list item supports a drag-and-drop operation.
Public methodShowHelpAllows the list to display help for the given list item.
Public methodToggleStateTells the requested tree item to toggle its checked state if it has check boxes.
Public methodUpdateCounterReturns the current change counter for the tree list, and is used to indicate that the list contents have changed.
Top

This interface is an extension of IVsLiteTreeList and provides additional methods that are pertinent to symbols in the project.

Notes to Implementers

Implemented by libraries to participate in the code browsing tools. The IVsLiteTreeList interface and IVsLibrary2 interface must also be implemented with the IVsObjectList2 interface.

NoteNote

Managed code implementations should implement the IVsSimpleObjectList2 interface instead to avoid memory leaks. This also requires implementing the IVsSimpleLibrary2 interface instead of the IVsLibrary2 interface.

Notes to Callers

This interface is returned from a call to one of the following methods:

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft