Legato
Legato

GoFiler Legato Script Reference

 

Legato v 1.5d

Application v 5.25a

  

 

Chapter NineDialog Functions (continued)

DataControlGetColumnWidths Function

Overview

The DataControlGetColumnWidths function retrieves the number of columns loaded into the data control.

Syntax/Parameters

Syntax

dword [] = DataControlGetColumnWidths ( int id, [boolean specified] );

Parameters

id

An int containing the control ID of the data control.

specified

An optional boolean value indicating whether to return pixel widths or specified widths. The default is FALSE, pixel widths.

Return Value

Returns a dword array containing the widths of the columns in the data control or empty 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

The returned value is either the calculated width in pixels or specified width as a pvalue. If a specified width is zero (0x00000000), the column width is considered in automatic mode.

By default, a data control will always have at least one column.

Related Functions

Platform Support

Go13, Go16, GoFiler Complete, GoFiler Corporate, GoFiler, GoFiler Lite, GoXBRL

Legato IDE, Legato Basic