IVsPreviewChangesList Interface

Definition

Namespace:

Microsoft.VisualStudio.Shell.Interop

Assembly:

Microsoft.VisualStudio.Interop.dll

Package:

Microsoft.VisualStudio.Interop v17.12.40391

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

public interface class IVsPreviewChangesList

public interface class IVsPreviewChangesList

__interface IVsPreviewChangesList

[System.Runtime.InteropServices.Guid("B334F714-993B-4902-89E0-792213B538DB")]
[System.Runtime.InteropServices.InterfaceType(1)]
public interface IVsPreviewChangesList

[<System.Runtime.InteropServices.Guid("B334F714-993B-4902-89E0-792213B538DB")>]
[<System.Runtime.InteropServices.InterfaceType(1)>]
type IVsPreviewChangesList = interface

Public Interface IVsPreviewChangesList

Attributes

GuidAttribute InterfaceTypeAttribute

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(UInt32, Int32, IVsLiteTreeList) method in the IVsObjectList2 interface.

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, IVsLiteTreeList)	Returns the child list of the specified item that has been expanded in the tree view.
GetFlags(UInt32)	Returns a set of flags the describes the preview list.
GetItemCount(UInt32)	Returns the number of items in the preview list.
GetListChanges(UInt32, VSTREELISTITEMCHANGE[])	Returns a list of changes made to the items in the preview list.
GetText(UInt32, VSTREETEXTOPTIONS, String)	Returns the specified text for the specified item in the preview list.
GetTipText(UInt32, VSTREETOOLTIPTYPE, String)	Returns the ToolTip text for the specified item in the preview list.
LocateExpandedList(IVsLiteTreeList, 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.
UpdateCounter(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.