GoFiler Legato Script Reference   Legato v 1.5b Application v 5.24b

Table of Contents	< < Previous	Next >>

 

Chapter Nine — Dialog Functions (continued)

DataControlRefreshLegends Function

Overview

The DataControlRefreshLegends function causes the Data Control to refresh the content of the legends or to display the legends if not shown.

Syntax/Parameters

Syntax

int = DataControlRefreshLegends ( int id, [dword flags] );

Parameters

id

An int containing the control ID of the data control.

flags

An optional dword specifying which legends to refresh or show. The default value is DCC_REFRESH_ALL.

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

By default a data control is created without row or column legends. Setting column heading text or flags will cause column to display. To refresh or cause a legend to display, the DataControlRefreshLegends can be used. This will also display a row legend.

If column headings are added, the column legend will automatically be created.

The flags are as follows:

	Define		Value		Comment/Type
	DCC_REFRESH_COLUMN		0x00000001		Refresh Column Heading
	DCC_REFRESH_ROW		0x00000002		Refresh Row Heading
	DCC_REFRESH_ALL		0x00000003		Refresh Column/Row Headings (default)

 

Related Functions

DataControlGetCellType — Get the cell’s display type.

DataControlSetColumnFlags — Sets the display and behavior flags for a specific column

DataControlSetColumnHeadings — Sets headings for a data control from a string array or series of strings.

DataControlSetColumnPositions — Sets column positions for a data control an integer array or from a series of integers.

DataControlSetLegendColor — Sets the color style for the legend portion of a data control.

Platform Support

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

Legato IDE, Legato Basic

 

Table of Contents	< < Previous	Next >>

GoFiler Legato Script Reference — Generated on 10/21/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.