IVsToolboxClipboardCycler Interface

 

Provides support for the clipboard ring to document windows and tool windows.

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

[InterfaceTypeAttribute(1)]
[GuidAttribute("6A2A1D82-C590-4AB1-8CC2-D95BACBBA9E0")]
public interface IVsToolboxClipboardCycler

NameDescription
System_CAPS_pubmethodAreDataObjectsAvailable(IVsToolboxUser, Int32)

Determines whether any items are available to preview in the clipboard ring.

System_CAPS_pubmethodBeginCycle()

Forces the clipboard cycle to start at the top of the list.

System_CAPS_pubmethodGetAndSelectNextDataObject(IVsToolboxUser, IDataObject)

Gets the next data object for the target Toolbox user's clipboard ring.

Users can press CTRL+SHIFT+V to cycle through the contents of the clipboard. To know when to implement clipboard support CMDIDPasteNextTBXCBItem in your IOleCommandTarget implementation.

When managing the clipboard ring for the toolbox, call the methods of IVsToolboxClipboardCycler in the following order:

  • AreDataObjectsAvailableCall this method first to determine whether there are any clipboard objects to cycle through. If there are no items on the Toolbox clipboard, then the environment checks the system clipboard to see if there are any items on it. If there are items on the system clipboard, but not on the Toolbox clipboard, then the clipboard ring is populated with system items.

  • BeginCycleCall this method to start the clipboard cycle with the first item in the list, rather than the last active clipboard item.

  • GetAndSelectNextDataObject

Call this method to select the next item in the list.

Notes to Implementers:

Implemented by the environment.

Notes to Callers:

Called by a document window or tool window that wants to support clipboard cycling.

Return to top
Show: