  |
GoFiler Legato Script Reference
Legato v 1.5d Application v 5.25a
|
| Table of Contents | < < Previous | Next >> |
Chapter Eighteen — DataView Integration (continued)
Overview
The on_edit_cut event handler is called when the user requests to cut data. This event is tied to the EDIT_CUT menu function.
Syntax/Parameters
Syntax
int on_edit_cut ( 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 cut 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 default operation is to copy and remove all cell properties including style and attributes. The cut data is presented to the clipboard in a number of formats.
Related Events
Page revised 2024-12-13
| Table of Contents | < < Previous | Next >> |
© 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.