RegionListItemBuilder Class¶
-
class
NXOpen.Features.RegionListItemBuilder¶ Bases:
NXOpen.BuilderRepresents a
Features.RegionListItemBuilderbuilderTo create a new instance of this class, use
NXOpen.Features.VarOffsetFaceBuilder.CreateRegionListItem()Default values.
Property Value OffsetDistance.Value 0 (millimeters part), 0 (inches part) RegionType 0 New in version NX11.0.0.
Properties¶
| Property | Description |
|---|---|
| OffsetDistance | Returns the offset distance |
| Region | Returns the region |
| RegionType | Returns or sets the region type |
| Tag | Returns the Tag for this object. |
Methods¶
| Method | Description |
|---|---|
| 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. |
| 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¶
| RegionListItemBuilderType Enumeration | bridge continuity |
Property Detail¶
OffsetDistance¶
-
RegionListItemBuilder.OffsetDistance¶ Returns the offset distance
-------------------------------------Getter Method
Signature
OffsetDistanceReturns: Return type: NXOpen.ExpressionNew in version NX11.0.0.
License requirements: None.
Region¶
-
RegionListItemBuilder.Region¶ Returns the region
-------------------------------------Getter Method
Signature
RegionReturns: Return type: NXOpen.RegionPointListNew in version NX11.0.0.
License requirements: None.
RegionType¶
-
RegionListItemBuilder.RegionType¶ Returns or sets the region type
-------------------------------------Getter Method
Signature
RegionTypeReturns: Return type: int New in version NX11.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
RegionTypeParameters: regionType (int) – New in version NX11.0.0.
License requirements: studio_free_form (“STUDIO FREE FORM”)
Method Detail¶
Validate¶
-
RegionListItemBuilder.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.