IVsToolboxClipboardCycler Interface

  • Article

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)

Syntax

'Declaration
<InterfaceTypeAttribute()> _
<GuidAttribute("6A2A1D82-C590-4AB1-8CC2-D95BACBBA9E0")> _
Public Interface IVsToolboxClipboardCycler

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

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

[<InterfaceTypeAttribute()>]
[<GuidAttribute("6A2A1D82-C590-4AB1-8CC2-D95BACBBA9E0")>]
type IVsToolboxClipboardCycler =  interface end

public interface IVsToolboxClipboardCycler

The IVsToolboxClipboardCycler type exposes the following members.

Methods

  Name Description
Public method AreDataObjectsAvailable Determines whether any items are available to preview in the clipboard ring.
Public method BeginCycle Forces the clipboard cycle to start at the top of the list.
Public method GetAndSelectNextDataObject Gets the next data object for the target Toolbox user's clipboard ring.

Top

Remarks

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.

See Also

Reference

Microsoft.VisualStudio.Shell.Interop Namespace