  |
GoFiler Legato Script Reference
Legato v 1.5b Application v 5.24b
|
| Table of Contents | < < Previous | Next >> |
Chapter Eighteen — DataView Integration (continued)
DataViewGetSelectClue Function
Overview
The DataViewGetSelectClue function retrieves the select clue for the current selection.
Syntax/Parameters
Syntax
int = DataViewGetSelectClue ( handle object );
Parameters
object
A handle to either a Data View Object or to a window that employs Data View.
Return Value
Returns an int containing the select clue code or -1 on failure. Use the GetLastError function to retrieve error information. The following are the possible return codes:
| Code | Value | Comment | ||||
| DS_SELECT_NONE | 0 | No select | ||||
| DS_SELECT_CELLS | 1 | Selected cell(s) (scattered) | ||||
| DS_SELECT_ROWS | 2 | Selected rows | ||||
| DS_SELECT_COLUMNS | 3 | Selected columns | ||||
| DS_SELECT_REGION | 4 | Selected region | ||||
| DS_SELECT_ALL | 5 | Selected all | ||||
| DS_SELECT_ALL_AS_SHEET | 6 | Selected all (as sheet) |
Remarks
The select clue help to identify the type of selection that was made by the user, such as a cell, a region, or a row selection. Note that the select clues employed in Data View are different than other views.
Related Functions
Platform Support
Go13, Go16, GoFiler Complete, GoFiler Corporate, GoFiler, GoFiler Lite, GoXBRL
| 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.