IVsObjectList2 Interface

  • Article

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)

Syntax

'Declaration
<InterfaceTypeAttribute()> _
<GuidAttribute("E37F46C4-C627-4D88-A091-2992EE33B51D")> _
Public Interface IVsObjectList2

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

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

[<InterfaceTypeAttribute()>]
[<GuidAttribute("E37F46C4-C627-4D88-A091-2992EE33B51D")>]
type IVsObjectList2 =  interface end

public interface IVsObjectList2

The IVsObjectList2 type exposes the following members.

Methods

  Name Description
Public method CanDelete Returns a flag indicating if the given list item can be deleted.
Public method CanGoToSource Returns a flag indicating if navigation to the given list item's source is supported.
Public method CanRename Returns a flag indicating if the given list item can be renamed.
Public method CountSourceItems Returns the hierarchy and the number of ItemIDs corresponding to source files for the given list item.
Public method DoDelete Asks the given list item to do the delete operation.
Public method DoDragDrop Asks the given list item to handle a drag-and-drop operation.
Public method DoRename Asks the given list item to do the rename operation.
Public method EnumClipboardFormats Asks the given list item to enumerate its supported clipboard formats.
Public method FillDescription Asks the list item to provide description text to be used in the object browser.
Public method FillDescription2 Asks the list item to provide description text to be used in the object browser.
Public method GetBrowseObject Returns a pointer to the property browse IDispatch for the given list item.
Public method GetCapabilities2 Returns an object list's capabilities.
Public method GetCategoryField2 Returns the value for the specified category for the given list item.
Public method GetClipboardFormat Asks the given list item to renders a specific clipboard format that it supports.
Public method GetContextMenu Allows the list to provide a different context menu and IOleCommandTarget for the given list item.
Public method GetDisplayData Retrieves data to draw the requested tree list item.
Public method GetExpandable Method information not provided. Return E_NOTIMPL.
Public method GetExpandable3 Returns a flag indicating whether the given list item is expandable.
Public method GetExpandedList Expands a tree list node.
Public method GetExtendedClipboardVariant Asks the given list item to renders a specific clipboard format as a variant.
Public method GetFlags Returns the attributes of the current tree list.
Public method GetItemCount Returns the number of items in the current tree list.
Public method GetList2 Returns a child IVsObjectList2 for the specified category.
Public method GetListChanges Returns changes that have occurred in a tree list. For future use only.
Public method GetMultipleSourceItems Returns the ItemID corresponding to source files for the given list item if more than one.
Public method GetNavigationInfo2 Fills the VSOBNAVIGATIONINFO2 structure for the given list item allowing the list to navigate back to it through LocateNavigationInfo2.
Public method GetNavInfo Reserved for future use.
Public method GetNavInfoNode Reserved for future use.
Public method GetProperty Returns the specified property for the specified list item.
Public method GetSourceContext Returns a source filename and line number for the given list item.
Public method GetText Returns a pointer to the text representations for the requested tree list item.
Public method GetTipText Returns a pointer to the tool tip text for the requested tree list item.
Public method GetUserContext Returns the user context object for the given list item.
Public method GoToSource Navigates to the source for the given list item.
Public method LocateExpandedList
Public method LocateNavigationInfo2 Returns the index of the list item corresponding to the VSOBNAVIGATIONINFO2 structure.
Public method LocateNavInfoNode Reserved for future use.
Public method OnClose Notifies the current tree list that it is being closed.
Public method QueryDragDrop Returns a flag indicating whether the given list item supports a drag-and-drop operation.
Public method ShowHelp Allows the list to display help for the given list item.
Public method ToggleState Tells the requested tree item to toggle its checked state if it has check boxes.
Public method UpdateCounter Returns the current change counter for the tree list, and is used to indicate that the list contents have changed.

Top

Remarks

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.

Note

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:

See Also

Reference

Microsoft.VisualStudio.Shell.Interop Namespace