Skip to content

GetSelectedChoiceInfo.md

Latest commit

 

History

History
60 lines (49 loc) · 1.95 KB

GetSelectedChoiceInfo.md

File metadata and controls

60 lines (49 loc) · 1.95 KB
Raw

GetSelectedChoiceInfo

Description

Gets the index of the selected item and the text of the selected item in a menu.

PROCEDURE GetSelectedChoiceInfo(
				dialogID                  : LONGINT;
				componentID               : LONGINT;
				startIndex                : INTEGER;
				VAR outSelectedIndex      : INTEGER;
				VAR outSelectedChoiceText : STRING);
def vs.GetSelectedChoiceInfo(dialogID, componentID, startIndex):
    return (outSelectedIndex, outSelectedChoiceText)

Parameters

Name Type Description
dialogID LONGINT The dialog identifier given by CreateLayout or CreateResizableLayout
componentID LONGINT The identifier for the component that contains the choices.
startIndex INTEGER The index at which to start looking for a selected item.
outSelectedIndex INTEGER The index of the selected item or -1 if there is no selected item.
outSelectedChoiceText STRING The text of the selected item if it was found, otherwise this parameter is unchanged from when this function was called.

Examples

GetSelectedChoiceInfo(dialogID, 6, 0, i, gFolderName);
GetSelectedChoiceInfo(dialogID, 8, 0, i, gRecordName);

GetSelectedChoiceInfo(dialogID1, 6, 0, i, folderName);
GetSelectedChoiceInfo(dialogID1, 8, 0, recordNum, recordName);

BEGIN
	gNumPopupValues := 0;
	GetSelectedChoiceInfo (dialogID, 10, 0, selFieldIdx, curFieldName);
	ALLOCATE popupValues [1..1000];
	PopupGetChoices (gRecordName, curFieldName, gNumPopupValues, popupValues);
import vs

# Gets the index of the selected item and the text of the selected item in a
# menu.
dialogID = 1
componentID = 2
startIndex = 1

outSelectedIndex, outSelectedChoiceText = vs.GetSelectedChoiceInfo(dialogID, componentID, startIndex)
vs.Message('GetSelectedChoiceInfo returned: ' + str((outSelectedIndex, outSelectedChoiceText)))

Version

Availability: from Vectorworks 2010

Category