SelectedProperties Function

Returns information about selected properties.

Arguments

Number Type Compulsory Default Description
1 string No 'Handle' Property name
2 real No -1 Schematic ID

Argument 1

Property whose value will be used to identify the instance that possesses the selected property.

Argument 2

Schematic ID as returned by the OpenSchematic function. This allows this function to be used with a schematic that is not open or not currently selected. If equal to -1, the currently selected schematic will be used.

Returns

Return type: string array

Returns an array of length equal to 3 times the number of properties selected. Currently, however, it is only possible to select one property at a time so the return value will be either of length zero or length 3. The elements in each group of three are as defined in the table. The function will return an empty vector if no schematic is open or the supplied schematic id is invalid

Index Description
0 Value of instance property identified in argument 1. This is used to identify the instance that possesses the selected property.
1 Name of selected property
2 Value of selected property

Notes

Properties can only be selected if the 'selectable' attribute is enabled.