GoFiler Legato Script Reference   Legato v 1.5d Application v 5.25a

Table of Contents	< < Previous	Next >>

 

Chapter Eighteen — DataView Integration (continued)

on_edit_cell_text

Overview

The on_edit_cell_text event handler is called when the user requests that the content of a cell or item be edited as text (such as an edit command originating from the bar edit or on the sheet as text). This event is tied to the DATA_EDIT_CELL_TEXT menu function.

Syntax/Parameters

Syntax

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

Parameters

row

An int that specifies the row of the cell to be edited.

column

An int that specifies the column of the cell to be edited.

Return Value

Returns an int. The script should return anything but ERROR_CANCEL (0x82000000) to override the default behavior. If the event is not canceled, the return code is passed back to the caller (presumably the menu dispatch).

Remarks

Generally edit cell text allows the cell to turn to an edit control or allows editing in the edit/nav bar, if enabled.

The on_edit_cell_text event allows a script to intercept and process the cell edit function. It is up to the script to present any dialogs and perform functions to replace a cell’s content. This event handler is considered a more low-level edit as compared to the on_edit_cell_content event handler. In some views, the default behavior is to edit the cell on screen or within the edit bar.

The event can be canceled by returning ERROR_CANCEL.

Related Events

on_cell_changed — Called after the content of a cell has been changed.

on_cell_changing — Called prior to the content of a cell being changed.

on_edit_cell_content — Requests to edit cell contents (i.e., high level edit).

on_edit_row — Requests to edit a row contents (i.e., record level edit).

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

Page revised 2024-12-13

 

Table of Contents	< < Previous	Next >>

GoFiler Legato Script Reference — Generated on 12/16/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.