FindByAttributesBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# FindByAttributesBuilder Class

class `NXOpen.Routing.``FindByAttributesBuilder`

  Bases: `NXOpen.Builder`

  Find runs/objects with specified attribute name and attribute value criteria, highlight the corresponding nodes in the run navigator and the graphics area

  To create a new instance of this class, use `NXOpen.Routing.RouteManager.CreateFindByAttributesBuilder()`

  New in version NX8.5.0.

# Properties

Property | Description
--- | ---
AttribList | Returns the attribute list containing search criteria
AttributeName | Returns or sets the string containing attribute title to search for
AttributeValue | Returns or sets the string containing attribute value to search for
Tag | Returns the Tag for this object.

# Methods

Method | Description
--- | ---
AttributeMembersBuilder | Creates an AttributeMembersBuilder object used to create list item
Commit | Commits any edits that have been applied to the builder.
Destroy | Deletes the builder, and cleans up any objects created by the builder.
GetCommittedObjects | For builders that create more than one object, this method returns the objects that are created by commit.
GetObject | Returns the object currently being edited by this builder.
HighlightRunNavItems | Highlight/Unhighlight the search results for FindByAttributes
ShowResults | Updates the model to reflect the result of an edit to the model for all builders that support showing results.
Validate | Validate whether the inputs to the component are sufficient for commit to be called.

# Property Detail

## AttribList

`FindByAttributesBuilder.``AttribList`

  Returns the attribute list containing search criteria

  `-------------------------------------`

  Getter Method

  Signature `AttribList`

  Returns: |
  Return type: | `NXOpen.TaggedObjectList`

  New in version NX8.5.0.

  License requirements: routing_advanced (“Routing Advanced”), routing_base (“Routing Basic”)

## AttributeName

`FindByAttributesBuilder.``AttributeName`

  Returns or sets the string containing attribute title to search for

  `-------------------------------------`

  Getter Method

  Signature `AttributeName`

  Returns: |
  Return type: | str

  New in version NX8.5.0.

  License requirements: routing_advanced (“Routing Advanced”), routing_base (“Routing Basic”)

  `-------------------------------------`

  Setter Method

  Signature `AttributeName`

  Parameters: | attributeName (str) –

  New in version NX8.5.0.

  License requirements: routing_advanced (“Routing Advanced”), routing_base (“Routing Basic”)

## AttributeValue

`FindByAttributesBuilder.``AttributeValue`

  Returns or sets the string containing attribute value to search for

  `-------------------------------------`

  Getter Method

  Signature `AttributeValue`

  Returns: |
  Return type: | str

  New in version NX8.5.0.

  License requirements: routing_advanced (“Routing Advanced”), routing_base (“Routing Basic”)

  `-------------------------------------`

  Setter Method

  Signature `AttributeValue`

  Parameters: | attributeValue (str) –

  New in version NX8.5.0.

  License requirements: routing_advanced (“Routing Advanced”), routing_base (“Routing Basic”)

# Method Detail

## AttributeMembersBuilder

`FindByAttributesBuilder.``AttributeMembersBuilder`

  Creates an AttributeMembersBuilder object used to create list item

  Signature `AttributeMembersBuilder()`

  Returns: |
  Return type: | `NXOpen.Routing.AttributeMembersBuilder`

  New in version NX8.5.0.

  License requirements: routing_advanced (“Routing Advanced”), routing_base (“Routing Basic”)

## HighlightRunNavItems

`FindByAttributesBuilder.``HighlightRunNavItems`

  Highlight/Unhighlight the search results for FindByAttributes

  Signature `HighlightRunNavItems(objects, highLight)`

  Parameters:

  - objects (list of `NXOpen.NXObject`) – Items
  - highLight (bool) –

  New in version NX8.5.0.

  License requirements: routing_advanced (“Routing Advanced”), routing_base (“Routing Basic”)

## Validate

`FindByAttributesBuilder.``Validate`

  Validate whether the inputs to the component are sufficient for commit to be called.

  If the component is not in a state to commit then an exception is thrown. For example, if the component requires you to set some property, this method will throw an exception if you haven’t set it. This method throws a not-yet-implemented NXException for some components.

  Signature `Validate()`

  Returns: | Was self validation successful
  Return type: | bool

  New in version NX3.0.1.

  License requirements: None.