Skip to content

Latest commit

 

History

History
54 lines (43 loc) · 1.68 KB

GetImagePopupSelectedItem.md

File metadata and controls

54 lines (43 loc) · 1.68 KB

GetImagePopupSelectedItem

Description

Gets the selected image popup item.

FUNCTION GetImagePopupSelectedItem(
				dialogID    : LONGINT;
				componentID : LONGINT): INTEGER;
def vs.GetImagePopupSelectedItem(dialogID, componentID):
    return INTEGER

Parameters

Name Type Description
dialogID LONGINT Index to the dialog layout that contains the image popup component.
componentID LONGINT Index to a specific image popup component.

Remarks

Returns the index to the Item that is currently selected in the image pop-up control. Currently there is always a selected item.

ComponentID is the dialog Item index of the control

This function is currently returning item indexes assuming a 1-based index whereas GetImagePopupObject() assumes a zero based index. This will hopefully be fixed for release so that all layout mgr dialog controls use a zero based indexing system for lists of items.

Examples

VectorScript

selectedItemIndex := GetImagePopupSelectedItem(dialogID, componentID);

Python

selectedItemIndex = vs.GetImagePopupSelectedItem(dialogID, componentID)

See Also

VS Functions: InsertImagePopupObjectItem | GetNumImagePopupItems | GetImagePopupObject | GetImagePopupObjectItemIndex | SetImagePopupSelectedItem | RemoveImagePopupItem | RemoveAllImagePopupItems

Version

Availability: from VectorWorks10.0

Category