SpecifyPlane Class¶
-
class
NXOpen.BlockStyler.SpecifyPlane¶ Bases:
NXOpen.BlockStyler.UIBlockRepresents a Specify Plane block
New in version NX8.5.0.
Properties¶
| Property | Description |
|---|---|
| AutomaticProgression | Returns or sets the AutomaticProgression |
| BalloonTooltipImage | Returns or sets the BalloonTooltipImage |
| BalloonTooltipLayoutAsString | Returns or sets the BalloonTooltipLayout as string |
| BalloonTooltipText | Returns or sets the BalloonTooltipText |
| CreateInterpartLink | Returns or sets the CreateInterpartLink |
| CurrentStepStatusAsString | Returns the string specifying current StepStatus |
| Enable | Returns or sets the Enable. |
| Expanded | Returns or sets the Expanded |
| Group | Returns or sets the Group |
| InterpartSelectionAsString | Returns or sets the InterpartSelection as string |
| Label | Returns or sets the Label |
| LabelString | Returns or sets the LabelString |
| Name | Returns the name of the block or BlockID |
| Show | Returns or sets the Visibility of block. |
| ShowShortcuts | Returns or sets the ShowShortcuts |
| StepStatusAsString | Returns or sets the string specifying the default StepStatus |
| Tag | Returns the Tag for this object. |
| Type | Returns the type of block |
Methods¶
| Method | Description |
|---|---|
| Focus | Focuses on the block. |
| GetBalloonTooltipLayoutMembers | Gets the BalloonTooltipLayout members @return Value to get from the property. |
| GetInterpartSelectionMembers | Gets the InterpartSelection members @return Value to get from the property |
| GetProperties | Returns the properties of the block @return |
| GetSelectedObjects | Gets the SelectedObjects @return Value to get from the property |
| GetStepStatusMembers | Gets the StepStatus members @return Value to get from the property |
| SetSelectedObjects | Sets the SelectedObjects |
Property Detail¶
AutomaticProgression¶
-
SpecifyPlane.AutomaticProgression¶ Returns or sets the AutomaticProgression
-------------------------------------Getter Method
Signature
AutomaticProgression()Returns: Return type: bool New in version NX8.5.0.
License requirements: None.
-------------------------------------Setter Method
Signature
AutomaticProgression(automaticProgression)Parameters: automaticProgression (bool) – New in version NX8.5.0.
License requirements: None.
BalloonTooltipImage¶
-
SpecifyPlane.BalloonTooltipImage¶ Returns or sets the BalloonTooltipImage
-------------------------------------Getter Method
Signature
BalloonTooltipImage()Returns: Return type: str New in version NX8.5.0.
License requirements: None.
-------------------------------------Setter Method
Signature
BalloonTooltipImage(imageString)Parameters: imageString (str) – New in version NX8.5.0.
License requirements: None.
BalloonTooltipLayoutAsString¶
-
SpecifyPlane.BalloonTooltipLayoutAsString¶ Returns or sets the BalloonTooltipLayout as string
-------------------------------------Getter Method
Signature
BalloonTooltipLayoutAsString()Returns: Return type: str New in version NX8.5.0.
License requirements: None.
-------------------------------------Setter Method
Signature
BalloonTooltipLayoutAsString(enumString)Parameters: enumString (str) – New in version NX8.5.0.
License requirements: None.
BalloonTooltipText¶
-
SpecifyPlane.BalloonTooltipText¶ Returns or sets the BalloonTooltipText
-------------------------------------Getter Method
Signature
BalloonTooltipText()Returns: Return type: str New in version NX8.5.0.
License requirements: None.
-------------------------------------Setter Method
Signature
BalloonTooltipText(balloonTooltipText)Parameters: balloonTooltipText (str) – New in version NX8.5.0.
License requirements: None.
CreateInterpartLink¶
-
SpecifyPlane.CreateInterpartLink¶ Returns or sets the CreateInterpartLink
-------------------------------------Getter Method
Signature
CreateInterpartLink()Returns: Return type: bool New in version NX11.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
CreateInterpartLink(createLink)Parameters: createLink (bool) – New in version NX11.0.0.
License requirements: None.
CurrentStepStatusAsString¶
-
SpecifyPlane.CurrentStepStatusAsString¶ Returns the string specifying current StepStatus
-------------------------------------Getter Method
Signature
CurrentStepStatusAsString()Returns: Return type: str New in version NX8.5.0.
License requirements: None.
InterpartSelectionAsString¶
-
SpecifyPlane.InterpartSelectionAsString¶ Returns or sets the InterpartSelection as string
-------------------------------------Getter Method
Signature
InterpartSelectionAsString()Returns: Return type: str New in version NX11.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
InterpartSelectionAsString(enumString)Parameters: enumString (str) – New in version NX11.0.0.
License requirements: None.
LabelString¶
-
SpecifyPlane.LabelString¶ Returns or sets the LabelString
-------------------------------------Getter Method
Signature
LabelString()Returns: Return type: str New in version NX8.5.0.
License requirements: None.
-------------------------------------Setter Method
Signature
LabelString(labelString)Parameters: labelString (str) – New in version NX8.5.0.
License requirements: None.
ShowShortcuts¶
-
SpecifyPlane.ShowShortcuts¶ Returns or sets the ShowShortcuts
-------------------------------------Getter Method
Signature
ShowShortcuts()Returns: Return type: bool New in version NX8.5.0.
License requirements: None.
-------------------------------------Setter Method
Signature
ShowShortcuts(show)Parameters: show (bool) – New in version NX8.5.0.
License requirements: None.
StepStatusAsString¶
-
SpecifyPlane.StepStatusAsString¶ Returns or sets the string specifying the default StepStatus
-------------------------------------Getter Method
Signature
StepStatusAsString()Returns: Return type: str New in version NX8.5.0.
License requirements: None.
-------------------------------------Setter Method
Signature
StepStatusAsString(enumString)Parameters: enumString (str) – New in version NX8.5.0.
License requirements: None.
Method Detail¶
GetBalloonTooltipLayoutMembers¶
-
SpecifyPlane.GetBalloonTooltipLayoutMembers¶ Gets the BalloonTooltipLayout members
Signature
GetBalloonTooltipLayoutMembers()Returns: Value to get from the property. Return type: list of str New in version NX8.5.0.
License requirements: None.
GetInterpartSelectionMembers¶
-
SpecifyPlane.GetInterpartSelectionMembers¶ Gets the InterpartSelection members
Signature
GetInterpartSelectionMembers()Returns: Value to get from the property Return type: list of str New in version NX11.0.0.
License requirements: None.
GetSelectedObjects¶
-
SpecifyPlane.GetSelectedObjects¶ Gets the SelectedObjects
Signature
GetSelectedObjects()Returns: Value to get from the property Return type: list of NXOpen.TaggedObjectNew in version NX8.5.0.
License requirements: None.
GetStepStatusMembers¶
-
SpecifyPlane.GetStepStatusMembers¶ Gets the StepStatus members
Signature
GetStepStatusMembers()Returns: Value to get from the property Return type: list of str New in version NX8.5.0.
License requirements: None.
SetSelectedObjects¶
-
SpecifyPlane.SetSelectedObjects¶ Sets the SelectedObjects
Signature
SetSelectedObjects(objectVector)Parameters: objectVector (list of NXOpen.TaggedObject) – Value to set for the propertyNew in version NX8.5.0.
License requirements: None.