GoFiler Legato Script Reference   Legato v 1.5d Application v 5.25a

Table of Contents	< < Previous	Next >>

 

Chapter Eight — Data Functions (continued)

DataSheetGetColumnWidth Function

Overview

The DataSheetGetColumnWidth function returns the width of a column in default units.

Syntax/Parameters

Syntax

int = DataSheetGetColumnWidth ( handle hSheet, int index );

Parameters

hSheet

A handle to a Data Sheet Object.

index

An int specifying the zero-based column index.

Return Value

Returns an int as the width in default units or a formatted error code on failure. Use the GetLastError and GetLastErrorMessage to retrieve additional information.

Remarks

The returned with would be the display width of the column if rendered. The measured size of the column’s content will be different from the width. The width can also be specified in CSS style units and can be retrieved using the DataSheetGetColumnProps function.

The function requires the column array to be setup and the sheet to have been measured.

Related Functions

DataSheetGetColumnProps — Gets the properties for a specified column as a string array.

DataSheetGetDefaultColumnWidth — Returns the default column width.

DataSheetGetRowHeight — Returns the calculated row height.

DataSheetGetSheetDepth — Returns the current depth of the sheet, as calculated.

DataSheetGetSheetWidth — Returns the current width of the sheet, as calculated.

DataSheetHasColumnArray — Tests whether the Data Sheet Object has a Column Array.

DataSheetMeasureSheet — Forces the sheet to measure.

DataSheetSetDefaultColumnWidth — Sets the default column width.

DataSheetSetDefaultRowHeight — Sets the default row height.

Platform Support

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

Legato IDE, Legato Basic

Page revised 2024-12-13

 

Table of Contents	< < Previous	Next >>

GoFiler Legato Script Reference — Generated on 12/16/2024

© 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.