JVCL Help:TJvClipboard.OnRenderFormat

 JVCL Help: TJvClipboard.OnRenderFormat Event

TJvClipboard

► TJvClipboard Events

[+] TJvClipboard Events

► TJvClipboard Fields

[+] TJvClipboard Fields

► TJvClipboard Methods

[+] TJvClipboard Methods

► TJvClipboard Properties

[+] TJvClipboard Properties

JEDI Visual Component Library Help

• Packages
• Files
  • Classes
  • Interfaces
  • Functions
  • Variables
  • Constants
  • Types
  • Records
• Project summary
• License

Search in JVCL Help

 

Search in all projects

 

Summary

The event fired when a format has been added with delayed rendering and needs rendering because an application (or the DestroyHandle method) asked for it

Pascal

 TJvRenderFormatEvent = procedure (Sender: TObject; Format: Word; var Buffer: Pointer; var Size: Cardinal; var MustFree: Boolean) ofobject;
propertyOnRenderFormat: TJvRenderFormatEvent;

Parameters

Parameters	Description
Size	The size in bytes of the data available in the buffer. Setting size to 0 will make the system remove this format from the clipboard, but this is not a documented behavior
MustFree	set to False by default. If you set this to True, the clipboard will call FreeMem(buffer) after having copied the data in the system clipboard. This is useful only if you allocated the buffer using GetMem()
Buffer	The buffer where the rendered data has to be or has been put. You may change the value of the buffer parameter to point on a memory that will survive the exit of your handler. Clearly, you can't give a pointer to a local variable or use a PChar() conversion. Alternatively, you can allocate some memory with GetMem(), copy your data in the buffer and set the MustFree parameter to true to ask the clipboard to free the memory for you (done using FreeMem). Setting buffer to nil will make the system remove this format from the clipboard, but this is not a documented behavior
Sender	The object triggering the event. Clearly, will always be the value returned by JvClipboard, unless you call the event yourself
Format	The format needing rendering

Description

This event MUST be assigned if you want to add delayed rendering formats in the clipboard. If not, you will get an exception when the format is rendered.

See Also

TJvClipboard.AddDelayed

About

Contribute to this help topic

This documentation wiki is based on the collaborative effort of Project JEDI users. Your edits are welcome in order to improve documentation quality: edit this page

The JEDI Visual Component Library source is hosted at : link to view the current source code, link to the subversion repository