  |
GoFiler Legato Script Reference
Legato v 1.5b Application v 5.24b
|
| Table of Contents | < < Previous | Next >> |
Chapter Nine — Dialog Functions (continued)
DataControlSetColumnHeadings Function
Overview
The DataControlSetColumnHeadings function sets the column headings for a data control. If the column legend is not displayed, this function will make it appear and set the display style to “flat”.
Syntax/Parameters
Syntax
int = DataControlSetColumnHeadings ( int id, [string p1, string p2, ...] | [string list[] ] );
Parameters
id
An int containing the control ID of the data control.
p1, p2, p3, ...
A list of one or more string parameters specifying column text; or,
list[]
A string array containing header text.
Return Value
Returns an int as ERROR_NONE or a formatted error code on failure. Common error codes are as follows: ERROR_RANGE if id is an invalid control ID for the open dialog or ERROR_INVALID_HANDLE if no dialog is open. Use the GetLastError function to retrieve error information.
Remarks
If there are insufficient heading strings for the number of columns, those remaining columns will be lettered. Adding more headings than columns will expand the number of columns as required.
Note that if columns are allowed to be sorted, the sort symbol will take up space in the legend area.
A maximum of 255 headings may be added but only by array. When adding as individual parameters, the number is limited by the maximum script parameters, which is 32 (less the id).
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.