SpecifyLocation Class — NXOpen Python API Reference 12.0.0 documentation

# SpecifyLocation Class

class `NXOpen.BlockStyler.``SpecifyLocation`

  Bases: `NXOpen.BlockStyler.UIBlock`

  Represents a Specify Location block

  New in version NX8.5.0.

# Properties

Property | Description
--- | ---
AutomaticProgression | Returns or sets the AutomaticProgression
CursorLocation | Returns or sets the CursorLocation
DisplayTemporaryPoint | Returns or sets the DisplayTemporaryPoint
Enable | Returns or sets the Enable.
Expanded | Returns or sets the Expanded
Group | Returns or sets the Group
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.
StepStatusAsString | Returns or sets the StepStatus as string
Tag | Returns the Tag for this object.
Type | Returns the type of block

# Methods

Method | Description
--- | ---
Focus | Focuses on the block.
GetProperties | Returns the properties of the block
GetStepStatusMembers | Gets the StepStatus members

# Property Detail

## AutomaticProgression

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

## CursorLocation

`SpecifyLocation.``CursorLocation`

  Returns or sets the CursorLocation

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

  Getter Method

  Signature `CursorLocation`

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

  New in version NX8.5.0.

  License requirements: None.

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

  Setter Method

  Signature `CursorLocation`

  Parameters: | cursorLocation (`NXOpen.Point3d`) –

  New in version NX8.5.0.

  License requirements: None.

## DisplayTemporaryPoint

`SpecifyLocation.``DisplayTemporaryPoint`

  Returns or sets the DisplayTemporaryPoint

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

  Getter Method

  Signature `DisplayTemporaryPoint`

  Returns: |
  Return type: | bool

  New in version NX8.5.0.

  License requirements: None.

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

  Setter Method

  Signature `DisplayTemporaryPoint`

  Parameters: | display (bool) –

  New in version NX8.5.0.

  License requirements: None.

## LabelString

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

## StepStatusAsString

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

# Method Detail

## GetStepStatusMembers

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