IVsSimpleObjectList2 Interface

  • Article

A simplified version of the IVsObjectList2 interface.

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

Syntax

'Declaration
<GuidAttribute("A0C6D693-8226-4CA6-AB03-557AA5A33F75")> _
<InterfaceTypeAttribute()> _
Public Interface IVsSimpleObjectList2

[GuidAttribute("A0C6D693-8226-4CA6-AB03-557AA5A33F75")]
[InterfaceTypeAttribute()]
public interface IVsSimpleObjectList2

[GuidAttribute(L"A0C6D693-8226-4CA6-AB03-557AA5A33F75")]
[InterfaceTypeAttribute()]
public interface class IVsSimpleObjectList2

[<GuidAttribute("A0C6D693-8226-4CA6-AB03-557AA5A33F75")>]
[<InterfaceTypeAttribute()>]
type IVsSimpleObjectList2 =  interface end

public interface IVsSimpleObjectList2

The IVsSimpleObjectList2 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 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 GetExpandable3 Returns a flag indicating whether the given list item is expandable.
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 IVsSimpleObjectList2 for the specified category.
Public method GetMultipleSourceItems Returns the ItemID corresponding to source files for the given list item if more than one.
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 GetSourceContextWithOwnership Returns a source filename and line number for the given list item.
Public method GetTextWithOwnership Returns the text representations for the requested tree list item.
Public method GetTipTextWithOwnership Returns 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 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 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. This version of the IVsObjectList2 interface should be implemented in managed code.

Notes to Implementers

This interface should be implemented in managed code to avoid potential memory leaks when returning text from the GetTextWithOwnership method, ToolTip text from the GetTipTextWithOwnership method, and a source context from the GetSourceContextWithOwnership methods. The IVsLiteTreeList and IVsSimpleLibrary2 interfaces must also be implemented with the IVsSimpleObjectList2 interface.

Notes to Callers

This interface is returned by a call to the GetList2 method in the IVsSimpleLibrary2 interface.

See Also

Reference

Microsoft.VisualStudio.Shell.Interop Namespace