IVsSimplePreviewChangesList Interface

Definition

Namespace:

Microsoft.VisualStudio.Shell.Interop

Assembly:

Microsoft.VisualStudio.Interop.dll

Package:

Microsoft.VisualStudio.Interop v17.12.40391

This is a simplified version of the IVsPreviewChangesList interface.

public interface class IVsSimplePreviewChangesList

public interface class IVsSimplePreviewChangesList

__interface IVsSimplePreviewChangesList

[System.Runtime.InteropServices.Guid("C42D228E-B275-4FE6-8469-F3184663B883")]
[System.Runtime.InteropServices.InterfaceType(1)]
public interface IVsSimplePreviewChangesList

[<System.Runtime.InteropServices.Guid("C42D228E-B275-4FE6-8469-F3184663B883")>]
[<System.Runtime.InteropServices.InterfaceType(1)>]
type IVsSimplePreviewChangesList = interface

Public Interface IVsSimplePreviewChangesList

Attributes

GuidAttribute InterfaceTypeAttribute

Notes to Implementers

This interface should be implemented in managed code to avoid possible memory leaks when returning text from the GetTextWithOwnership(UInt32, VSTREETEXTOPTIONS, String) and GetTipTextWithOwnership(UInt32, VSTREETOOLTIPTYPE, String) methods. This interface must be implemented along with the IVsLiteTreeList interface.

Notes to Callers

This interface is obtained by calling the QueryInterface method on an IVsLiteTreeList object or by casting the IVsLiteTreeList object to the IVsSimplePreviewChangesList interface.

An IVsSimplePreviewChangesList object is returned by a call to the GetExpandedList(UInt32, Int32, IVsSimplePreviewChangesList) method and is passed to the LocateExpandedList(IVsSimplePreviewChangesList, UInt32) method (in each case, the IVsSimplePreviewChangesList object represents a child list).

An IVsLiteTreeList object can be obtained by a call to the GetList2(UInt32, UInt32, UInt32, VSOBSEARCHCRITERIA2[], IVsSimpleObjectList2) method in the IVsSimpleObjectList2 interface.

This interface is returned explicitly by a call to the GetExpandedList(UInt32, Int32, IVsSimplePreviewChangesList) method (representing a child list).

Methods

GetDisplayData(UInt32, VSTREEDISPLAYDATA[])	Returns display data for the specified item.
GetExpandable(UInt32, Int32)	Determines if the specified item can be expanded.
GetExpandedList(UInt32, Int32, IVsSimplePreviewChangesList)	Returns the child list of the specified item that has been expanded in the tree view.
GetItemCount(UInt32)	Returns the number of items in the preview list.
GetTextWithOwnership(UInt32, VSTREETEXTOPTIONS, String)	Returns the specified text for the specified item in the preview list.
GetTipTextWithOwnership(UInt32, VSTREETOOLTIPTYPE, String)	Returns the ToolTip text for the specified item in the preview list.
LocateExpandedList(IVsSimplePreviewChangesList, UInt32)	Given a child list, locate its parent item in the preview list.
OnClose(VSTREECLOSEACTIONS[])	Called when this preview list is closed (unexpanded).
OnRequestSource(UInt32, Object)	Loads the source for the specified preview item and displays it in the given text view.
ToggleState(UInt32, UInt32)	Toggles the checked state of the specified item in the preview list.