Class ViewManager : onGetRTFForClipboard Event


String onGetRTFForClipboard()

Summary

Called to obtain the text that will be used in the RTF portion of the Clipboard when a Programme is 'copied'.


Remarks

When something is copied to the clipboard, you can specify what 'format' that the text is in. Then when you paste this into an application, they can decide what 'formats' they will support.

For example, when you copy some text from a web page, it will be copied as PLAIN text and also as HTML text. So when you paste it into notepad, you get a version without formatting, and when you paste it into MS Word you will get all formatted and proper links.

DigiGuide supports to formats, PLAIN text and RTF text. RTF stands for Rich Text Formatting and is a widely adopted common format for documents that support formatting.


Returns


Return the string, in formatted text that you wish to be inserted into the clipboard as RTF.


Examples

var vm = app.getViewManager();

// Override our ViewManager event
vm.onGetRTFForClipboard = function()
{
    return "{\rtf1 Our \bRTF\b0 version of the programme for clipboard use. }";
};


See Also

  • ViewManager : onGetTextForClipboard


    Requirements

    Build 1082