  |
GoFiler Legato Script Reference
Legato v 1.4i Application v 5.22a
|
| Table of Contents | < < Previous | Next >> |
Chapter Eight — Data Functions (continued)
DataSheetGetColumnProps Function
Overview
The DataSheetGetColumnProps function returns key properties for a specified column.
Syntax/Parameters
Syntax
string[] = DataSheetGetColumnProps ( handle hSheet, int column );
Parameters
hSheet
A handle to a Data Sheet Object.
column
An int specifying a zero-based column index.
Return Value
Returns a string array containing various data fields related to the column or an empty array on failure. Use the GetLastError function to retrieve error information.
Remarks
Not all Data Sheet Objects have a column array. If there is no column array, an empty array will be returned and the GetLastError function will report the error code ERROR_FUNCTION_NOT_SUPPORTED.
The following fields are returned:
| Element Key Name | Description | |||
| ColumnName | The name of the column. If not specified, a viewer/editor such as Data View will letter the columns starting with ‘A’. | |||
| InitialIndex | The initial zero-based position. | |||
| Flags | A hex representation of the bitwise column flags in the form of DS_CC_. See introduction to this section for details. | |||
| Tip | Hover popup tip.† | |||
| AbsoluteX | Absolute position of column. | |||
| RelativeX | Relative position (if scrolled). | |||
| MeasuredWidth | Measured width in pixels. | |||
| Width | Adjusted (displayed) width in pixels. | |||
| Height | Measured height in pixels. | |||
| SpecifiedWidth | Specified width as a pvalue. | |||
| Color | Color of text in hex as RGB. |
† Not supported in Data Control GUI.
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.