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

Table of Contents	< < Previous	Next >>

 

Chapter Eighteen — DataView Integration (continued)

on_edit_paste

Overview

The on_edit_paste event handler is called when the user requests to paste data. This event is tied to the EDIT_PASTE menu function.

Syntax/Parameters

Syntax

int on_edit_paste ( 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 paste 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 paste operation is to analyze the content of the clipboard and then paste based on default action based on the data type or to query the user as to the paste action. This hook can either preprocess the clipboard or take control of the entire operation.

When the edit bar or on screen editing are active, this hook is not called.

Related Events

ClipboardOpen — Opens the clipboard and returns a handle.

on_edit_copy — Called on menu or quick key action for edit copy.

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

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.