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

Table of Contents	< < Previous	Next >>

 

Chapter Nine — Dialog Functions (continued)

DataControlComboGetSelectIndex Function

Overview

The DataControlComboGetSelectIndex function returns the list index of a selected item, if a selection is present.

Syntax/Parameters

Syntax

int = DataControlComboGetSelectIndex ( int id, int row, int column );

Parameters

id

An int containing the control ID of the data control.

row

A zero-based int specifying the row.

column

A zero-based int specifying the column.

Return Value

Returns an int as ERROR_NONE or a formatted error code on failure. Common error codes are as follows: ERROR_EOD if an item is not selected, 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

An item is considered selected if it matches, exactly, the item in the edit area. If there duplicate items, the index of the first item is returned.

Related Functions

DataControlComboAddString — Adds a string to a combo box cell.

DataControlComboAddList — Inserts a list of items at an optional specified position.

DataControlComboDeleteItem — Deletes a list item from a specified index.

DataControlComboFindString — Finds a string within a combo list.

DataControlComboGetItemCount — Returns the total items in the list box portion of the combo.

DataControlComboGetString — Gets a string at the specified index position.

DataControlComboInsertString — Inserts to a string to a combo box cell.

DataControlComboReset — Resets the content of the combo box.

DataControlComboSelectItem — Selects a string in the list or an item by index.

DataControlSetCellType — Sets the display type for the cell, row, column and type.

Platform Support

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

Legato IDE, Legato Basic

Page revised 2024-10-21

 

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.