Legato
Legato

GoFiler Legato Script Reference

 

Legato v 1.5b

Application v 5.24b

  

 

Chapter NineDialog Functions (continued)

DataControlSetLegendStyle Function

Overview

The DataControlSetLegendStyle function sets certain display options for the overall column and row legends.

Syntax/Parameters

Syntax

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

Parameters

id

An int containing the control ID of the data control.

flags

An optional dword specifying which styles to set.

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

Style bits for the flags parameter are as follows:

  Define   Value   Comment/Type  
  DCC_COL_MODE_SET_FLAT   0x00000001   Display column heading without ridged insets. This is the normal state when columns have display widths or text set. If default legends are used, this flag can force the legend to display in a flat mode.  
  (reserved)   0xFFFFFFFE   Reserved for future use.  

 

Related Functions

Platform Support

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

Legato IDE, Legato Basic