ssCore.Clipboard.setData

Place plain text or RTF data on the Windows clipboard.


Availability:

First available in version 3.0 build 2039.


Input Parameters:

text - [Optional] - Plain text string to be placed on the clipboard.

rtf - [Optional] - RTF string to be placed on the clipboard.


Output Parameters:

No output parameters.


Asynchronous Mode:

When this method is called asynchronously, a return object containing the output parameters is passed to the specified callback function.

ssCore.Clipboard.setData( paramsObject [, callbackParamsObject] [, errorParamsObject] );


Synchronous Mode:

When this method is called synchronously, a return object containing the output parameters is returned to the caller immediately.

var returnObject = ssCore.Clipboard.setData( paramsObject );


Notes:

None.


Examples:

ssCore.Clipboard.setData({text:"This text will be copied to the clipboard."});