IVsPreviewChangesList Interface


Represents a list of items in the changes tree of the Preview Changes tool window.

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

public interface IVsPreviewChangesList

System_CAPS_pubmethodGetDisplayData(UInt32, VSTREEDISPLAYDATA[])

Returns display data for the specified item.

System_CAPS_pubmethodGetExpandable(UInt32, Int32)

Determines if the specified item can be expanded.

System_CAPS_pubmethodGetExpandedList(UInt32, Int32, IVsLiteTreeList)

Returns the child list of the specified item that has been expanded in the tree view.


Returns a set of flags the describes the preview list.


Returns the number of items in the preview list.

System_CAPS_pubmethodGetListChanges(UInt32, VSTREELISTITEMCHANGE[])

Returns a list of changes made to the items in the preview list.

System_CAPS_pubmethodGetText(UInt32, VSTREETEXTOPTIONS, String)

Returns the specified text for the specified item in the preview list.

System_CAPS_pubmethodGetTipText(UInt32, VSTREETOOLTIPTYPE, String)

Returns the ToolTip text for the specified item in the preview list.

System_CAPS_pubmethodLocateExpandedList(IVsLiteTreeList, UInt32)

Given a child list, locate its parent item in the preview list.


Called when this preview list is closed (unexpanded).

System_CAPS_pubmethodOnRequestSource(UInt32, Object)

Loads the source for the specified preview item and displays it in the given text view.

System_CAPS_pubmethodToggleState(UInt32, UInt32)

Toggles the checked state of the specified item in the preview list.

System_CAPS_pubmethodUpdateCounter(UInt32, UInt32)

Updates the current change counter and returns whether any changes have been made to the preview list and if so, what kind of changes.

Notes to Implementers:

The IVsLiteTreeList interface must also be implemented with this interface.


Managed code implementations should implement the IVsSimplePreviewChangesList interface instead to avoid memory leaks.

Notes to Callers:

This interface is obtained by calling the QueryInterface method on an IVsLiteTreeList object or by casting the IVsLiteTreeList object to the IVsPreviewChangesList interface. An IVsLiteTreeList object can be obtained by a call to the GetExpandedList method in the IVsObjectList2 interface.

Return to top