PipeBuilder Class

Properties

Property Description
ElementId Returns or sets the current element ID of this pipe.
Id Returns the id of the pipe.
OwningRun Returns or sets the owning run of the pipe.
OwningSheet Returns or sets the owning sheet of this pipe.
ReverseEnd Returns the reversed flag of this connection.
StockPathId Returns or sets the stock path ID of the pipe.
Tag Returns the Tag for this object.

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.
GetBendPoints Get bending points for polyline to render the connection.
GetCommittedObjects For builders that create more than one object, this method returns the objects that are created by commit.
GetConnection Get the connection object of the connection builder.
GetEnd Gets the end port of this pipe.
GetEndLocation Get the end location of this connection.
GetEndTee Gets the end Tee.
GetEndTeeLocation Get the connection location for tee object at the end of the connection.
GetNewEndTeeConnection Gets new connection after inserting the end Tee.
GetNewStartTeeConnection Gets new connection after inserting the start Tee.
GetObject Returns the object currently being edited by this builder.
GetStart Gets the start port of this connection.
GetStartLocation Get the start location of this connection.
GetStartTee Gets the start Tee.
GetStartTeeLocation Get the connection location for tee object at the start of the connection.
SetBendPoints Set bending points for polyline to render the connection.
SetEnd Sets the end port of this pipe.
SetEndLocation Set the end location of this connection.
SetEndTeeLocation Set the connection location for tee object at the end of the connection.
SetStart Sets the start port of this connection.
SetStartLocation Set the start location of this connection.
SetStartTeeLocation Set the connection location for tee object at the start of the connection.
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.

Property Detail

ElementId

Id

OwningRun

OwningSheet

ReverseEnd

StockPathId

Method Detail

GetBendPoints

GetConnection

GetEnd

GetEndLocation

GetEndTee

GetEndTeeLocation

GetNewEndTeeConnection

GetNewStartTeeConnection

GetStart

GetStartLocation

GetStartTee

GetStartTeeLocation

SetBendPoints

SetEnd

SetEndLocation

SetEndTeeLocation

SetStart

SetStartLocation

SetStartTeeLocation

Validate