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

Table of Contents	< < Previous	Next >>

 

Chapter Eighteen — DataView Integration (continued)

on_edit_copy

Overview

The on_edit_copy event handler is called when the user requests to copy data. This event is tied to the EDIT_COPY menu function.

Syntax/Parameters

Syntax

int on_edit_copy ( int row, int column ) { ... }

Parameters

row

An int that specifies the row of the cell that has focus.

column

An int that specifies the column of the cell that has focus.

Return Value

Returns an int. If the hook processes the action, return ERROR_EXIT to stop any further processing. If the event is not canceled, the return code is passed back to Data View for processing.

Remarks

This hook allows for the serving script to usurp control of the copy function and either preprocess or process and exit.

The position parameters provided are the caret position. Depending on the select mode of Data View, more cells could be selected. In which case, the select range must be retrieved to apply further processing. It is also possible for the caret to not be in the select range.

Note that the default operation is to copy all cell properties including style and attributes. The copied data is presented to the clipboard in a number of formats.

This hook is not called on edit cut.

Related Events

ClipboardCreate — Empties the clipboard and returns a clipboard handle.

on_edit_cut — Called on menu or quick key action for edit cut.

on_edit_paste — Called on menu or quick key action for edit paste.

on_menu_init — Called anytime the ribbon or a menu must be prepared for display or updated.

Page revised 2024-10-21

 

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.