Makes a connection between the specified connectors and adds coupling if necessary.

Namespace: Autodesk.Revit.DB
Assembly: RevitAPI (in RevitAPI.dll) Version: 24.0.0.0 (24.0.0.0)
Since:  2016

Syntax

C#
public static bool ConnectAndCouple(
	Document document,
	Connector connector,
	Connector toConnector
)
Visual Basic
Public Shared Function ConnectAndCouple ( _
	document As Document, _
	connector As Connector, _
	toConnector As Connector _
) As Boolean
Visual C++
public:
static bool ConnectAndCouple(
	Document^ document, 
	Connector^ connector, 
	Connector^ toConnector
)

Parameters

document
Type: Autodesk.Revit.DB..::..Document
The document.
connector
Type: Autodesk.Revit.DB..::..Connector
The connector of the fabrication part.
toConnector
Type: Autodesk.Revit.DB..::..Connector
The connector of the fabrication part or family to connect to.

Return Value

True if connection succeeded, false otherwise.

Remarks

This function does not place and align the fabrication part. Call AlignPartByConnectors before connecting.

Exceptions

ExceptionCondition
Autodesk.Revit.Exceptions..::..ArgumentException The connector does not belong to a fabrication part. -or- The fabrication part connectors are not aligned, call AlignPartByConnectors to align them.
Autodesk.Revit.Exceptions..::..ArgumentNullException A non-optional argument was null

See Also