schHiSelectByProperty

schHiSelectByProperty(
[ ?select t_select ]
[ ?propName t_propName ]
[ ?condOp t_condOp ]
[ ?propValue t_propValue ]
)
=> t

Description

Adds objects that match specified search criteria in a schematic or symbol view to the selected set or removes objects that match specified search criteria in a schematic or symbol view from the selected set. Usable when editing schematics or symbols. Supports only selection of strings, integers, floating-point numbers, and time. This function does not support other property types.

Searches the schematic or symbol cellview for objects that match the t_propName, t_condOp, and t_propValue arguments.

If no arguments are specified, the Select By Property form appears.

Arguments

?select t_select	Specifies if the objects are to be added or removed from the selected set; must be enclosed in quotation marks. Valid Values: select (for add), deselect (for remove)
?propName t_propName	The property name used in the search criteria; must be enclosed in quotation marks. If t_propName is set to master, t_propValue must be t_libName t_cellName t_viewName (separated by spaces). Wildcard expressions are not supported if t_propName is set to master.
?condOp t_condOp	The conditional operator that is applied to the property name and property value for matching; must be enclosed in quotation marks. Valid Values: ==, !=, <=, >=, <, >
?propValue t_propValue	The value of the property; must be enclosed in quotation marks. The value may include wildcard expressions.

Value Returned

Always returns t.

Examples

Displays the options form with t_propName set to instName, t_condOp set to ==, and t_propValue set to I1. All objects that have names set to I1 are added to the selected set.

schHiSelectByProperty( "select" "instName" "==" "I1" )

Displays the options form with t_propName set to instName, t_condOp set to ==, and t_propValue set to I1. All objects in the selected set that have names set to I1 are removed from the selected set.

schHiSelectByProperty( "deselect" "instName" "==" "I1" )

Return to top