SelectObject Class — NXOpen Python API Reference 12.0.0 documentation

# SelectObject Class

class `NXOpen.BlockStyler.``SelectObject`

  Bases: `NXOpen.BlockStyler.UIBlock`

  Represents a Select Object 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.
CreateInterpartLink | Returns or sets the CreateInterpartLink
Cue | Returns or sets the Cue
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
MaximumScopeAsString | Returns or sets the MaximumScope as string
Name | Returns the name of the block or BlockID
PickPoint | Returns the PickPoint
PointOverlay | Returns or sets the PointOverlay.
SelectModeAsString | Returns or sets the SelectMode as string
Show | Returns or sets the Visibility of block.
SmartUpdateOptionAsString | Returns or sets the update option for points created by the point overlay.
SnapPointTypesEnabled | Returns or sets the SnapPointTypesEnabled
SnapPointTypesOnByDefault | Returns or sets the SnapPointTypesOnByDefault
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
--- | ---
AddFilter | Adds the filters for select object block
Focus | Focuses on the block.
GetBalloonTooltipLayoutMembers | Gets the BalloonTooltipLayout members
GetInterpartSelectionMembers | Gets the InterpartSelection members
GetLastDeselectedObjects | Gets the LastDeselectedObjects
GetLastSelectedObjects | Gets the LastSelectedObjects
GetMaximumScopeMembers | Gets the MaximumScope members
GetProperties | Returns the properties of the block
GetSelectModeMembers | Gets the SelectMode members
GetSelectedObjects | Gets the SelectedObjects
GetStepStatusMembers | Gets the StepStatus members
ResetFilter | Resets the filter for select object block
SetSelectedObjects | Sets the SelectedObjects
SetSelectionFilter | Sets the SelectionFilter

# Enumerations

SelectObjectFilterType Enumeration | Indicates the general filter type for selection.

# Property Detail

## AllowConvergentObject

`SelectObject.``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

`SelectObject.``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

`SelectObject.``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

`SelectObject.``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

`SelectObject.``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

`SelectObject.``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

`SelectObject.``BlendVirtualCurveOverlay`

  Returns or sets the BlendVirtualCurveOverlay.

  If true, virtual curve is displayed during preselection.

  `-------------------------------------`

  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.

## CreateInterpartLink

`SelectObject.``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

`SelectObject.``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.

## InterpartSelectionAsString

`SelectObject.``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

`SelectObject.``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

`SelectObject.``MaximumScopeAsString`

  Returns or sets the MaximumScope as string

  `-------------------------------------`

  Getter Method

  Signature `MaximumScopeAsString`

  Returns: |
  Return type: | str

  New in version NX8.5.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `MaximumScopeAsString`

  Parameters: | enumString (str) –

  New in version NX8.5.0.

  License requirements: None.

## PickPoint

`SelectObject.``PickPoint`

  Returns the PickPoint

  `-------------------------------------`

  Getter Method

  Signature `PickPoint`

  Returns: |
  Return type: | `NXOpen.Point3d`

  New in version NX8.5.0.

  License requirements: None.

## PointOverlay

`SelectObject.``PointOverlay`

  Returns or sets the PointOverlay.

  If true,on the fly point creation is allowed.

  `-------------------------------------`

  Getter Method

  Signature `PointOverlay`

  Returns: |
  Return type: | bool

  New in version NX8.5.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `PointOverlay`

  Parameters: | pointOverlay (bool) –

  New in version NX8.5.0.

  License requirements: None.

## SelectModeAsString

`SelectObject.``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.

## SmartUpdateOptionAsString

`SelectObject.``SmartUpdateOptionAsString`

  Returns or sets the update option for points created by the point overlay.

  Acceptable values are:

  > - **Within Modeling</b> The smart object updates within Modeling in time stamp order. For example, if the smart object is referenced by Feature(i), the smart object will update after Feature (i-1) and right before Feature(i).
  > - **After Modeling</b> The smart object updates after Modeling. Use for Drafting dimensions and other objects outside Modeling.
  > - **After Parent Body</b> The smart object will always update after the last feature on the parent body.
  > - **Mixed</b> The smart object will update after the last feature on the parent body when the parent body is in a different part; updates within Modeling in time-stamp order for parents in the same part.

  `-------------------------------------`

  Getter Method

  Signature `SmartUpdateOptionAsString`

  Returns: |
  Return type: | str

  New in version NX8.5.1.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `SmartUpdateOptionAsString`

  Parameters: | enumString (str) –

  New in version NX8.5.1.

  License requirements: None.

## SnapPointTypesEnabled

`SelectObject.``SnapPointTypesEnabled`

  Returns or sets the SnapPointTypesEnabled

  `-------------------------------------`

  Getter Method

  Signature `SnapPointTypesEnabled`

  Returns: |
  Return type: | int

  New in version NX8.5.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `SnapPointTypesEnabled`

  Parameters: | typesEnabled (int) –

  New in version NX8.5.0.

  License requirements: None.

## SnapPointTypesOnByDefault

`SelectObject.``SnapPointTypesOnByDefault`

  Returns or sets the SnapPointTypesOnByDefault

  `-------------------------------------`

  Getter Method

  Signature `SnapPointTypesOnByDefault`

  Returns: |
  Return type: | int

  New in version NX8.5.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `SnapPointTypesOnByDefault`

  Parameters: | typesByDefault (int) –

  New in version NX8.5.0.

  License requirements: None.

## StepStatusAsString

`SelectObject.``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

`SelectObject.``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

## AddFilter

`SelectObject.``AddFilter`

  Adds the filters for select object block

  This method takes the integer value of the desired enum values from `NXOpen.BlockStyler.SelectObjectFilterType`.

  Signature `AddFilter(filterTypes)`

  Parameters: | filterTypes (int) – Values from `SelectObjectFilterType` for specifying filters

  New in version NX8.5.0.

  License requirements: None.

  `-------------------------------------`

  <summary> Adds the filters for select object block </summary>

  This method takes the desired enumeration value from `NXOpen.BlockStyler.SelectObjectFilterType`.

  Signature `AddFilter(filterTypes)`

  Parameters: | filterTypes (`NXOpen.BlockStyler.SelectObjectFilterType`) – Values from `SelectObjectFilterType` for specifying filters

  New in version NX11.0.0.

  License requirements: None.

  `-------------------------------------`

  Adds the filter for select object block using type, subtype and solidBodyType

  Signature `AddFilter(type, subType, solidBodyType)`

  Parameters:

  - type (int) – Object type. This can be one of the object types that are listed in uf_object_types.h. For example, for point, use UF_point_type in C++ and NXOpen.UF.UFConstants.UF_point_type in .NET.
  - subType (int) – Object subtype. This can either be -1 (UF_all_subtype) for any subtype, or a subtype of the selected type. The subtypes are listed in uf_object_types.h.
  - solidBodyType (int) – Solid body subtype. This is only meaningful when the type is UF_solid_type. In that case, this should be set to one of the solid type constants listed in uf_ui_types.h under “Constants for selection solid_type”. When this is used, subtype does not matter. For example, to select any face, use UF_UI_SEL_FEATURE_ANY_FACE in C++ and NXOpen.UF.UFConstants.UF_UI_SEL_FEATURE_ANY_FACE in .NET

  New in version NX8.5.0.

  License requirements: None.

  `-------------------------------------`

## GetBalloonTooltipLayoutMembers

`SelectObject.``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

`SelectObject.``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.

## GetLastDeselectedObjects

`SelectObject.``GetLastDeselectedObjects`

  Gets the LastDeselectedObjects

  Signature `GetLastDeselectedObjects()`

  Returns: | Value to get from the property
  Return type: | list of `NXOpen.TaggedObject`

  New in version NX8.5.0.

  License requirements: None.

## GetLastSelectedObjects

`SelectObject.``GetLastSelectedObjects`

  Gets the LastSelectedObjects

  Signature `GetLastSelectedObjects()`

  Returns: | Value to get from the property
  Return type: | list of `NXOpen.TaggedObject`

  New in version NX8.5.0.

  License requirements: None.

## GetMaximumScopeMembers

`SelectObject.``GetMaximumScopeMembers`

  Gets the MaximumScope members

  Signature `GetMaximumScopeMembers()`

  Returns: | Value to get from the property.
  Return type: | list of str

  New in version NX8.5.0.

  License requirements: None.

## GetSelectModeMembers

`SelectObject.``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

`SelectObject.``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

`SelectObject.``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.

## ResetFilter

`SelectObject.``ResetFilter`

  Resets the filter for select object block

  Signature `ResetFilter()`

  New in version NX8.5.0.

  License requirements: None.

## SetSelectedObjects

`SelectObject.``SetSelectedObjects`

  Sets the SelectedObjects

  Signature `SetSelectedObjects(objectVector)`

  Parameters: | objectVector (list of `NXOpen.TaggedObject`) – Value to set for the property

  New in version NX8.5.0.

  License requirements: None.

## SetSelectionFilter

`SelectObject.``SetSelectionFilter`

  Sets the SelectionFilter

  Signature `SetSelectionFilter(maskAction, maskTriples)`

  Parameters:

  - maskAction (`NXOpen.SelectionSelectionAction`) – Mask action
  - maskTriples (list of `NXOpen.SelectionMaskTriple_Struct`) – Mask triples

  New in version NX8.5.0.

  License requirements: None.