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

Table of Contents	< < Previous	Next >>

 

Chapter Nine — Dialog Functions (continued)

DataControlSetSelectMode Function

Overview

The DataControlSetSelectMode function sets the select behavior of a data control.

Syntax/Parameters

Syntax

int = DataControlSetSelectMode ( int id, dword flags );

Parameters

id

An int containing the control ID of the data control.

flags

A int or dword specifying the select mode for the control. See Remarks below.

Return Value

Returns 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 will operate like a single- or multiple-select list box depending on the initial control style (if list box LBS_MULTIPLESEL is added to the style). In single select mode, the unit of selection is a row and once selected, the arrow keys will change the selection. In multiple select mode, the arrow keys move the caret position.

The flags parameter sets the select type and the behavior:

	Definition			Bitwise		Description
	Modes
		DCC_SELECT_MODE_ROW		0x00000000		Select Row (default)
		DCC_SELECT_MODE_COLUMN		0x00000001		Select Column
		DCC_SELECT_MODE_CELL		0x00000002		Select Cell
		DCC_SELECT_MODE_NONE		0x00000003		Select None (Cells Implied)
		DCC_SELECT_MODE_MASK		0x0000000F		Select Type Mask
	Optional Flags
		DCC_SELECT_MODE_MULTIPLE		0x00001000		Allow Multiple Selections
		DCC_NO_AUTO_SELECT		0x00002000		Requires Shift or Control Select
		DCC_TRACK_SELECT		0x00006000		Single Selects Track Arrows

 

Related Functions

DataControlGetRowSelection — Gets the selected position in a single select data control.

DataControlGetRowSelectState — Returns the select state of a specified row for multiple select row style data control.

DataControlGetSelectCount — Returns the number of selected items (when in multiple select mode).

DataControlGetSelectList — Returns an array of all selected items in a multiple select enabled data control.

DataControlSetRowSelection — Selects the specified row within the control.

DataControlSetSelectColor — Sets the select color theme for the 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 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.