Legato
Legato

GoFiler Legato Script Reference

 

Legato v 1.5d

Application v 5.25a

  

 

Chapter Nine — Dialog Functions (continued)

DataControlSetColumnFlags Function

Overview

The DataControlSetColumnFlags function sets the behavior and default alignment for all columns.

Syntax/Parameters

Syntax

int = DataControlSetColumnFlags ( int id, [dword p1, dword p2, ...] | [dword list[] ] );

Parameters

id

An int containing the control ID of the data control.

p1, p2, p3, ...

A list of one or more dword parameters specifying the column flags; or,

list[]

A dword array of column flags.

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

Column flags set the click behavior and default alignment of the cells within the column. Alignment for individual cells can be changed independently.

By default, columns can be resized and are left aligned. The DataControlSetColumnFlags function allows the behavior to be changed.

Each column can have the following bitwise values set:

  Definition   Bitwise   Description  
  Operation          
    DS_CC_NO_RESIZE   0x00000001   User Cannot Resize  
    DS_CC_ALLOW_DRAG   0x00000002   User Can Drag and Drop Columns  
    DS_CC_ALLOW_SELECT   0x00000004   User Can Select  
    DS_CC_ALLOW_RENAME   0x00000008   User Can Rename  
    DS_CC_ALLOW_PRESS   0x00000010   User Can Press Button (sort)  
  Contents          
    DS_CC_DEFAULT_NAME   0x00000020   Default Name (A, B, C)  
  Select (Highlight)          
    DS_CC_HIGHLIGHT   0x00000080   Column is Highlighted (legend)  
  Column Text Align          
    DS_CC_TEXT_MODE_MASK   0x00000C00   Text Mode Mask (Left, Right, etc)  
    DS_CC_TEXT_DEFAULT   0x00000000   Default (Left Text)  
    DS_CC_TEXT_LEFT   0x00000400   Left Text  
    DS_CC_TEXT_CENTER   0x00000800   Center Text  
    DS_CC_TEXT_RIGHT   0x00000C00   Right Text  
  Protection          
    DS_CC_READ_ONLY   0x00001000   Column is Read-Only  
    DS_CC_PROTECTED   0x00002000   Column is Protected (password)  
  Sorting          
    DS_CC_SORT_TYPE_MASK   0x000F0000   Sort Type Mask  
    DS_CC_SORT_NONE   0x00000000   Sort Not Allowed  
    DS_CC_SORT_TEXT   0x00010000   Sort Text (w/ case sensitivity)  
    DS_CC_SORT_TEXT_NO_CASE   0x00020000   Sort Text (no case sensitivity)  
    DS_CC_SORT_TEXT_NUMERIC   0x00030000   Sort Text/Numbers (as File List)  
    DS_CC_SORT_NUMERIC   0x00040000   Sort Treat as Auto Number  
    DS_CC_SORT_DATE_AUTO   0x00050000   Sort Treat as Auto Date  
  Control          
    DS_CC_HIDDEN   0x00100000   Column is Hidden  
    DS_CC_DISABLED   0x00200000   Column is Disabled  
    DS_CC_SORT_MASK   0x00C00000   Column Sort Mask  
    DS_CC_SORT_ACTIVE   0x00400000   Column Sort is Active (only one)  
    DS_CC_SORT_DESCEND   0x00800000   Sort Descending/Ascending  
  Reserved          
    DS_CC_RESERVED   0xFF000000   Reserved (internal flags)  
  Caller Combinations          
    DS_CC_SORT   0x00020410   General Sort, Left Align  
    DS_CC_SORT_DATE   0x00050410   Date Sort, Left Align  
    DS_CC_SORT_FILES   0x00030410   Filename Sort, Left Align  
    DS_CC_SORT_NUMBERS   0x00040C10   Sort as Numeric, Right Align  
    DS_CC_SORT_RIGHT   0x00020C10   General Sort, Right Align  

 

Related Functions

DataControlRefreshLegends — Refreshes both column and row legends.

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.

Platform Support

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

Legato IDE, Legato Basic

 

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.