GoFiler Legato Script Reference   Legato v 1.5b Application v 5.24b

Table of Contents	< < Previous	Next >>

 

Chapter Fifteen — Windows/OS Functions (continued)

ClipboardSetRTF Function

Overview

The ClipboardSetRTF sets Rich Text Format data onto the Windows clipboard via a Clipboard Object.

Syntax/Parameters

Syntax

int = ClipboardSetRTF ( handle hClipboard, string data | handle hPool );

Parameters

hClipboard

A handle to a Clipboard Object.

data

A string containing text to place on the clipboard or,

hPool

A handle to a String Pool Object containing the text to place on the clipboard.

Return Value

Returns an int value as ERROR_NONE or a formatted error code.

Remarks

The function places data on the clipboard using the RTF designator as 8-bit ANSI text. The Clipboard Object must first be created using the ClipboardCreate function.

To post RTF and text, create a clipboard and then call ClipboardSetText and then the ClipboardSetRTF function. It is advisable to provide a text version of the RTF, even if the text formatting is less than optimal.

An example of setting simple RTF to the clipboard:

handle       hCB;
string       s1, s2;
        
s1 = "This is bold text";
s2 = "{\\rtf\\ansi \\pard\\plain This is {\\b bold} text.\\par}";

hCB = ClipboardCreate();
ClipboardSetText(hCB, s1);
ClipboardSetRTF(hCB, s2);
CloseHandle(hCB);

Related Functions

ClipboardCreate — Empties the clipboard and returns a clipboard handle.

ClipboardOpen — Opens the clipboard and returns a handle.

ClipboardSetHTML — Sets HTML data to the clipboard either as raw data or as basic HTML.

ClipboardSetText — Sets text to the clipboard.

ClipboardSetUnicode — Sets Unicode text to the clipboard.

PoolCreate — Creates a String Pool Object (SPO) and optionally loads the pool with a string.

Platform Support

Go13, Go16, GoFiler Complete, GoFiler Corporate, GoFiler, GoFiler Lite, GoXBRL

Legato IDE, Legato Basic

 

Table of Contents	< < Previous	Next >>

GoFiler Legato Script Reference — Generated on 10/21/2024

© 2012-2024 Novaworks, LLC. All rights reserved worldwide. Unauthorized use, duplication or transmission prohibited by law. Portions of the software are protected by US Patents 10,095,672, 10,706,221 and 11,210,456. GoFiler™ and Legato™ are trademarks of Novaworks, LLC. EDGAR® is a federally registered trademark of the U.S. Securities and Exchange Commission. Novaworks is not affiliated with or approved by the U.S. Securities and Exchange Commission. All other trademarks are property of their respective owners. Use of the features specified in this language are subject to terms, conditions and limitations of the Software License Agreement.