IVsToolboxClipboardCycler.GetAndSelectNextDataObject Method

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

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

int GetAndSelectNextDataObject(
	IVsToolboxUser pTarget,
	out IDataObject ppDO


Type: Microsoft.VisualStudio.Shell.Interop.IVsToolboxUser
[in] Target Toolbox user to cycle through clipboard items.
Type: Microsoft.VisualStudio.OLE.Interop.IDataObject
[out] Pointer to the next data object in the list.

Return Value

Type: System.Int32
If the method succeeds, it returns S_OK. If it fails, it returns an error code.

COM Signature

From vsshell.idl:

HRESULT IVsToolboxClipboardCycler::GetAndSelectNextDataObject(
   [in] IVsToolboxUser *pTarget,
   [out] IDataObject **ppDO

This method requires you to specify an IVsToolboxUser and does not assume that the IVsToolboxUser for the active document is the target toolbox user. Because IVsToolboxUser is reserved for documents, you need to implement IVsToolboxUser if you want to provide clipboard cycling for a tool window. Once you do this, you can implement clipboard cycling by passing in your tool window's IVsToolboxUser in a call to IVsToolboxClipboardCycler::GetAndSelectNextDataObject.

Community Additions