PropValuesAnnotations Function

Returns the values for the requested property. This will search selected annotations only within a schematic. There are optional filters for choosing elements with a particular property, or property and value combination, along with options to select a specific schematic.

Arguments

Number Type Compulsory Default Description
1 string Yes Property name to retrieve values for
2 string No Filter property name
3 string No Filter property value
4 real No Schematic handle
5 string array No options

Argument 1

The name of the property to return the values for.

Argument 2

If set, will only choose elements that have this property in them. Setting this argument to the function Null will have the same effect as omitting it. This allows arguments 3 & 4 to be specified

Argument 3

If set, will only choose elements that have the property stated by argument 2, with the value stated by this argument. Setting this argument to the function Null will have the same effect as omitting it. This allows argument 4 to be specified

Argument 4

Handle to a particular schematic. If not set, uses the currently highlighted schematic.

Argument 5

Array of length up to three to set these options:

  • 'partial' : Include partially selected annotations
  • 'empty' : Return an empty vector if there are no matches. Otherwise an empty string will be returned.
  • 'mustpossess' : No match if instance does not possess the target property

Returns

Return type: string array

Returns the property values for all applicable properties. Each row of the resulting array will be a different element's property flag.

See Also