BodyCollector Class¶
-
class
NXOpen.BlockStyler.
BodyCollector
¶ Bases:
NXOpen.BlockStyler.UIBlock
Represents a Body Collector block
New in version NX8.5.0.
Properties¶
Property | Description |
---|---|
AllowConvergentObject | Returns or sets the AllowConvergentObject |
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 |
Bitmap | Returns or sets the Bitmap |
BlendVirtualCurveOverlay | Returns or sets the BlendVirtualCurveOverlay |
BodyRules | Returns or sets the BodyRules |
CreateInterpartLink | Returns or sets the CreateInterpartLink |
Cue | Returns or sets the Cue |
DefaultBodyRulesAsString | Returns or sets the DefaultBodyRules as string |
Enable | Returns or sets the Enable. |
EntityType | Returns or sets the EntityType |
Expanded | Returns or sets the Expanded |
Group | Returns or sets the Group |
IncludeSheetBodies | Returns or sets the IncludeSheetBodies |
InterpartSelectionAsString | Returns or sets the InterpartSelection as string |
Label | Returns or sets the Label |
LabelString | Returns or sets the LabelString |
MaximumScopeAsString | Returns or sets the MaximumScope |
Name | Returns the name of the block or BlockID |
PopupMenuEnabled | Returns or sets the PopupMenuEnabled. |
SelectModeAsString | Returns or sets the SelectMode as string |
Show | Returns or sets the Visibility of block. |
StepStatusAsString | Returns or sets the StepStatus as string |
Tag | Returns the Tag for this object. |
ToolTip | Returns or sets the ToolTip |
Type | Returns the type of block |
Methods¶
Method | Description |
---|---|
Focus | Focuses on the block. |
GetBalloonTooltipLayoutMembers | Gets the BalloonTooltipLayout member |
GetDefaultBodyRulesMembers | Gets the DefaultBodyRules members |
GetInterpartSelectionMembers | Gets the InterpartSelection members |
GetProperties | Returns the properties of the block |
GetSelectModeMembers | Gets the SelectMode members |
GetSelectedObjects | Gets the SelectedObjects |
GetStepStatusMembers | Gets the StepStatus members |
SetSelectedObjects | Sets the SelectedObjects |
Property Detail¶
AllowConvergentObject¶
-
BodyCollector.
AllowConvergentObject
¶ Returns or sets the AllowConvergentObject
-------------------------------------
Getter Method
Signature
AllowConvergentObject
Returns: Return type: bool New in version NX11.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
AllowConvergentObject
Parameters: allowConvergentObject (bool) – New in version NX11.0.0.
License requirements: None.
AutomaticProgression¶
-
BodyCollector.
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
Parameters: automaticProgression (bool) – New in version NX8.5.0.
License requirements: None.
BalloonTooltipImage¶
-
BodyCollector.
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
Parameters: imageString (str) – New in version NX8.5.0.
License requirements: None.
BalloonTooltipLayoutAsString¶
-
BodyCollector.
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
Parameters: enumString (str) – New in version NX8.5.0.
License requirements: None.
BalloonTooltipText¶
-
BodyCollector.
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
Parameters: balloonTooltipText (str) – New in version NX8.5.0.
License requirements: None.
Bitmap¶
-
BodyCollector.
Bitmap
¶ Returns or sets the Bitmap
-------------------------------------
Getter Method
Signature
Bitmap
Returns: Return type: str New in version NX8.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
Bitmap
Parameters: bitmapString (str) – New in version NX8.5.0.
License requirements: None.
BlendVirtualCurveOverlay¶
-
BodyCollector.
BlendVirtualCurveOverlay
¶ Returns or sets the BlendVirtualCurveOverlay
-------------------------------------
Getter Method
Signature
BlendVirtualCurveOverlay
Returns: Return type: bool New in version NX8.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
BlendVirtualCurveOverlay
Parameters: blendCurve (bool) – New in version NX8.5.0.
License requirements: None.
BodyRules¶
-
BodyCollector.
BodyRules
¶ Returns or sets the BodyRules
-------------------------------------
Getter Method
Signature
BodyRules
Returns: Return type: int New in version NX8.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
BodyRules
Parameters: bodyRules (int) – New in version NX8.5.0.
License requirements: None.
CreateInterpartLink¶
-
BodyCollector.
CreateInterpartLink
¶ Returns or sets the CreateInterpartLink
-------------------------------------
Getter Method
Signature
CreateInterpartLink
Returns: Return type: bool New in version NX8.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
CreateInterpartLink
Parameters: createLink (bool) – New in version NX8.5.0.
License requirements: None.
Cue¶
-
BodyCollector.
Cue
¶ Returns or sets the Cue
-------------------------------------
Getter Method
Signature
Cue
Returns: Return type: str New in version NX8.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
Cue
Parameters: cue (str) – New in version NX8.5.0.
License requirements: None.
DefaultBodyRulesAsString¶
-
BodyCollector.
DefaultBodyRulesAsString
¶ Returns or sets the DefaultBodyRules as string
-------------------------------------
Getter Method
Signature
DefaultBodyRulesAsString
Returns: Return type: str New in version NX8.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
DefaultBodyRulesAsString
Parameters: enumString (str) – New in version NX8.5.0.
License requirements: None.
EntityType¶
-
BodyCollector.
EntityType
¶ Returns or sets the EntityType
-------------------------------------
Getter Method
Signature
EntityType
Returns: Return type: int New in version NX8.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
EntityType
Parameters: entityType (int) – New in version NX8.5.0.
License requirements: None.
IncludeSheetBodies¶
-
BodyCollector.
IncludeSheetBodies
¶ Returns or sets the IncludeSheetBodies
-------------------------------------
Getter Method
Signature
IncludeSheetBodies
Returns: Return type: bool New in version NX9.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
IncludeSheetBodies
Parameters: includeSheetBodies (bool) – New in version NX9.0.0.
License requirements: None.
InterpartSelectionAsString¶
-
BodyCollector.
InterpartSelectionAsString
¶ Returns or sets the InterpartSelection as string
-------------------------------------
Getter Method
Signature
InterpartSelectionAsString
Returns: Return type: str New in version NX8.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
InterpartSelectionAsString
Parameters: enumString (str) – New in version NX8.5.0.
License requirements: None.
LabelString¶
-
BodyCollector.
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
Parameters: labelString (str) – New in version NX8.5.0.
License requirements: None.
MaximumScopeAsString¶
-
BodyCollector.
MaximumScopeAsString
¶ Returns or sets the MaximumScope
-------------------------------------
Getter Method
Signature
MaximumScopeAsString
Returns: Return type: str New in version NX11.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
MaximumScopeAsString
Parameters: enumString (str) – New in version NX11.0.0.
License requirements: None.
SelectModeAsString¶
-
BodyCollector.
SelectModeAsString
¶ Returns or sets the SelectMode as string
-------------------------------------
Getter Method
Signature
SelectModeAsString
Returns: Return type: str New in version NX8.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
SelectModeAsString
Parameters: enumString (str) – New in version NX8.5.0.
License requirements: None.
StepStatusAsString¶
-
BodyCollector.
StepStatusAsString
¶ Returns or sets the StepStatus as string
-------------------------------------
Getter Method
Signature
StepStatusAsString
Returns: Return type: str New in version NX8.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
StepStatusAsString
Parameters: enumString (str) – New in version NX8.5.0.
License requirements: None.
ToolTip¶
-
BodyCollector.
ToolTip
¶ Returns or sets the ToolTip
-------------------------------------
Getter Method
Signature
ToolTip
Returns: Return type: str New in version NX8.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ToolTip
Parameters: toolTip (str) – New in version NX8.5.0.
License requirements: None.
Method Detail¶
GetBalloonTooltipLayoutMembers¶
-
BodyCollector.
GetBalloonTooltipLayoutMembers
¶ Gets the BalloonTooltipLayout member
Signature
GetBalloonTooltipLayoutMembers()
Returns: Value to get from the property. Return type: list of str New in version NX8.5.0.
License requirements: None.
GetDefaultBodyRulesMembers¶
-
BodyCollector.
GetDefaultBodyRulesMembers
¶ Gets the DefaultBodyRules members
Signature
GetDefaultBodyRulesMembers()
Returns: Value to get from the property Return type: list of str New in version NX8.5.0.
License requirements: None.
GetInterpartSelectionMembers¶
-
BodyCollector.
GetInterpartSelectionMembers
¶ Gets the InterpartSelection members
Signature
GetInterpartSelectionMembers()
Returns: Value to get from the property Return type: list of str New in version NX8.5.0.
License requirements: None.
GetSelectModeMembers¶
-
BodyCollector.
GetSelectModeMembers
¶ Gets the SelectMode members
Signature
GetSelectModeMembers()
Returns: Value to get from the property Return type: list of str New in version NX8.5.0.
License requirements: None.
GetSelectedObjects¶
-
BodyCollector.
GetSelectedObjects
¶ Gets the SelectedObjects
Signature
GetSelectedObjects()
Returns: Value to get from the property Return type: list of NXOpen.TaggedObject
New in version NX8.5.0.
License requirements: None.
GetStepStatusMembers¶
-
BodyCollector.
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¶
-
BodyCollector.
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.