M

MechanicalUtils.ConnectDuctPlaceholdersAtCross

Description:
Connects a trio of placeholders that can intersect in a Cross connection.

Remarks:
If connection fails, the placeholders cannot be physically connected.

Overloads (3):

ConnectDuctPlaceholdersAtCross

ConnectDuctPlaceholdersAtCross(Document,Connector,Connector,Connector,Connector)

ConnectDuctPlaceholdersAtCross(Document,ElementId,ElementId)

ConnectDuctPlaceholdersAtCross(Document,ElementId,ElementId,ElementId)

public static bool ConnectDuctPlaceholdersAtCross(
	Document document,
	ElementId placeholder1Id,
	ElementId placeholder2Id,
	ElementId placeholder3Id
)

Public Shared Function ConnectDuctPlaceholdersAtCross ( 
	document As Document,
	placeholder1Id As ElementId,
	placeholder2Id As ElementId,
	placeholder3Id As ElementId
) As Boolean

public:
static bool ConnectDuctPlaceholdersAtCross(
	Document^ document, 
	ElementId^ placeholder1Id, 
	ElementId^ placeholder2Id, 
	ElementId^ placeholder3Id
)

static member ConnectDuctPlaceholdersAtCross : 
        document : Document * 
        placeholder1Id : ElementId * 
        placeholder2Id : ElementId * 
        placeholder3Id : ElementId -> bool

Document

document

The document.
ElementId

placeholder1Id

The element id of the first duct placeholder.
ElementId

placeholder2Id

The element id of the second duct placeholder.
ElementId

placeholder3Id

The element id of third duct placeholder.

Return Value Boolean True if connection succeeds, false otherwise.

ArgumentException

The element id placeholder1Id is not duct placeholder. -or- The element id placeholder2Id is not duct placeholder. -or- The element id placeholder3Id is not duct 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