ViewDetailLabelBuilder Class¶
-
class
NXOpen.Drawings.ViewDetailLabelBuilder¶ Bases:
NXOpen.TaggedObject,NXOpen.GeometricUtilities.IComponentBuilderRepresents a
NXOpen.Drawings.ViewDetailLabelBuilderNew in version NX9.0.0.
Properties¶
| Property | Description |
|---|---|
| CustomizedViewLabel | Returns or sets the customized view label |
| IncludeParentheses | Returns or sets the include parentheses |
| LabelCharacterHeightFactor | Returns or sets the section vw label letter size factor |
| LabelParentDisplay | Returns or sets the label parent display |
| LabelPosition | Returns or sets the label position |
| LabelPrefix | Returns or sets the label prefix |
| LetterFormat | Returns or sets the letter format |
| ParentLabelPrefix | Returns or sets the parent label prefix |
| PrefixCharacterHeightFactor | Returns or sets the prefix character height factor |
| ReferenceToShow | Returns or sets the reference to show |
| ScaleCharacterHeightFactor | Returns or sets the scale character height factor |
| ScalePosition | Returns or sets the scale position |
| ScalePrefix | Returns or sets the scale prefix |
| ShowViewLabel | Returns or sets the show view label |
| ShowViewScale | Returns or sets the show view scale |
| Tag | Returns the Tag for this object. |
| TextGapFactor | Returns or sets the text gap factor |
| TextPlacement | Returns or sets the text placement |
| ValueFormat | Returns or sets the value format |
| ViewLabelOption | Returns or sets the view label option |
Methods¶
| Method | Description |
|---|---|
| GetCustomizedViewLabelText | Returns the customized view label text @return |
| SetCustomizedViewLabelText | Sets the customized view label text |
| Validate | Validate whether the inputs to the component are sufficient for commit to be called. |
Enumerations¶
| ViewDetailLabelBuilderLabelParentDisplayTypes Enumeration | Label on Parent Display type |
| ViewDetailLabelBuilderLabelParentTextPlacement Enumeration | Label on Parent Text Placement type |
Property Detail¶
CustomizedViewLabel¶
-
ViewDetailLabelBuilder.CustomizedViewLabel¶ Returns or sets the customized view label
-------------------------------------Getter Method
Signature
CustomizedViewLabel()Returns: Return type: bool New in version NX9.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
CustomizedViewLabel(customizedViewLabel)Parameters: customizedViewLabel (bool) – New in version NX9.0.0.
License requirements: drafting (“DRAFTING”)
IncludeParentheses¶
-
ViewDetailLabelBuilder.IncludeParentheses¶ Returns or sets the include parentheses
-------------------------------------Getter Method
Signature
IncludeParentheses()Returns: Return type: bool New in version NX9.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
IncludeParentheses(includeParentheses)Parameters: includeParentheses (bool) – New in version NX9.0.0.
License requirements: drafting (“DRAFTING”)
LabelCharacterHeightFactor¶
-
ViewDetailLabelBuilder.LabelCharacterHeightFactor¶ Returns or sets the section vw label letter size factor
-------------------------------------Getter Method
Signature
LabelCharacterHeightFactor()Returns: Return type: float New in version NX9.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
LabelCharacterHeightFactor(labelCharacterHeightFactor)Parameters: labelCharacterHeightFactor (float) – New in version NX9.0.0.
License requirements: drafting (“DRAFTING”)
LabelParentDisplay¶
-
ViewDetailLabelBuilder.LabelParentDisplay¶ Returns or sets the label parent display
-------------------------------------Getter Method
Signature
LabelParentDisplay()Returns: Return type: NXOpen.Drawings.ViewDetailLabelBuilderLabelParentDisplayTypesNew in version NX9.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
LabelParentDisplay(labelParentDisplay)Parameters: labelParentDisplay ( NXOpen.Drawings.ViewDetailLabelBuilderLabelParentDisplayTypes) –New in version NX9.0.0.
License requirements: drafting (“DRAFTING”)
LabelPosition¶
-
ViewDetailLabelBuilder.LabelPosition¶ Returns or sets the label position
-------------------------------------Getter Method
Signature
LabelPosition()Returns: Return type: NXOpen.Drawings.LabelPositionTypesNew in version NX9.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
LabelPosition(labelPosition)Parameters: labelPosition ( NXOpen.Drawings.LabelPositionTypes) –New in version NX9.0.0.
License requirements: drafting (“DRAFTING”)
LabelPrefix¶
-
ViewDetailLabelBuilder.LabelPrefix¶ Returns or sets the label prefix
-------------------------------------Getter Method
Signature
LabelPrefix()Returns: Return type: str New in version NX9.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
LabelPrefix(labelPrefix)Parameters: labelPrefix (str) – New in version NX9.0.0.
License requirements: drafting (“DRAFTING”)
LetterFormat¶
-
ViewDetailLabelBuilder.LetterFormat¶ Returns or sets the letter format
-------------------------------------Getter Method
Signature
LetterFormat()Returns: Return type: NXOpen.Drawings.LetterFormatTypesNew in version NX9.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
LetterFormat(letterFormat)Parameters: letterFormat ( NXOpen.Drawings.LetterFormatTypes) –New in version NX9.0.0.
License requirements: drafting (“DRAFTING”)
ParentLabelPrefix¶
-
ViewDetailLabelBuilder.ParentLabelPrefix¶ Returns or sets the parent label prefix
-------------------------------------Getter Method
Signature
ParentLabelPrefix()Returns: Return type: str New in version NX9.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
ParentLabelPrefix(parentLabelPrefix)Parameters: parentLabelPrefix (str) – New in version NX9.0.0.
License requirements: drafting (“DRAFTING”)
PrefixCharacterHeightFactor¶
-
ViewDetailLabelBuilder.PrefixCharacterHeightFactor¶ Returns or sets the prefix character height factor
-------------------------------------Getter Method
Signature
PrefixCharacterHeightFactor()Returns: Return type: float New in version NX9.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
PrefixCharacterHeightFactor(prefixCharacterHeightFactor)Parameters: prefixCharacterHeightFactor (float) – New in version NX9.0.0.
License requirements: drafting (“DRAFTING”)
ReferenceToShow¶
-
ViewDetailLabelBuilder.ReferenceToShow¶ Returns or sets the reference to show
-------------------------------------Getter Method
Signature
ReferenceToShow()Returns: Return type: NXOpen.Drawings.ReferenceShowTypesNew in version NX9.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
ReferenceToShow(referenceToShow)Parameters: referenceToShow ( NXOpen.Drawings.ReferenceShowTypes) –New in version NX9.0.0.
License requirements: drafting (“DRAFTING”)
ScaleCharacterHeightFactor¶
-
ViewDetailLabelBuilder.ScaleCharacterHeightFactor¶ Returns or sets the scale character height factor
-------------------------------------Getter Method
Signature
ScaleCharacterHeightFactor()Returns: Return type: float New in version NX9.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
ScaleCharacterHeightFactor(scaleCharacterHeightFactor)Parameters: scaleCharacterHeightFactor (float) – New in version NX9.0.0.
License requirements: drafting (“DRAFTING”)
ScalePosition¶
-
ViewDetailLabelBuilder.ScalePosition¶ Returns or sets the scale position
-------------------------------------Getter Method
Signature
ScalePosition()Returns: Return type: NXOpen.Drawings.ScalePositionTypesNew in version NX9.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
ScalePosition(scalePosition)Parameters: scalePosition ( NXOpen.Drawings.ScalePositionTypes) –New in version NX9.0.0.
License requirements: drafting (“DRAFTING”)
ScalePrefix¶
-
ViewDetailLabelBuilder.ScalePrefix¶ Returns or sets the scale prefix
-------------------------------------Getter Method
Signature
ScalePrefix()Returns: Return type: str New in version NX9.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
ScalePrefix(scalePrefix)Parameters: scalePrefix (str) – New in version NX9.0.0.
License requirements: drafting (“DRAFTING”)
ShowViewLabel¶
-
ViewDetailLabelBuilder.ShowViewLabel¶ Returns or sets the show view label
-------------------------------------Getter Method
Signature
ShowViewLabel()Returns: Return type: bool New in version NX9.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
ShowViewLabel(showViewLabel)Parameters: showViewLabel (bool) – New in version NX9.0.0.
License requirements: drafting (“DRAFTING”)
ShowViewScale¶
-
ViewDetailLabelBuilder.ShowViewScale¶ Returns or sets the show view scale
-------------------------------------Getter Method
Signature
ShowViewScale()Returns: Return type: bool New in version NX9.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
ShowViewScale(showViewScale)Parameters: showViewScale (bool) – New in version NX9.0.0.
License requirements: drafting (“DRAFTING”)
TextGapFactor¶
-
ViewDetailLabelBuilder.TextGapFactor¶ Returns or sets the text gap factor
-------------------------------------Getter Method
Signature
TextGapFactor()Returns: Return type: float New in version NX9.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
TextGapFactor(textGapFactor)Parameters: textGapFactor (float) – New in version NX9.0.0.
License requirements: drafting (“DRAFTING”)
TextPlacement¶
-
ViewDetailLabelBuilder.TextPlacement¶ Returns or sets the text placement
-------------------------------------Getter Method
Signature
TextPlacement()Returns: Return type: NXOpen.Drawings.ViewDetailLabelBuilderLabelParentTextPlacementNew in version NX9.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
TextPlacement(textPlacement)Parameters: textPlacement ( NXOpen.Drawings.ViewDetailLabelBuilderLabelParentTextPlacement) –New in version NX9.0.0.
License requirements: drafting (“DRAFTING”)
ValueFormat¶
-
ViewDetailLabelBuilder.ValueFormat¶ Returns or sets the value format
-------------------------------------Getter Method
Signature
ValueFormat()Returns: Return type: NXOpen.Drawings.ScaleValueFormatTypesNew in version NX9.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
ValueFormat(valueFormat)Parameters: valueFormat ( NXOpen.Drawings.ScaleValueFormatTypes) –New in version NX9.0.0.
License requirements: drafting (“DRAFTING”)
ViewLabelOption¶
-
ViewDetailLabelBuilder.ViewLabelOption¶ Returns or sets the view label option
-------------------------------------Getter Method
Signature
ViewLabelOption()Returns: Return type: NXOpen.Drawings.ViewLabelTypesNew in version NX9.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
ViewLabelOption(viewLabelOption)Parameters: viewLabelOption ( NXOpen.Drawings.ViewLabelTypes) –New in version NX9.0.0.
License requirements: drafting (“DRAFTING”)
Method Detail¶
GetCustomizedViewLabelText¶
-
ViewDetailLabelBuilder.GetCustomizedViewLabelText¶ Returns the customized view label text
Signature
GetCustomizedViewLabelText()Returns: Return type: list of str New in version NX10.0.0.
License requirements: drafting (“DRAFTING”)
SetCustomizedViewLabelText¶
-
ViewDetailLabelBuilder.SetCustomizedViewLabelText¶ Sets the customized view label text
Signature
SetCustomizedViewLabelText(customizedText)Parameters: customizedText (list of str) – New in version NX10.0.0.
License requirements: drafting (“DRAFTING”)
Validate¶
-
ViewDetailLabelBuilder.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.