SearchCriteriaDimensionBuilder Class¶
-
class
NXOpen.Annotations.SearchCriteriaDimensionBuilder¶ Bases:
NXOpen.BuilderRepresents SearchCriteriaDimensionBuilder
To create a new instance of this class, use
NXOpen.Annotations.SearchModelViewCollection.CreateSearchCriteriaDimensionBuilder()New in version NX7.5.0.
Properties¶
| Property | Description |
|---|---|
| AboveText | Returns or sets the above text |
| AboveTextType | Returns or sets the above text enum |
| AfterText | Returns or sets the after text |
| AfterTextType | Returns or sets the after text enum |
| BeforeText | Returns or sets the before text |
| BeforeTextType | Returns or sets the before text enum |
| BelowText | Returns or sets the below text |
| BelowTextType | Returns or sets the below text enum |
| ByAboveText | Returns or sets the above text toggle |
| ByAfterText | Returns or sets the after text toggle |
| ByBeforeText | Returns or sets the before text toggle |
| ByBelowText | Returns or sets the below text toggle |
| ByDeviation | Returns or sets the deviation toggle |
| ByDiameterSymbol | Returns or sets the diameter symbol toggle |
| ByDimensionType | Returns or sets the dimension type toggle |
| ByDimensionValue | Returns or sets the dimension value toggle |
| ByGrade | Returns or sets the grade toggle |
| ByLowerTolerance | Returns or sets the lower tolerance toggle |
| ByRadialSymbol | Returns or sets the radial symbol toggle |
| ByToleranceType | Returns or sets the tolerance type toggle |
| ByUpperTolerance | Returns or sets the upper tolerance toggle |
| Callout | Returns the callout block |
| Deviation | Returns or sets the deviation |
| DiameterSymbol | Returns or sets the diameter symbol |
| DimensionType | Returns or sets the dimension type |
| DimensionValue | Returns or sets the dimension value |
| DimensionValueType | Returns or sets the dimension value enum |
| Grade | Returns or sets the grade |
| LowerToleranceType | Returns or sets the lower tolerance enum |
| LowerToleranceValue | Returns or sets the lower tolerance value |
| MeasurementType | Returns or sets the measurement type |
| RadialSymbol | Returns or sets the radial symbol |
| Tag | Returns the Tag for this object. |
| ToleranceType | Returns or sets the tolerance type |
| UpperToleranceType | Returns or sets the upper tolerance enum |
| UpperToleranceValue | Returns or sets the upper tolerance value |
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¶
| SearchCriteriaDimensionBuilderDiameterSymbolOptions Enumeration | Specifies diameter symbol option |
| SearchCriteriaDimensionBuilderDimensionTypes Enumeration | Specifies dimension types |
| SearchCriteriaDimensionBuilderMeasurementTypes Enumeration | Specifies measurement types |
| SearchCriteriaDimensionBuilderRadialSymbolOptions Enumeration | Specifies radial symbol option |
| SearchCriteriaDimensionBuilderToleranceTypes Enumeration | Specifies tolerance types |
Property Detail¶
AboveText¶
-
SearchCriteriaDimensionBuilder.AboveText¶ Returns or sets the above text
-------------------------------------Getter Method
Signature
AboveTextReturns: Return type: str New in version NX7.5.0.
License requirements: None.
-------------------------------------Setter Method
Signature
AboveTextParameters: aboveText (str) – New in version NX7.5.0.
License requirements: None.
AboveTextType¶
-
SearchCriteriaDimensionBuilder.AboveTextType¶ Returns or sets the above text enum
-------------------------------------Getter Method
Signature
AboveTextTypeReturns: Return type: NXOpen.Annotations.SearchModelViewBuilderTextComparisionOptionsNew in version NX7.5.0.
License requirements: None.
-------------------------------------Setter Method
Signature
AboveTextTypeParameters: aboveTextType ( NXOpen.Annotations.SearchModelViewBuilderTextComparisionOptions) –New in version NX7.5.0.
License requirements: None.
AfterText¶
-
SearchCriteriaDimensionBuilder.AfterText¶ Returns or sets the after text
-------------------------------------Getter Method
Signature
AfterTextReturns: Return type: str New in version NX7.5.0.
License requirements: None.
-------------------------------------Setter Method
Signature
AfterTextParameters: afterText (str) – New in version NX7.5.0.
License requirements: None.
AfterTextType¶
-
SearchCriteriaDimensionBuilder.AfterTextType¶ Returns or sets the after text enum
-------------------------------------Getter Method
Signature
AfterTextTypeReturns: Return type: NXOpen.Annotations.SearchModelViewBuilderTextComparisionOptionsNew in version NX7.5.0.
License requirements: None.
-------------------------------------Setter Method
Signature
AfterTextTypeParameters: afterTextType ( NXOpen.Annotations.SearchModelViewBuilderTextComparisionOptions) –New in version NX7.5.0.
License requirements: None.
BeforeText¶
-
SearchCriteriaDimensionBuilder.BeforeText¶ Returns or sets the before text
-------------------------------------Getter Method
Signature
BeforeTextReturns: Return type: str New in version NX7.5.0.
License requirements: None.
-------------------------------------Setter Method
Signature
BeforeTextParameters: beforeText (str) – New in version NX7.5.0.
License requirements: None.
BeforeTextType¶
-
SearchCriteriaDimensionBuilder.BeforeTextType¶ Returns or sets the before text enum
-------------------------------------Getter Method
Signature
BeforeTextTypeReturns: Return type: NXOpen.Annotations.SearchModelViewBuilderTextComparisionOptionsNew in version NX7.5.0.
License requirements: None.
-------------------------------------Setter Method
Signature
BeforeTextTypeParameters: beforeTextType ( NXOpen.Annotations.SearchModelViewBuilderTextComparisionOptions) –New in version NX7.5.0.
License requirements: None.
BelowText¶
-
SearchCriteriaDimensionBuilder.BelowText¶ Returns or sets the below text
-------------------------------------Getter Method
Signature
BelowTextReturns: Return type: str New in version NX7.5.0.
License requirements: None.
-------------------------------------Setter Method
Signature
BelowTextParameters: belowText (str) – New in version NX7.5.0.
License requirements: None.
BelowTextType¶
-
SearchCriteriaDimensionBuilder.BelowTextType¶ Returns or sets the below text enum
-------------------------------------Getter Method
Signature
BelowTextTypeReturns: Return type: NXOpen.Annotations.SearchModelViewBuilderTextComparisionOptionsNew in version NX7.5.0.
License requirements: None.
-------------------------------------Setter Method
Signature
BelowTextTypeParameters: belowTextType ( NXOpen.Annotations.SearchModelViewBuilderTextComparisionOptions) –New in version NX7.5.0.
License requirements: None.
ByAboveText¶
-
SearchCriteriaDimensionBuilder.ByAboveText¶ Returns or sets the above text toggle
-------------------------------------Getter Method
Signature
ByAboveTextReturns: Return type: bool New in version NX7.5.0.
License requirements: None.
-------------------------------------Setter Method
Signature
ByAboveTextParameters: aboveText (bool) – New in version NX7.5.0.
License requirements: None.
ByAfterText¶
-
SearchCriteriaDimensionBuilder.ByAfterText¶ Returns or sets the after text toggle
-------------------------------------Getter Method
Signature
ByAfterTextReturns: Return type: bool New in version NX7.5.0.
License requirements: None.
-------------------------------------Setter Method
Signature
ByAfterTextParameters: afterText (bool) – New in version NX7.5.0.
License requirements: None.
ByBeforeText¶
-
SearchCriteriaDimensionBuilder.ByBeforeText¶ Returns or sets the before text toggle
-------------------------------------Getter Method
Signature
ByBeforeTextReturns: Return type: bool New in version NX7.5.0.
License requirements: None.
-------------------------------------Setter Method
Signature
ByBeforeTextParameters: beforeText (bool) – New in version NX7.5.0.
License requirements: None.
ByBelowText¶
-
SearchCriteriaDimensionBuilder.ByBelowText¶ Returns or sets the below text toggle
-------------------------------------Getter Method
Signature
ByBelowTextReturns: Return type: bool New in version NX7.5.0.
License requirements: None.
-------------------------------------Setter Method
Signature
ByBelowTextParameters: belowText (bool) – New in version NX7.5.0.
License requirements: None.
ByDeviation¶
-
SearchCriteriaDimensionBuilder.ByDeviation¶ Returns or sets the deviation toggle
-------------------------------------Getter Method
Signature
ByDeviationReturns: Return type: bool New in version NX7.5.0.
License requirements: None.
-------------------------------------Setter Method
Signature
ByDeviationParameters: byDeviation (bool) – New in version NX7.5.0.
License requirements: None.
ByDiameterSymbol¶
-
SearchCriteriaDimensionBuilder.ByDiameterSymbol¶ Returns or sets the diameter symbol toggle
-------------------------------------Getter Method
Signature
ByDiameterSymbolReturns: Return type: bool New in version NX7.5.0.
License requirements: None.
-------------------------------------Setter Method
Signature
ByDiameterSymbolParameters: diameterSymbol (bool) – New in version NX7.5.0.
License requirements: None.
ByDimensionType¶
-
SearchCriteriaDimensionBuilder.ByDimensionType¶ Returns or sets the dimension type toggle
-------------------------------------Getter Method
Signature
ByDimensionTypeReturns: Return type: bool New in version NX7.5.0.
License requirements: None.
-------------------------------------Setter Method
Signature
ByDimensionTypeParameters: dimensionType (bool) – New in version NX7.5.0.
License requirements: None.
ByDimensionValue¶
-
SearchCriteriaDimensionBuilder.ByDimensionValue¶ Returns or sets the dimension value toggle
-------------------------------------Getter Method
Signature
ByDimensionValueReturns: Return type: bool New in version NX7.5.0.
License requirements: None.
-------------------------------------Setter Method
Signature
ByDimensionValueParameters: dimensionValue (bool) – New in version NX7.5.0.
License requirements: None.
ByGrade¶
-
SearchCriteriaDimensionBuilder.ByGrade¶ Returns or sets the grade toggle
-------------------------------------Getter Method
Signature
ByGradeReturns: Return type: bool New in version NX7.5.0.
License requirements: None.
-------------------------------------Setter Method
Signature
ByGradeParameters: byGrade (bool) – New in version NX7.5.0.
License requirements: None.
ByLowerTolerance¶
-
SearchCriteriaDimensionBuilder.ByLowerTolerance¶ Returns or sets the lower tolerance toggle
-------------------------------------Getter Method
Signature
ByLowerToleranceReturns: Return type: bool New in version NX7.5.0.
License requirements: None.
-------------------------------------Setter Method
Signature
ByLowerToleranceParameters: lowerTolerance (bool) – New in version NX7.5.0.
License requirements: None.
ByRadialSymbol¶
-
SearchCriteriaDimensionBuilder.ByRadialSymbol¶ Returns or sets the radial symbol toggle
-------------------------------------Getter Method
Signature
ByRadialSymbolReturns: Return type: bool New in version NX7.5.0.
License requirements: None.
-------------------------------------Setter Method
Signature
ByRadialSymbolParameters: radialSymbol (bool) – New in version NX7.5.0.
License requirements: None.
ByToleranceType¶
-
SearchCriteriaDimensionBuilder.ByToleranceType¶ Returns or sets the tolerance type toggle
-------------------------------------Getter Method
Signature
ByToleranceTypeReturns: Return type: bool New in version NX7.5.0.
License requirements: None.
-------------------------------------Setter Method
Signature
ByToleranceTypeParameters: toleranceType (bool) – New in version NX7.5.0.
License requirements: None.
ByUpperTolerance¶
-
SearchCriteriaDimensionBuilder.ByUpperTolerance¶ Returns or sets the upper tolerance toggle
-------------------------------------Getter Method
Signature
ByUpperToleranceReturns: Return type: bool New in version NX7.5.0.
License requirements: None.
-------------------------------------Setter Method
Signature
ByUpperToleranceParameters: upperTolerance (bool) – New in version NX7.5.0.
License requirements: None.
Callout¶
-
SearchCriteriaDimensionBuilder.Callout¶ Returns the callout block
-------------------------------------Getter Method
Signature
CalloutReturns: Return type: NXOpen.Annotations.SearchCriteriaCalloutBuilderNew in version NX9.0.0.
License requirements: None.
Deviation¶
-
SearchCriteriaDimensionBuilder.Deviation¶ Returns or sets the deviation
-------------------------------------Getter Method
Signature
DeviationReturns: Return type: str New in version NX7.5.0.
License requirements: None.
-------------------------------------Setter Method
Signature
DeviationParameters: deviation (str) – New in version NX7.5.0.
License requirements: None.
DiameterSymbol¶
-
SearchCriteriaDimensionBuilder.DiameterSymbol¶ Returns or sets the diameter symbol
-------------------------------------Getter Method
Signature
DiameterSymbolReturns: Return type: NXOpen.Annotations.SearchCriteriaDimensionBuilderDiameterSymbolOptionsNew in version NX7.5.0.
License requirements: None.
-------------------------------------Setter Method
Signature
DiameterSymbolParameters: diameterSymbol ( NXOpen.Annotations.SearchCriteriaDimensionBuilderDiameterSymbolOptions) –New in version NX7.5.0.
License requirements: None.
DimensionType¶
-
SearchCriteriaDimensionBuilder.DimensionType¶ Returns or sets the dimension type
-------------------------------------Getter Method
Signature
DimensionTypeReturns: Return type: NXOpen.Annotations.SearchCriteriaDimensionBuilderDimensionTypesNew in version NX7.5.0.
License requirements: None.
-------------------------------------Setter Method
Signature
DimensionTypeParameters: dimensionType ( NXOpen.Annotations.SearchCriteriaDimensionBuilderDimensionTypes) –New in version NX7.5.0.
License requirements: None.
DimensionValue¶
-
SearchCriteriaDimensionBuilder.DimensionValue¶ Returns or sets the dimension value
-------------------------------------Getter Method
Signature
DimensionValueReturns: Return type: float New in version NX7.5.0.
License requirements: None.
-------------------------------------Setter Method
Signature
DimensionValueParameters: dimensionValue (float) – New in version NX7.5.0.
License requirements: None.
DimensionValueType¶
-
SearchCriteriaDimensionBuilder.DimensionValueType¶ Returns or sets the dimension value enum
-------------------------------------Getter Method
Signature
DimensionValueTypeReturns: Return type: NXOpen.Annotations.SearchModelViewBuilderValueComparisionOptionsNew in version NX7.5.0.
License requirements: None.
-------------------------------------Setter Method
Signature
DimensionValueTypeParameters: dimensionValueType ( NXOpen.Annotations.SearchModelViewBuilderValueComparisionOptions) –New in version NX7.5.0.
License requirements: None.
Grade¶
-
SearchCriteriaDimensionBuilder.Grade¶ Returns or sets the grade
-------------------------------------Getter Method
Signature
GradeReturns: Return type: str New in version NX7.5.0.
License requirements: None.
-------------------------------------Setter Method
Signature
GradeParameters: grade (str) – New in version NX7.5.0.
License requirements: None.
LowerToleranceType¶
-
SearchCriteriaDimensionBuilder.LowerToleranceType¶ Returns or sets the lower tolerance enum
-------------------------------------Getter Method
Signature
LowerToleranceTypeReturns: Return type: NXOpen.Annotations.SearchModelViewBuilderValueComparisionOptionsNew in version NX7.5.0.
License requirements: None.
-------------------------------------Setter Method
Signature
LowerToleranceTypeParameters: lowerToleranceType ( NXOpen.Annotations.SearchModelViewBuilderValueComparisionOptions) –New in version NX7.5.0.
License requirements: None.
LowerToleranceValue¶
-
SearchCriteriaDimensionBuilder.LowerToleranceValue¶ Returns or sets the lower tolerance value
-------------------------------------Getter Method
Signature
LowerToleranceValueReturns: Return type: float New in version NX7.5.0.
License requirements: None.
-------------------------------------Setter Method
Signature
LowerToleranceValueParameters: lowerToleranceValue (float) – New in version NX7.5.0.
License requirements: None.
MeasurementType¶
-
SearchCriteriaDimensionBuilder.MeasurementType¶ Returns or sets the measurement type
-------------------------------------Getter Method
Signature
MeasurementTypeReturns: Return type: NXOpen.Annotations.SearchCriteriaDimensionBuilderMeasurementTypesNew in version NX10.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
MeasurementTypeParameters: measurementType ( NXOpen.Annotations.SearchCriteriaDimensionBuilderMeasurementTypes) –New in version NX10.0.0.
License requirements: None.
RadialSymbol¶
-
SearchCriteriaDimensionBuilder.RadialSymbol¶ Returns or sets the radial symbol
-------------------------------------Getter Method
Signature
RadialSymbolReturns: Return type: NXOpen.Annotations.SearchCriteriaDimensionBuilderRadialSymbolOptionsNew in version NX7.5.0.
License requirements: None.
-------------------------------------Setter Method
Signature
RadialSymbolParameters: radialSymbol ( NXOpen.Annotations.SearchCriteriaDimensionBuilderRadialSymbolOptions) –New in version NX7.5.0.
License requirements: None.
ToleranceType¶
-
SearchCriteriaDimensionBuilder.ToleranceType¶ Returns or sets the tolerance type
-------------------------------------Getter Method
Signature
ToleranceTypeReturns: Return type: NXOpen.Annotations.SearchCriteriaDimensionBuilderToleranceTypesNew in version NX7.5.0.
License requirements: None.
-------------------------------------Setter Method
Signature
ToleranceTypeParameters: toleranceType ( NXOpen.Annotations.SearchCriteriaDimensionBuilderToleranceTypes) –New in version NX7.5.0.
License requirements: None.
UpperToleranceType¶
-
SearchCriteriaDimensionBuilder.UpperToleranceType¶ Returns or sets the upper tolerance enum
-------------------------------------Getter Method
Signature
UpperToleranceTypeReturns: Return type: NXOpen.Annotations.SearchModelViewBuilderValueComparisionOptionsNew in version NX7.5.0.
License requirements: None.
-------------------------------------Setter Method
Signature
UpperToleranceTypeParameters: upperToleranceType ( NXOpen.Annotations.SearchModelViewBuilderValueComparisionOptions) –New in version NX7.5.0.
License requirements: None.
UpperToleranceValue¶
-
SearchCriteriaDimensionBuilder.UpperToleranceValue¶ Returns or sets the upper tolerance value
-------------------------------------Getter Method
Signature
UpperToleranceValueReturns: Return type: float New in version NX7.5.0.
License requirements: None.
-------------------------------------Setter Method
Signature
UpperToleranceValueParameters: upperToleranceValue (float) – New in version NX7.5.0.
License requirements: None.
Method Detail¶
Validate¶
-
SearchCriteriaDimensionBuilder.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.