object

Tests the Outline tree for an object matching the given criteria. Searches only non-ambiguous objects given the current selection.

<object
    type="group_name"
    state="{any | stateless | fully-defined | under-defined | suppressed | 
       not-updated | updated | obsolete | error | bad-license}"
    name-regexp="regular_expression"
    condition="{exists | does-not-exist | is-selected | is-not-selected}" />

Note:  It was necessary to “word wrap” the long line of code in the above example.


Attributes

type

Optional. Identifies an object group name or an object type constant as a search criteria. If omitted, the object type is not considered.

Object groups are defined by using the object-group element. Refer to the Standard Object Groups Reference.

Type constants for specific objects (prefixed by "id_") are defined in the script file DSConstants.js.

state

Optional. Specifies an object state as a search criteria. If omitted, the default of "any" is used, meaning that object state is not considered.

States are defined in the script file DSConstants.js.

name-regexp

Optional. Specifies a regular expression of an object's name as a search criteria. For example, "part" matches any object that includes "part" in its name (e.g. "part 2"). If omitted, object names are not considered. See the Microsoft Scripting site under JScript for a regular expressions reference.

condition

Specifies a condition to test.

existsReturns true if an object matching the criteria exists.
does-not-existReturns true if no object matches the criteria.
is-selected Returns true if an object matching the criteria is currently selected.
is-not-selectedReturns true if no object matching the criteria is currently selected.
Element Information
Parentsif, and, or, not
ChildrenNone
End TagNo - close element with "/>"
Return ValueTrue if an object matching the criteria meets the condition.

Release 18.2 - © ANSYS, Inc. All rights reserved.