  |
GoFiler Legato Script Reference
Legato v 1.4i Application v 5.22a
|
| Table of Contents | < < Previous | Next >> |
Chapter Eight — Data Functions (continued)
DataSheetSetCellDisabled Function
Overview
The DataSheetSetCellDisabled function sets the hidden state of a cell as well as the hidden state set during file open.
Syntax/Parameters
Syntax
int = DataSheetSetCellDisabled ( handle hSheet, int row, int column,
[boolean flag], [boolean open]
);
int = DataSheetSetCellDisabled ( handle hSheet, string row, string column,
[boolean flag], [boolean open]
);
int = DataSheetSetCellDisabled ( handle hSheet, string address,
[boolean flag], [boolean open]
);
Parameters
hSheet
A handle to a Data Sheet Object.
row
An int or string specifying a zero-based row or Y position for the cell.
column
An int or string specifying a zero-based column or X position for the cell.
address
A string specifying the cell position by cell address such as “A1”.
flags
An optional boolean specifying to set or reset the disable state. The default is TRUE, to set the cell as disabled.
open
An optional boolean specifying to set or reset the disabled open state. The default is TRUE, to set the cell as disabled on open of XDS data.
Return Value
Returns an int as ERROR_NONE or a formatted error code on failure.
Remarks
Setting a cell as disabled does not impact any Data Sheet API functions but will affect Data View and Data Control, if connected to the cell.
The disable state is transient and no saved if the data is exported to XDS. The open flag sets a separate value that sets the disabled state on opening/import of XDS data.
This function is not transaction tracked.
Related Functions
Platform Support
Go13, Go16, GoFiler Complete, GoFiler Corporate, GoFiler, GoFiler Lite, GoXBRL
Legato IDE, Legato Basic
| 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.