PlumbingUtils.ConnectPipePlaceholdersAtCross(Document, ElementId, ElementId, ElementId)
Method
Description:
Connects placeholders that looks like Cross connection.
Connects placeholders that looks like Cross connection.
Remarks:
If connection fails, the placeholders cannot be physically connected.
If connection fails, the placeholders cannot be physically connected.
Syntax
Parameters
Parameter | Type | Description |
---|---|---|
document | Document | The document. |
placeholder1Id | ElementId | The first element Id of pipe placeholder. |
placeholder2Id | ElementId | The second element Id of pipe placeholder that intersects with first one. |
placeholder3Id | ElementId | The third element Id of pipe placeholder that intersects with first one. |
Return Value
Type | Description |
---|---|
Boolean | True if connection succeeds, false otherwise. |
Exceptions
Exception | Condition |
---|---|
ArgumentException | The element id placeholder1Id is not pipe placeholder. -or- The element id placeholder2Id is not pipe placeholder. -or- The element id placeholder3Id is not pipe placeholder. -or- The elements belong to different types of system. -or- The curve placeholder2Id does not connect on the curve placeholder1Id or vice versa. -or- The curve placeholder3Id does not connect on the curve placeholder1Id or vice versa. -or- The curve placeholder2Id and placeholder3Id are not collinear. |
ArgumentNullException | A non-optional argument was null |