IVsLiteTreeList Interface

Definition

Namespace:

Microsoft.VisualStudio.Shell.Interop

Assembly:

Microsoft.VisualStudio.Interop.dll

Package:

Microsoft.VisualStudio.Interop v17.12.40391

Provides information about symbols in a list that is part of an overall organization in the tree view (IVsLiteTree) of the code browsing tools. A list is the basic unit of information with which the libraries communicate with the tools and is displayed as a set of peer nodes of a specific parent in the tree view.

public interface class IVsLiteTreeList

public interface class IVsLiteTreeList

__interface IVsLiteTreeList

[System.Runtime.InteropServices.ComConversionLoss]
[System.Runtime.InteropServices.Guid("1E425321-94CB-448E-8E1E-E1EA2479E5E2")]
[System.Runtime.InteropServices.InterfaceType(System.Runtime.InteropServices.ComInterfaceType.InterfaceIsIUnknown)]
public interface IVsLiteTreeList

[<System.Runtime.InteropServices.ComConversionLoss>]
[<System.Runtime.InteropServices.Guid("1E425321-94CB-448E-8E1E-E1EA2479E5E2")>]
[<System.Runtime.InteropServices.InterfaceType(System.Runtime.InteropServices.ComInterfaceType.InterfaceIsIUnknown)>]
type IVsLiteTreeList = interface

Public Interface IVsLiteTreeList

Derived

Microsoft.VisualStudio.Shell.Interop.IVsObjectList

Attributes

ComConversionLossAttribute GuidAttribute InterfaceTypeAttribute

Remarks

IVsObjectList and its base interface IVsLiteTreeList are used to organize symbols into lists whose item indices range from 0 to CountOfItems –1. Most of the methods on these interfaces operate on a single index at a time, which is passed in as the first parameter to the method. The special value NULINDEX is used to denote the entire list and no item in particular.

The tree view is simply a collection of IVsLiteTreeList implementations at various levels. Every node in the tree view is an item in an IVsLiteTreeList and it, in turn, can have zero or more children lists.

See illustrations of the implementation and/or calling of this interface in the sample My C Package.

Notes to Implementers

Implemented by libraries to participate in the code browsing tools.

Notes to Callers

Called by the code browsing tools to obtain information about a set of symbols in accordance with the parameters specified through GetList(UInt32, UInt32, VSOBSEARCHCRITERIA[], IVsObjectList) or GetList(UInt32, UInt32, UInt32, VSOBSEARCHCRITERIA[], IVsObjectList).

Methods

GetDisplayData(UInt32, VSTREEDISPLAYDATA[])	Retrieves data to draw the requested tree list item.
GetExpandable(UInt32, Int32)	Specifies whether an item is expandable.
GetExpandedList(UInt32, Int32, IVsLiteTreeList)	Expands a tree list node.
GetFlags(UInt32)	Returns the attributes of the current tree list.
GetItemCount(UInt32)	Returns the number of items in the current tree list.
GetListChanges(UInt32, VSTREELISTITEMCHANGE[])	Returns changes that have occurred in a tree list.
GetText(UInt32, VSTREETEXTOPTIONS, String)	Returns a pointer to the text representations for the requested tree list item.
GetTipText(UInt32, VSTREETOOLTIPTYPE, String)	Returns a pointer to the tool tip text for the requested tree list item.
LocateExpandedList(IVsLiteTreeList, UInt32)	Returns a pointer to an index number of the specified tree list
OnClose(VSTREECLOSEACTIONS[])	Notifies the current tree list that it is being closed.
ToggleState(UInt32, UInt32)	Tells the requested tree item to toggle its checked state if it has check boxes.
UpdateCounter(UInt32, UInt32)	Returns the current change counter for the tree list, and is used to indicate that the list contents have changed.