SearchModelViewBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# SearchModelViewBuilder Class

class `NXOpen.Annotations.``SearchModelViewBuilder`

  Bases: `NXOpen.Builder`

  Represents a `NXOpen.Annotations.SearchModelViewBuilder`

  To create a new instance of this class, use `NXOpen.Annotations.SearchModelViewCollection.CreateSearchModelViewBuilder()`

  Default values.

  Property | Value
  --- | ---
  PmiType | Dimension

  New in version NX7.5.0.

# Properties

Property | Description
--- | ---
CriteriaList | Returns the criteria list
ModelViewName | Returns or sets the name
PmiType | Returns or sets the pmi type
SearchScope | Returns or sets the search scope
Tag | Returns the Tag for this object.

# Methods

Method | Description
--- | ---
Commit | Commits any edits that have been applied to the builder.
CreateCriteriaObject | Create search criteria object in search model view builder
DeleteCriteriaObject | Delete search criteria object in search model view builder
Destroy | Deletes the builder, and cleans up any objects created by the builder.
ExecuteSearch | TODO: fill in a description for this
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.
GetResults | All results
SaveAsModelView | TODO: fill in a description for this
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.

# Enumerations

SearchModelViewBuilderPmiTypes Enumeration | the search criteria pmitype
SearchModelViewBuilderSearchScopeOptions Enumeration | seaerch scope type
SearchModelViewBuilderTextComparisionOptions Enumeration | Represents the text comparision options
SearchModelViewBuilderValueComparisionOptions Enumeration | Represents the value comparision options

# Property Detail

## CriteriaList

`SearchModelViewBuilder.``CriteriaList`

  Returns the criteria list

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

  Getter Method

  Signature `CriteriaList`

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

  New in version NX7.5.0.

  License requirements: None.

## ModelViewName

`SearchModelViewBuilder.``ModelViewName`

  Returns or sets the name

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

  Getter Method

  Signature `ModelViewName`

  Returns: |
  Return type: | str

  New in version NX7.5.0.

  License requirements: None.

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

  Setter Method

  Signature `ModelViewName`

  Parameters: | modelViewName (str) –

  New in version NX7.5.0.

  License requirements: None.

## PmiType

`SearchModelViewBuilder.``PmiType`

  Returns or sets the pmi type

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

  Getter Method

  Signature `PmiType`

  Returns: |
  Return type: | `NXOpen.Annotations.SearchModelViewBuilderPmiTypes`

  New in version NX7.5.0.

  License requirements: None.

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

  Setter Method

  Signature `PmiType`

  Parameters: | pmiType (`NXOpen.Annotations.SearchModelViewBuilderPmiTypes`) –

  New in version NX7.5.0.

  License requirements: None.

## SearchScope

`SearchModelViewBuilder.``SearchScope`

  Returns or sets the search scope

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

  Getter Method

  Signature `SearchScope`

  Returns: |
  Return type: | `NXOpen.Annotations.SearchModelViewBuilderSearchScopeOptions`

  New in version NX7.5.0.

  License requirements: None.

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

  Setter Method

  Signature `SearchScope`

  Parameters: | searchScope (`NXOpen.Annotations.SearchModelViewBuilderSearchScopeOptions`) –

  New in version NX7.5.0.

  License requirements: None.

# Method Detail

## CreateCriteriaObject

`SearchModelViewBuilder.``CreateCriteriaObject`

  Create search criteria object in search model view builder

  Signature `CreateCriteriaObject(searchType)`

  Parameters: | searchType (`NXOpen.Annotations.SearchModelViewBuilderPmiTypes`) – search type
  Returns: | criteria object
  Return type: | `NXOpen.NXObject`

  New in version NX7.5.0.

  License requirements: None.

## DeleteCriteriaObject

`SearchModelViewBuilder.``DeleteCriteriaObject`

  Delete search criteria object in search model view builder

  Signature `DeleteCriteriaObject(criteriaObject)`

  Parameters: | criteriaObject (`NXOpen.NXObject`) – criteria Object

  New in version NX7.5.0.

  License requirements: None.

## ExecuteSearch

`SearchModelViewBuilder.``ExecuteSearch`

  TODO: fill in a description for this

  Signature `ExecuteSearch()`

  New in version NX7.5.0.

  License requirements: None.

## GetResults

`SearchModelViewBuilder.``GetResults`

  All results

  Signature `GetResults()`

  Returns: |
  Return type: | list of `NXOpen.NXObject`

  New in version NX7.5.0.

  License requirements: None.

## SaveAsModelView

`SearchModelViewBuilder.``SaveAsModelView`

  TODO: fill in a description for this

  Signature `SaveAsModelView()`

  New in version NX7.5.0.

  License requirements: None.

## Validate

`SearchModelViewBuilder.``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.