ConnectableElementBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# ConnectableElementBuilder Class

class `NXOpen.Diagramming.``ConnectableElementBuilder`

  Bases: `NXOpen.Diagramming.SheetElementBuilder`

  Represents a ConnectableElementBuilder.

  This is an abstract class and cannot be directly instantiated

  New in version NX10.0.0.

# Properties

Property | Description
--- | ---
Height | Returns or sets the height.
HeightPolicy | Returns or sets the height policy.
Internal | Returns the flag that indicates if the sheet element is internal.
Label | Returns the label of this sheet element.
LabelName | Returns or sets the label name of this sheet element.
Location | Returns the location of the sheet element relative to another sheet element.
LocationStyle | Returns or sets the location style.
MirrorX | Returns or sets the sheet element to Mirror along the X axis.
MirrorY | Returns or sets the sheet element to Mirror along the Y axis.
Owner | Returns or sets the owning sheet element.
OwningSheet | Returns the owning sheet.
ResizeOption | Returns or sets the resize option of the sheet element
Rotation | Returns or sets the rotation angle that is counter clockwise and relative to the owner.
SourceElement | Returns the source element that records which sheet element it is a copy of.
Tag | Returns the Tag for this object.
UpToDate | Returns the flag that indicates if the sheet element is up to date.
Visible | Returns the flag that indicates if the sheet element is visible.
Width | Returns or sets the width.
WidthPolicy | Returns or sets the width policy.
NXOpen.Diagramming.SheetElementBuilder.X | Returns or sets the absolute x coordinate.
NXOpen.Diagramming.SheetElementBuilder.Y | Returns or sets the absolute y coordinate.
ZDepth | Returns or sets the Z depth.

# Methods

Method | Description
--- | ---
Commit | Commits any edits that have been applied to the builder.
Destroy | Deletes the builder, and cleans up any objects created by the builder.
GetAllPorts | Gets all ports of this connectable element.
GetAllowedTransformations | Get the allowed transformations of the sheet element.
GetCommittedObjects | For builders that create more than one object, this method returns the objects that are created by commit.
GetMinNodeSize | Gets the minimum node size values
GetObject | Returns the object currently being edited by this builder.
GetPorts | Gets ports of this connectable element by the direction.
SetMinNodeSize | Sets the minimum node size values
SetOwningSheet | Set the owning sheet when the sheet element is created.
ShowResults | Updates the model to reflect the result of an edit to the model for all builders that support showing results.
Validate | Validate whether the inputs to the component are sufficient for commit to be called.

# Method Detail

## GetAllPorts

`ConnectableElementBuilder.``GetAllPorts`

  Gets all ports of this connectable element.

  Signature `GetAllPorts()`

  Returns: |
  Return type: | list of `NXOpen.Diagramming.Port`

  New in version NX10.0.0.

  License requirements: None.

## GetPorts

`ConnectableElementBuilder.``GetPorts`

  Gets ports of this connectable element by the direction.

  Signature `GetPorts(direction)`

  Parameters: | direction (`NXOpen.Diagramming.Direction`) –
  Returns: |
  Return type: | list of `NXOpen.Diagramming.Port`

  New in version NX10.0.0.

  License requirements: None.

## Validate

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